Welcome
GP API: one REST API for payments, payment methods, 3-D Secure, merchants, funds, disputes and reporting.
GP API is Global Payments' REST API for taking and managing payments: card and alternative payment methods, stored payment methods, 3-D Secure authentication, merchant boarding, funds management, disputes and reporting, through one interface across Global Payments' processing platforms.
What you'll find here
- API Reference: all 73 operations in 17 groups (Transactions, Payment Methods, Authentications, Merchants, Accounts, Funds, Transfers, Disputes, Batches, Payers, Orders, Links and more), with request and response schemas, examples and a live API playground.
- SDKs: client libraries for C#, Python and TypeScript, generated by APIMatic from the same specification, with code samples on every endpoint.
- Context Plugin: brings GP API and its SDKs into AI coding assistants such as Claude Code, Cursor and Codex.
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox | https://apis.sandbox.globalpay.com/ucp |
| Production | https://apis.globalpay.com/ucp |
Every request also sends the API version header:
X-GP-Version: 2021-03-22Authentication
Create an access token with POST /accesstoken, sending your app_id, a unique nonce, secret = SHA512(nonce + app key) and grant_type: client_credentials. Then send the token as a bearer token on every other request:
Authorization: Bearer <access_token>Apps and keys are created on the GP Developer Portal.
Common tasks
- Get an access token:
POST /accesstoken - Take a payment (sale):
POST /transactions - Capture an authorized sale:
POST /transactions/{id}/capture - Refund a sale:
POST /transactions/{id}/refund - Store a card for later use:
POST /payment-methods - Check 3-D Secure availability:
POST /authentications - Board a merchant:
POST /merchants