Batch Payment Request

Container for batch payment entries. Root element containing a collection of BatchPaymentEntry.

batchPaymentEntries object[]required

Collection of BatchPayment entry.

Array [

customerReferencestringrequired

Customer reference in individual payment batch entry.

merchantUniquePaymentIdstring

Unique payment id provided by the merchant. Can be used when Proxy payment is performed. (Optional).

Max length: <= 50 characters

paymentAccountProxystring

Pass an alternative Proxy if required (Optional). If no Proxy is passed, the nominated card / bank account is used.

Max length: <= 40 characters

paymentAmountnumber<double>required

Payment amount in individual payment batch entry.

Range: >= 0.01 and <= 1.7976931348623157e+308

]

merchantUniqueBatchIdstring

Unique batch id provided by the merchant.

Max length: <= 50 characters

Batch Payment Request

{
  "batchPaymentEntries": [
    {
      "customerReference": "string",
      "merchantUniquePaymentId": "string",
      "paymentAccountProxy": "string",
      "paymentAmount": 0
    }
  ],
  "merchantUniqueBatchId": "string"
}