Sign in

v1

latestOpenAPI 3.0.12026-07-2356172250.9 KB
Batches - Batch out and Open Batches Query

Get current open transaction batch

Retrieve the currently open batch on the gateway for the terminal.

get/rest/v1/batches/open

Query parameters

Total number of refund transactions in the batch.

Total number of refund transactions in the batch.

Total number of sale transactions in the batch.

Total amount of sale transactions in the batch.

Total amount of transactions in the batch.

Total number of transactions in the batch.

Confirmation code for the settled batch.

Date and time when the batch was settled.

The status of the batch.

Headers

An access API key issued to you by Xplor Pay.

Response

Success

idstring

Unique identifier of the open batch.

statusstring

Current status of the batch.

settledstring

Indicates whether the batch has been settled.

refund_countstring

Total number of refund transactions in the batch.

refund_totalstring

Total amount of refunds processed in the batch.

sales_countstring

Total number of sales transactions in the batch.

sales_totalstring

Total amount of sales processed in the batch.

net_amountstring

Net amount for the batch after sales and refunds are applied.

total_countstring

Total number of transactions in the batch.

confirmation_codestring

Confirmation code when the batch is opened or updated.