Sign in
Settlement

List batches

Use this method to return a paginated list of batches that your merchants submitted to the processor on a specific date.

Note: If you want to view the details of a specific batch and you have its batchId, use our Retrieve Batch method.

Use query parameters to filter the list of results that we return, for example, to search for batches that were submitted by a specific merchant.

Important: You must provide a value for the date query parameter.

Our gateway returns the following information about each batch in the list:

  • Transaction information, including the number of transactions and total value of sales.
  • Merchant information, including the merchant ID (MID) and the processing account that the batch is associated with.
get/batches

Query parameters

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

datestring date required

Filter batches by the date that they were submitted. The format of this value is YYYY-MM-DD.

merchantIdstring

Filter results by the unique identifier that the processor assigned to the merchant.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns a paginated list of batches.

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean

Indicates whether there is another page of results available.

Changes

No recorded changes to this endpoint across all 1 revision of this API.