Skip to main content

Create a Batch Payment

POST 
/payment-batches

Create a batch payment.

This is an asynchronous operation. Listen to the payments.succeeded or payments.failed webhook to be notified of the final outcome of each payment.

Request​

Header Parameters

    Idempotency-Key string

    A unique value, eg. a UUID.

Body

    type stringrequired

    Possible values: [ACT, FAST, PAYNOW, TT, MEPS]

    Type of payment

    paymentDate stringrequired

    The date payment should be sent.

    senderAccountId stringrequired

    The Acme-specific internal id of the source bank account.

    senderAccountCurrency string

    Currency to use in the sender account, if it has multiple currencies. Optional if sender account only has one currency configured.

    currency stringrequired

    Three-letter ISO 4217 currency code in full uppercase. Must be a currency supported by the payment type.

    For example, FAST only supports SGD.

    payments

    object[]

    required

    Payments to create in this batch. Maximum 1000 items.

  • Array [

    • amount integerrequired

    A positive integer value in specified currency's smallest unit. e.g. for SGD, $10 would be represented as 1000 (cents).

    customerReference string

    A meaningful description of the payment. This will show up in the receiver's bank statement. Characters used should be restricted to the SWIFT Character Set: uppercase and lowercase letters A-Z, 0-9 numerals, space, and these symbols: /-?:().,'+.

    paymentDetails string

    Extended description of the payment.

    bankChargeBearer string

    Possible values: [SENDER, RECEIVER, SHARED]

    For TT/MEPS - who pays for bank charges

    receiver

    object

    required

    oneOf

    name stringrequired

    Receiver's name

    bank stringrequired

    Receiver's bank 11-character SWIFT/BIC code

    bankAccountNumber stringrequired

    Receiver's bank account number

    address

    object

    Receiver's address, if required

    line1 string
    line2 string
    city string
    state string
    postalCode string
    country string

  • ]

Responses​

OK

Response Headers

  • Acme-Mode

    string

    Has the value LIVE if the data exists in live production mode or the value TEST if the data exists in test sandbox mode.

Schema

    id string

    Unique identifier for the object.

    type string

    Possible values: [ACT, FAST, PAYNOW, TT, MEPS]

    Type of payment

    paymentDate string

    The date payment should be sent.

    senderAccountId string

    The Acme-specific internal id of the source bank account.

    currency string

    Three-letter ISO 4217 currency code in full uppercase. Must be a currency supported by the payment type.

    For example, FAST only supports SGD.

    payments

    object[]

  • Array [

    • id string

    Unique identifier for the object.

    amount integer

    A positive integer value in specified currency's smallest unit. e.g. for SGD, $10 would be represented as 1000 (cents).

    customerReference string

    A meaningful description of the payment. This will show up in the receiver's bank statement. Characters used should be restricted to the SWIFT Character Set: uppercase and lowercase letters A-Z, 0-9 numerals, space, and these symbols: /-?:().,'+.

    paymentDetails string

    Extended description of the payment.

    bankChargeBearer string

    Possible values: [SENDER, RECEIVER, SHARED]

    For TT/MEPS - who pays for bank charges

    status string

    Possible values: [PROCESSING, FAILED, SUBMITTED, COMPLETED]

    Status of the payment

    receiver

    object

    name string

    Receiver's name

    bank string

    Receiver's bank SWIFT/BIC code

    bankAccountNumber string

    Receiver's bank account number

    proxyType string

    Possible values: [MOBILE, UEN, VPA]

    The proxy type if type is PAYNOW

    proxyValue string

    The proxy value if type is PAYNOW

    address

    object

    Receiver's address

    line1 string
    line2 string
    city string
    state string
    postalCode string
    country string
    createdAt string

    Time at which the object was created. In ISO 8601 format.

    updatedAt string

    Time at which the object was last updated. In ISO 8601 format.

  • ]

    • status string

    Possible values: [OPEN, PROCESSING, SUBMITTED, FAILED, COMPLETED]

    Status of the batch

    createdAt string

    Time at which the object was created. In ISO 8601 format.

    updatedAt string

    Time at which the object was last updated. In ISO 8601 format.

Loading...