Getting started

Quickstart

Create a Sandbox key, verify it, check your test balance and send a simulated transfer.

1. Create a Sandbox API key

Create an account, open API keys in the dashboard with the environment switch on Sandbox, and create a key. Copy the secret immediately — it is shown once. Store it in an environment variable:

export GLORESEND_TEST_KEY=gs_test_…

2. Verify the key

curl "https://api.gloresend.com/sandbox/v1/ping" \
  -H "Authorization: Bearer $GLORESEND_TEST_KEY"

The response names your organization and confirms "environment": "sandbox".

3. Check your test balance

curl "https://api.gloresend.com/sandbox/v1/balances" \
  -H "Authorization: Bearer $GLORESEND_TEST_KEY"

The first call creates simulated wallets for every supported currency, each flagged test_data: true.

4. Send a transfer

curl -X POST "https://api.gloresend.com/sandbox/v1/transfers" \
  -H "Authorization: Bearer $GLORESEND_TEST_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 125000,
    "currency": "XOF",
    "destination": {
      "type": "bank_account",
      "account_number": "GS0000000001",
      "bank_code": "GSBANK",
      "account_name": "Ada Example",
      "country": "BJ"
    },
    "reference": "INV-2026-0042",
    "description": "Supplier payout",
    "metadata": {
      "order_id": "A-1042"
    }
  }'

Change the last four digits of account_number to 0002, 0003 or 0004 to simulate a declined destination, a provider timeout or a provider error. See Sandbox testing.

5. Next steps

Try the same requests from Send Box in the dashboard and inspect them in Request logs.
Add a webhook endpoint to receive transfer.succeeded and transfer.failed.
Read Idempotency before writing retry logic.