Skip to main content

Request Pay Batch Request

Container for request-to-pay entries. Root element containing a collection of RequestPayEntry.

merchantUniqueRequestBatchIdstring

Unique batch id provided by the merchant.

Max length: <= 50 characters

requestPaymentEntries object[]required

Collection of RequestPayment entry.

  • Array [
  • customerReferencestringrequired

    Customer reference in individual payment request entry.

    emailstring

    Customer email in individual payment request entry. Use comma or semicolon to provide more than one email address for a customer.

    firstNamestringrequired

    First name of the customer.

    lastNamestring

    Last name of the customer.

    merchantUniquePaymentIdstring

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

    Max length: <= 50 characters

    mobilestring

    Customer mobile in individual payment request entry.

    Format: Value must match regular expression ^(04[0-9]{8}|02[0-9]{7,8})$

    paymentAmountnumber<double>required

    Payment amount in individual payment request entry.

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

  • ]
  • Request Pay Batch Request
    {
    "merchantUniqueRequestBatchId": "string",
    "requestPaymentEntries": [
    {
    "customerReference": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "merchantUniquePaymentId": "string",
    "mobile": "string",
    "paymentAmount": 0
    }
    ]
    }