DEVELOPER PLATFORM & API REFERENCE

The Developer-First Meta-Layer for Global Money Movement.

Integrate domestic bank networks, instant FX conversion, and stablecoin clearing through one unified ISO 20022 contract. Production-grade resilience, cryptographic idempotency, and sub-150ms gateway latency.

Get Sandbox API KeysTest Live Console
API AVAILABILITY
99.999% SLA
Multi-region active-active deployment
GATEWAY LATENCY
< 140ms
Global AWS edge acceleration
IDEMPOTENCY GUARANTEE
Strict Key Check
Prevents duplicate execution on network drops
SECURITY & AUDIT
SOC 2 + ISO 27001
End-to-end TLS 1.3 & HMAC-SHA256
THE API TECHNOLOGY STACK

One Unified Contract. 19+ Rails. Zero Complexity.

Built by payment architects for payment engineers. Integrate our ISO 20022-aligned API once and gain instant programmatic access to domestic bank networks, real-time gross settlement, and sub-second stablecoin clearing.

SCHEMA
ISO 20022 Aligned
Unified payload standard
IDEMPOTENCY
Zero-Duplicate
Cryptographic keys
GATEWAY LATENCY
< 140ms Median
Edge routed globally
WEBHOOK SECURITY
HMAC-SHA256
Signed event streams
POST/v1/payouts
import { GlobalPayment } from '@globalpayment/sdk';

const gp = new GlobalPayment({ apiKey: process.env.GP_API_KEY });

// Execute instant cross-border payout with automated rail selection
const payout = await gp.payouts.create({
  sourceAccountId: 'act_treasury_usd_01',
  destination: {
    country: 'BR',
    currency: 'BRL',
    routingProtocol: 'pix',
    pixKey: 'finance@empresa.com.br',
    beneficiaryName: 'Empresa Tech do Brasil Ltda'
  },
  amount: { value: 150000.00, currency: 'BRL' },
  purposeCode: 'COMMERCIAL_SETTLEMENT'
}, { idempotencyKey: 'idemp_94b8-f14a' });

console.log(`Payout executed via ${payout.rail}: ${payout.status}`);
200 OK
Latency: 142ms
{
  "id": "pay_88f219c0b1e4",
  "status": "settled",
  "routing": {
    "rail": "brazil_pix",
    "partner": "bitso_direct",
    "settlement_speed": "sub_30s"
  },
  "source_amount": {
    "value": 27420.5,
    "currency": "USD"
  },
  "disbursed_amount": {
    "value": 150000,
    "currency": "BRL"
  },
  "effective_fx_rate": 5.4703,
  "fees": {
    "network_fee": 12.5,
    "currency": "USD"
  },
  "clearing_receipt": "E9040088820261002164821a8f90",
  "created_at": "2026-10-02T16:48:21Z",
  "idempotency_key": "idemp_94b8-f14a"
}
Multi-Rail Smart Payout — Disburse funds across 113+ countries. Smart router selects the optimal local rail (FedNow, Pix, SPEI, SEPA Instant) in real time.
STEP 01

Generate API Keys

Obtain your Secret and Publishable API keys from the Developer Portal. GlobalPayment supports dual keypairs for development (sandbox) and live production environments.

// Set environment variable in your production runtime
export GP_API_KEY="gp_live_sk_8f902c44..."
export GP_WEBHOOK_SECRET="whsec_48a100b2..."
STEP 02

Attach Idempotency Keys

Every mutating request (POST, DELETE) accepts a unique X-Idempotency-Key header. If your network connection drops, retrying with the same key guarantees zero duplicate fund deductions.

// Recommended UUID v4 key generation
const idempotencyKey = crypto.randomUUID();

await gp.payouts.create(payload, {
  headers: { "X-Idempotency-Key": idempotencyKey }
});
STEP 03

Subscribe to Webhook Events

Payment settlement across national rails happens asynchronously. Configure a webhook listener to receive HMAC-SHA256 signed events when transactions settle or require approval.

// Verify HMAC signature in incoming payload
const signature = req.headers["x-gp-signature"];
const event = gp.webhooks.verifySignature(rawBody, signature, webhookSecret);

if (event.type === "payout.settled") {
  // Update internal general ledger
}
DEVELOPER ACCELERATION

Start Building on Sandbox in 5 Minutes.

Join hundreds of engineers building payment products across 113+ countries. Pre-funded sandbox accounts with simulated FedNow, Pix, and SPEI rails.