Skip to main content

List Batch Payments

GET 
/payment-batches

Retrieve batch payments that you have created.

Request​

Query Parameters

    after string

    An object ID that is used as a cursor in pagination. For instance, if you make a list request and receive 100 objects, ending with obj_foo42, your subsequent call can include after=obj_foo42 in order to fetch the next page of the list.

    limit integer

    Possible values: >= 1 and <= 100

    Default value: 10

    A limit on the number of objects to be returned, between 1 and 100.

    order string

    Possible values: [ASC, DESC]

    Default value: DESC

    Sort list objects in either ascending or descending order.

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

    data

    object[]

    required

  • Array [

    • 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.

    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.

  • ]

    • hasMore booleanrequired
Loading...