SchemaReportingSettlement

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.

Path parameters

batchIdintegerRequired
Unique identifier that we assigned to the batch.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful request. Returns the requested batch.
batchIdinteger or null
Unique identifier that we assigned to the batch.
datedate or null

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

createdDatedate or null

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

lastModifiedDatedate or null

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

saleAmountinteger or null
Total value of sales in the batch. We return the value in the currency's lowest denomination, for example, cents.
heldAmountinteger or null
Total value of authorizations in the batch. We return the value in the currency's lowest denomination, for example, cents.
returnAmountinteger or null
Total value of returns in the batch. We return the value in the currency's lowest denomination, for example, cents.
transactionCountinteger or null
Total number of transactions in the batch.
currencystring or null

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

merchantobject or null
Object that contains information about the merchant.

Errors