Getting started

Quickstart

From zero to your first reconciled inflow, in sandbox, in about ten minutes.

Everything below runs against sandbox. Nothing you do here touches live systems, and verification is not required — sandbox opens the moment your workspace exists.

1 · Create a sandbox API key

In the dashboard, open Developers → API keys → Create key. Scope it to what you need — keys can be read-only, or allowed to create accounts and payouts. The secret is shown once; store it in your secret manager.

Every request

Authorization: Bearer gp_sk_sandbox_…
Content-Type: application/json
Base URL: https://api.sandbox.globbapay.com/v1

2 · Create a customer

POST /v1/customers

{
  "type": "individual",
  "name": "Adaeze Okafor",
  "partner_ref": "usr-1042",
  "country": "NG",
  "bvn": "22147893301"
}

Screening starts immediately. You’ll getcustomer.status.changedwhen it resolves — usually seconds in sandbox.

3 · Issue a receiving account

POST /v1/accounts

{
  "customer": "cus_adaeze01",
  "currency": "USD"
}

4 · Register a webhook and simulate an inflow

Register your HTTPS endpoint under Developers → Webhooks, then use the dashboard’s “Simulate incoming transfer” on any active account. You’ll receive a signedinflow.receivedevent with the ledger reference to reconcile against.

Webhook payload

{
  "id": "evt_5k20d9x1aa",
  "type": "inflow.received",
  "amount_minor": 500000,
  "currency": "USD",
  "account": "acct_adaezeusd",
  "payer_name": "Northwind Design Co",
  "ledger_ref": "led_84h2m1"
}