API Documentation

Interface

ChargePaymentAgreementRequest

ChargePaymentAgreementRequest

Data required to charge against a PaymentAgreement

View Source model/ChargePaymentAgreement.d.ts, line 4

Members

number

# amount

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

View Source model/ChargePaymentAgreement.d.ts, line 17

string

# clientReference

A merchant application specific reference number for the transaction.

View Source model/ChargePaymentAgreement.d.ts, line 21

string

# customerRef Optional

A merchant application specific reference number for the customer.

View Source model/ChargePaymentAgreement.d.ts, line 33

string

# orderNumber

A merchant order number for the transaction.

View Source model/ChargePaymentAgreement.d.ts, line 25

string

# paymentToken

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

View Source model/ChargePaymentAgreement.d.ts, line 10

TransactionType

# transactionType

Transaction type containers to use for all instruments.

View Source model/ChargePaymentAgreement.d.ts, line 29