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.
batchIdintegerOptional
Unique identifier of the batch.
datestringOptionalformat: "date"

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

createdDatestringOptionalformat: "date"

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

lastModifiedDatestringOptionalformat: "date"

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

saleAmountintegerOptional
Total value of sales. We return the value in the currency's lowest denomination, for example, cents.
heldAmountintegerOptional
Total value of authorizations. We return the value in the currency's lowest denomination, for example, cents.
returnAmountintegerOptional
Total value of returns. We return the value in the currency's lowest denomination, for example, cents.
transactionCountintegerOptional
Total number of transactions in the batch.
currencystringOptional
Currency of the transactions.
merchantobjectOptional
Object that contains information about the merchant.

Errors