Python SDK

IntroCopy Anchor Link

The Global Payments API SDK provides access to the Global Payments API REST APIs.

GP API: one REST API for payments, payment methods, 3-D Secure, merchants, funds, disputes and reporting across Global Payments' platforms.

InstallationCopy Anchor Link

Add the SDK to your project from its folder, with whichever package manager your project uses. Give each tool a path containing a slash, such as ../global-payments-api — a bare folder name is looked up on PyPI instead, and resolves to whatever project holds that name there:

pip install <path-to-sdk>

uv add <path-to-sdk>

poetry add <path-to-sdk>

Quick StartCopy Anchor Link

Synchronous clientCopy Anchor Link

Construct GlobalPaymentsApiClient with keyword arguments, and call close() when you are done. Every argument is optional.

from global_payments_api import GlobalPaymentsApiClient

client = GlobalPaymentsApiClient(bearer_auth="YOUR_BEARER_TOKEN", environment="production")

client.close()

Alternatively, scope it — with GlobalPaymentsApiClient(...) as client: closes the pool on exit.

Asynchronous clientCopy Anchor Link

AsyncGlobalPaymentsApiClient mirrors GlobalPaymentsApiClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences — for example, the transport argument is custom_async_http_client.

from asyncio import run

from global_payments_api import AsyncGlobalPaymentsApiClient


async def main() -> None:
    client = AsyncGlobalPaymentsApiClient(bearer_auth="YOUR_BEARER_TOKEN", environment="production")
    await client.aclose()


run(main())

Alternatively, scope it — async with AsyncGlobalPaymentsApiClient(...) as client: closes the pool on exit.