ACH Provider1

ACH Tokens1

Ach Transactions1

ACH Transactions1

Android Device Configuration1

Apple Pay for Web1

Application1

AVS Settings1

Bank Account1

Batch out and query Open batch1

Batches1

Batches - Batch out and Open Batches Query1

get/rest/v1/batches/openGet current open transaction batch

Business Contact1

Check Duplicate Transaction Settings1

CSC Settings1

Customer1

Customer Token1

Device Settings1

Dispute Responses1

Disputes Reporting1

Documents2

Equipment Order1

Forecast1

HPP Settings1

LegalDocuments1

Merchant2

Mobile Transactions1

PayLink Settings1

Payment Plans1

Payment Transaction1

PricingPlanV21

Products1

Receipt Service1

Reference1

References1

ReferencesControllerV21

Report2

Report Settings1

RPS Settings1

Sales Profile1

Semi-Integrated Batches1

Semi-Integrated Transactions1

Signature Service1

Site Survey1

Survey1

Tax Payer1

Terminal Settings1

Terms And Conditions1

Tokens1

Transaction Alert Settings1

Transactions1

Types1

put/api/equipment/orders/resubmitManual update order

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

Request

The document declares no server URL.
Auth
none declared. Required headers: api-key
TypeScript
https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/docs/rest/v1/batches/open/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

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.

Changes

No recorded changes to this operation across all 1 revision of this API.