GBF Public API v1

A versioned REST API for accounts, wallets, transfers and payouts. Typed errors, idempotent writes and a published OpenAPI 3.1 document.

Conventions

Rules the whole API follows

  • Problem+json errors

    Errors follow RFC 9457. Every error carries a deterministic code and a request ID you can quote to support.

  • Idempotency-Key on writes

    Send a UUIDv4 Idempotency-Key with every POST. Retries with the same key return the original result — never a duplicate.

  • Money in minor units

    Amounts are integers of minor units with an ISO 4217 currency code, plus a server-rendered display string.

  • Cursor pagination

    Lists are cursor-paginated. There are no unbounded list responses.

  • Request ID everywhere

    Every response carries a request ID header for traceability.

  • Versioned base path

    All endpoints live under /v1. Breaking changes move the version, never the meaning of a field.

Get started

From key to first call

  1. Request API access

    Open a business account and request API credentials from the developer console.

  2. Read the OpenAPI document

    The published OpenAPI 3.1 document is the contract. Generate your client from it; do not hand-write endpoints.

  3. Make an idempotent write

    Generate one Idempotency-Key per user intent and reuse it on retry. Read the request ID from every response.

Open the developer console

Sign in to the developer portal to manage credentials and review usage.