v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB

Card Batch

Get Card Batches

get/card-batches

Query parameters

batchNumbernumber

The number of the batch to retrieve. Note that this is the batch number, not batch ID.

terminalIdnumber

The terminalId of the requested batch

collect-stats'true' | 'false'

Includes transaction statistics for the batch

Response

Successful

idinteger

Id of Card batch

dateCreatedstring

Date Card batch is Created

dateUpdatedstring

Date Card batch is last updated

dateClosedstring

Date Card Batch is closed

closedboolean

True if the batch is closed. Else false

terminalIdinteger

Id of associated Terminal

batchNumberinteger

Batch Number

netSalesnumber

Approved sales net refunds and voids

totalSalesnumber

Gross sales

totalRefundsnumber

Gross refunds

totalReversednumber

Voided amount

totalRefundsReversednumber

Amount of voided refunds

countTotalnumber

Total number of transactions

countApprovednumber

Number of approved transactions

countDeclinednumber

Number of declined transactions

Example response

[
  {
    "id": 2488717,
    "dateCreated": "2022-11-30 13:14:53",
    "dateUpdated": "2022-11-30 13:14:53",
    "dateClosed": "2022-11-30 14:14:53",
    "closed": true,
    "terminalId": 1411,
    "batchNumber": 6,
    "netSales": 90,
    "totalSales": 100,
    "totalRefunds": 8.5,
    "totalReversed": 5,
    "totalRefundsReversed": 3.5,
    "countTotal": 8,
    "countApproved": 8
  }
]