Batch out and query Open batch

Get open batch

get

Retrieve the list of open batches available for the terminal.

Header parameters

api-keyanyRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: batch

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

500

Internal Server Error

application/jsonapplication/xml

get

/rest/v2/batches/open

HTTPcURLJavaScriptPython

GET /rest/v2/batches/open HTTP/1.1
Accept: */*

{
  "batch": {
    "id": "00101",
    "status": "CLOSED",
    "settled": "2020-05-02T19:48:04.993Z",
    "refund-count": "2",
    "refund-total": "200.0",
    "sales-count": "32",
    "sales-total": "9000.0",
    "net-amount": "8800.0",
    "total-count": "34",
    "confirmation-code": "00039999",
    "merchant-id": "000000101202",
    "terminal-id": "11113333",
    "terminal-name": "Station 1",
    "date-opened": "11113333",
    "switch-batch-id": "text"
  },
  "payloadType": "batch"
}

Close open batch

put

Close the open batch for the terminal. Open batches can be closed manually through this API or automatically through the payment gateway or by configuring Merchant Account Settings.

Header parameters

api-keyanyRequired

An access API key issued to you by Xplor Pay.

Body

application/json

Request payload for closing the batch

lastBatchClosedRequiredInResponsebooleanRead-onlyOptional

Indicates whether the response must include details about the last batch that was closed.

Example: true

software-typestringOptional

Identifies the type of software that initiated the batch close request.

Example: string

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: batch

400

Bad Request

application/jsonapplication/xml

401

Unauthorized.

application/jsonapplication/xml

403

Forbidden.

application/jsonapplication/xml

404

Not Found.

application/jsonapplication/xml

500

Server Error.

application/jsonapplication/xml

put

/rest/v2/batches/open

HTTPcURLJavaScriptPython

PUT /rest/v2/batches/open HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "software-type": "string"
}

{
  "batch": {
    "id": "00101",
    "status": "CLOSED",
    "settled": "2020-05-02T19:48:04.993Z",
    "refund-count": "2",
    "refund-total": "200.0",
    "sales-count": "32",
    "sales-total": "9000.0",
    "net-amount": "8800.0",
    "total-count": "34",
    "confirmation-code": "00039999",
    "merchant-id": "000000101202",
    "terminal-id": "11113333",
    "terminal-name": "Station 1",
    "date-opened": "11113333",
    "switch-batch-id": "text"
  },
  "payloadType": "batch"
}