GatewayBatchDetailResponse
successbooleanrequired
data object
Response payload for successful operations.
merchantIdstringrequired
locationIdstringrequired
batchIdstring<uuid>required
batchIdentifiers object[]required
Array [
gatewaySettlementBatchIdstring<uuid>required
processorSettlementBatchIdstring<uuid>nullable
processorSettlementReferencestringnullable
]
statusGatewayBatchStatusrequired
Possible values: [settled, review_required, reconciliation_mismatch, force_closed]
totalAmountintegernullable
transactionCountintegerrequired
currencystringnullable
currencyTotals object[]required
Array [
currencystringrequired
totalAmountintegerrequired
transactionCountintegerrequired
]
openedAtstring<date-time>nullable
closedAtstring<date-time>nullable
providerEvidence object[]required
Array [
providerstringrequired
Possible values: [cardpointe, transit, epx, elavon_epg]
processorTypestringnullable
processorPlatformstringnullable
remoteBatchIdstringnullable
reconciliationIdstringnullable
]
errorstring
Machine-readable error code.
messagestring
Human-readable response message.
GatewayBatchDetailResponse
{
"success": true,
"data": {
"merchantId": "string",
"locationId": "string",
"batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"batchIdentifiers": [
{
"gatewaySettlementBatchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"processorSettlementBatchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"processorSettlementReference": "string"
}
],
"status": "settled",
"totalAmount": 0,
"transactionCount": 0,
"currency": "string",
"currencyTotals": [
{
"currency": "string",
"totalAmount": 0,
"transactionCount": 0
}
],
"openedAt": "2024-07-29T15:51:28.071Z",
"closedAt": "2024-07-29T15:51:28.071Z",
"providerEvidence": [
{
"provider": "cardpointe",
"processorType": "string",
"processorPlatform": "string",
"remoteBatchId": "string",
"reconciliationId": "string"
}
]
},
"error": "string",
"message": "string"
}