Interface

DigitalPayCreatePaymentAgreementRequest

DigitalPayCreatePaymentAgreementRequest

The JSON request structure of the Create Payment Agreement endpoint.

View Source model/DigiPayModel/DigitalPayCreatePaymentAgreementRequest.d.ts, line 6

Members

DigitalPayAddress

# billingAddress

Customer billing address for this payment agreement

View Source model/DigiPayModel/DigitalPayCreatePaymentAgreementRequest.d.ts, line 35

string

# clientReference

A merchant application specific reference number. This number should uniquely identify the transaction in the merchant’s system.

View Source model/DigiPayModel/DigitalPayCreatePaymentAgreementRequest.d.ts, line 12

string

# customerRef Optional

A merchant application specific reference number. This number should uniquely identify the customer in the merchant’s system.

View Source model/DigiPayModel/DigitalPayCreatePaymentAgreementRequest.d.ts, line 19

string

# orderNumber Optional

The merchant order number of the transaction. This property is only required if the 'immediateCharge' property is true.

View Source model/DigiPayModel/DigitalPayCreatePaymentAgreementRequest.d.ts, line 27

DigitalPayRequestPaymentAgreement

# paymentAgreement

Detail of the payment agreement to be created

View Source model/DigiPayModel/DigitalPayCreatePaymentAgreementRequest.d.ts, line 39