SchemaReportingSettlement

Retrieve batch

Retrieve a specific batch.

Path parameters

batchIdintegerRequired
Unique identifier of 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 of 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. We return the value in the currency's lowest denomination, for example, cents.
heldAmountinteger or null
Total value of authorizations. We return the value in the currency's lowest denomination, for example, cents.
returnAmountinteger or null
Total value of returns. 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.
merchantobject or null
Object that contains information about the merchant.

Errors