Global Payments API
GP Developer PortalGP API reference
HomeAPI ReferenceSDKsContext Plugin
Batches

Close a Batch

POST
/batches/{id}

Close a Batch using the Global Payments Batch id.

Closing a batch results in commencement of funding to the merchant all the transactions in that batch. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.

Authorization

bearerAuth
AuthorizationBearer <token>

Access token from POST /accesstoken, sent as Authorization: Bearer <token>.

In: header

Path Parameters

id*string

A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.

Length1 <= length <= 50

Header Parameters

X-GP-Version*string

The version of the API to execute the request.

Length1 <= length <= 50
Default"2021-03-22"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/batches/BAT_855049-899" \  -H "X-GP-Version: 2021-03-22"
{  "id": "BAT_855049-899",  "status": "OPEN",  "time_created": "2021-05-03T21:23:39.718Z",  "time_last_updated": "2021-05-03T21:23:39.718Z",  "time_closed": "2021-05-03T21:23:39.718Z",  "open_action_id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",  "close_action_id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",  "merchant_id": "MER_A6A1EC44522F96630ABEA17A",  "merchant_name": "ABC INDUSTRIES",  "account_id": "TRA_86920f927028745yt34d077d88beb29b",  "account_name": "transaction_processing",  "site_reference": "string",  "device_reference": "string",  "transaction_count": 126,  "amount": "12000",  "currency": "USD",  "gratuity_amount": "500",  "sales": {    "count": 123,    "amount": "12300"  },  "refunds": {    "count": 3,    "amount": "300"  },  "funding_debit": {    "count": 100,    "amount": "10000"  },  "funding_credit": {    "count": 26,    "amount": "2300"  },  "brand_breakdown": [    {      "brand": "VISA",      "amount": "8300",      "count": 83,      "gratuity_amount": "500",      "sales": {        "count": 80,        "amount": "8000"      },      "refunds": {        "count": 3,        "amount": "300"      },      "funding_debit": {        "count": 80,        "amount": "8000"      },      "funding_credit": {        "count": 3,        "amount": "300"      }    }  ],  "host_breakdown": {    "merchant_name": "MERCHANT ABC INC.",    "reference": "string",    "amount": "12300",    "count": 126,    "funding_debit": {      "sales": {        "count": 80,        "amount": "8000"      },      "refunds": {        "count": 3,        "amount": "300"      }    },    "funding_credit": {      "sales": {        "count": 0,        "amount": "string"      },      "refunds": {        "count": 3,        "amount": "300"      }    }  },  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "BATCH_SINGLE",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Get a Batch GET

Get a single view of a Batch using the Global Payments Batch id. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.

Get Transactions Within a Batch GET

Get a List of Transactions Within a Batch Get the details of all transactions within a given Batch. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.