Sign in
Settlement

Retrieve batch

Use this method to retrieve information about a batch.

Note: To retrieve a batch, you need its batchId. If you don't have the batchId, use our List Batches method to search for the batch.

Our gateway returns the following information about the batch:

  • 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/{batchId}

Path parameters

batchIdinteger required

Unique identifier that we assigned to the batch.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns the requested batch.

batchIdinteger

Unique identifier that we assigned to the batch.

datestring date

Date that the merchant submitted the batch. The format of this value is YYYY-MM-DD.

createdDatestring date

Date that we created a record for the batch. The format of this value is YYYY-MM-DD.

lastModifiedDatestring date

Date that the batch was last changed. The format of this value is YYYY-MM-DD.

saleAmountinteger

Total value of sales in the batch. We return the value in the currency's lowest denomination, for example, cents.

heldAmountinteger

Total value of authorizations in the batch. We return the value in the currency's lowest denomination, for example, cents.

returnAmountinteger

Total value of returns in the batch. We return the value in the currency's lowest denomination, for example, cents.

transactionCountinteger

Total number of transactions in the batch.

currencystring

Currency of the transactions in the batch. The value for the currency follows the ISO 4217 standard.

Changes

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