For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Get a Batch

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.

Header Parameters

authorizationstringrequired

Bearer access token value used to authorize and access the API. Must always begin with the string "Bearer".

example: Bearer DCKbRy6gtN6gWJI2ja0B7e3POtbb

default: Bearer DCKbRy6gtN6gWJI2ja0B7e3POtbb

x-gp-versionstringrequired

The version of the API to execute the request.

example: 2021-03-22

default: 2021-03-22

minLength: 1

maxLength: 50

acceptstring

Indicates the expected format of the message response.

default: application/json

Path Parameters

idstringrequired

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

example: BAT_855049-899

minLength: 1

maxLength: 50

Response Parameters

Endpoints

GEThttps://apis.sandbox.globalpay.com/ucp/batches/{id}

GEThttps://apis.globalpay.com/ucp/batches/{id}

NO BODY REQUIRED

Policies

Connect

Additional Resources

Get a Batch

Header Parameters

Path Parameters

Response Parameters

Endpoints

Get a Batch

Header Parameters

Path Parameters

Response Parameters200 Success

Endpoints

200 SuccessCOPY

Response Parameters