TypeScript 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

The SDK compiles to dist/ before it can be referenced — run its build script once in the SDK folder, then add it to your project by path:

npm install <path-to-sdk>

Quick StartCopy Anchor Link

Create one client and reuse it. Configure its behaviour through ClientOptions.

import { GlobalPaymentsApiClient, ServerEnvironment } from "global-payments-api";

const client = new GlobalPaymentsApiClient({
  serverEnvironment: ServerEnvironment.Production,
  bearerAuth: "YOUR_BEARER_TOKEN",
});

Nothing in ClientOptions is required — new GlobalPaymentsApiClient() compiles — and each option left out falls back to its default. serverEnvironment is spelled out above so the environment a call reaches is visible where the client is built rather than inherited silently.

From CommonJSCopy Anchor Link

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

import sdk = require("global-payments-api");

const client = new sdk.GlobalPaymentsApiClient({
  serverEnvironment: sdk.ServerEnvironment.Production,
  bearerAuth: "YOUR_BEARER_TOKEN",
});