Interface

DigitalPayChargePaymentAgreementRequest

DigitalPayChargePaymentAgreementRequest

The JSON request structure of the Charge Payment Agreement endpoint.

View Source model/DigiPayModel/DigitalPayChargePaymentAgreementRequest.d.ts, line 5

Members

number

# amount

The amount that will be charged against the payment instrument linked to the payment agreement.

View Source model/DigiPayModel/DigitalPayChargePaymentAgreementRequest.d.ts, line 41

string

# clientReference

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

View Source model/DigiPayModel/DigitalPayChargePaymentAgreementRequest.d.ts, line 15

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/DigitalPayChargePaymentAgreementRequest.d.ts, line 22

string

# orderNumber

The merchant order number of the transaction.

View Source model/DigiPayModel/DigitalPayChargePaymentAgreementRequest.d.ts, line 30

string

# paymentToken

The payment token of the payment agreement. The payment token is a unique identifier for the payment agreement.

View Source model/DigiPayModel/DigitalPayChargePaymentAgreementRequest.d.ts, line 34

PaymentTransactionType

# transactionType

Transaction type containers to use for all instruments.

View Source model/DigiPayModel/DigitalPayChargePaymentAgreementRequest.d.ts, line 11