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.

Before You Begin | Global Payments

Before You Begin

Confirm you have your API key and API secret

We provide you with a set of credentials for the test endpoints and a set of credentials for the production endpoints. Each set of credentials includes the following:

API key
API secret
Account credentials

Use your account credentials and the API secret to create an AuthToken for each request. For more information about authenticating your requests, see Authenticating Your Requests.

If you haven’t received your credentials, contact our Integrations Services team.

Important: Do not share your credentials with anyone. If you need to send us code examples, mask your credential details.

Integration flexibility

We regularly update our API, so make sure that your integration is flexible enough to handle new response fields from our gateway. When building your integration, do not hard-code the sequence of fields that you expect us to return in the response.

Running follow-on transactions

To run follow-on transactions, include either the reference_id or one of the following unique identifiers in your request:

creditsale_id - we assign this to credit sales.
debitsale_id - we assign this to debit sales.
creditreturn_id - we assign this to credit refunds.
debitreturn_id - we assign this to debit refunds.

Using a credit endpoint or a debit endpoint

We provide endpoints for credit transactions and debit transactions. To confirm if a transaction was credit or debit, see the value we return in the tender_type field of the original transaction.

Generating a receipt

You can generate a receipt when you send a request for the following:

To generate a receipt, set the value for the generate_receipt parameter to true. Depending on the HTTP method of your request, the generate_receipt parameter is in the request body or the request URL.

Note: The labels for the receipt fields are generated in the language you send in the original request.