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.

Requests | Global Payments

Requests

Get to know the basics of sending requests to our API

This guide focuses on the key principles of executing API requests.

Environments

The environment you target, whether it's Sandbox or Production, is determined by the URL the request is sent to.

Sandbox

This is a test environment used to assess and test an integration to the API. Funds are never moved in this environment.

https://apis.sandbox.globalpay.com/ucp

Production

This environment is used to move actual funds between payers and merchants.

https://apis.globalpay.com/ucp

Resource location

The location to send requests to create, edit, or read resources is the base URL of the environment appended with the plural of the resource name.

For example:

The Transactions URL is used to authorize, reverse, refund, capture, and report on transactions.

https://apis.sandbox.globalpay.com/ucp/transactions

The Disputes URL is used to report on, challenge, and accept disputes.

https://apis.sandbox.globalpay.com/ucp/disputes

The Deposits URL is used to report on and reconcile deposits.

https://apis.sandbox.globalpay.com/ucp/deposits

HTTP verbs

When initiating an action through the API, an HTTP verb needs to be used. The usage of this aspect of the HTTP protocol ensures a lightweight and intuitive experience. The verbs indicate the behavior of the action being executed.

GET – Requests data about a single resource or a list of resources and is idempotent.
POST – Creates or updates a resource and is not idempotent.
PATCH – Partially updates an existing resource and is not idempotent.

Headers

The following table outlines the properties that can be sent in the header of a request.

Header	Description
Accept	Indicates the format of the response requested. Set to application/json.
Authorization	Contains the access token to use in a request.
Content-type	Indicates the format of the data in the request. Set to application/json.
Accept-encoding	Confirms that compressed response messages can be received, reducing network bandwidth. Supports `gzip` and `identity`.
X-GP-Version	Mandatory field that contains the version of the API to execute the request.
Idempotency-key	Contains a unique user-generated value that if repeated in a subsequent request, within a 24-hour window, the subsequent request will fail.

Sample request

curl -v -X POST https://apis.globalpay.com/ucp/settlement/deposits 
    -H "X-GP-Version: 2021-03-22" 
    -H "X-GP-Idempotency: 234quigdua7stduabkjwe"
    -H "Content-type: application/json" 
    -H "Authorization: Bearer KnxbvhyY4GgBYq6mV64uEGLzotrw"

Policies

Connect

Additional Resources