API reference

List transfers

GET/transfers

Lists transfers for the environment of the API key, newest first. Paginate with starting_after.

Required scope: transfers:read
Idempotency-Key: Not used
Environments: Sandbox and Live

Parameters

limitinteger · queryoptional
min 1 · max 100 · default 20
starting_afterstring · queryoptional
Cursor: the id of the last transfer from the previous page.
max length 64
statusenum · queryoptional
"processing", "succeeded", "failed"

Example request

curl "https://api.gloresend.com/sandbox/v1/transfers?limit=10" \
  -H "Authorization: Bearer $GLORESEND_TEST_KEY"

Response · 200

200 · application/json

{
  "object": "list",
  "data": [
    {
      "id": "tr_4k2m9q8w7e6r5t3y",
      "object": "transfer",
      "environment": "sandbox",
      "amount": 125000,
      "fee": 0,
      "currency": "XOF",
      "status": "succeeded",
      "destination": {
        "type": "bank_account",
        "account_name": "Ada Example",
        "country": "BJ",
        "bank_code": "GSBANK",
        "last4": "0001"
      },
      "reference": "INV-2026-0042",
      "description": "Supplier payout",
      "metadata": {
        "order_id": "A-1042"
      },
      "failure_code": null,
      "failure_message": null,
      "created_at": "2026-10-15T09:30:00.000Z",
      "completed_at": "2026-10-15T09:30:00.120Z",
      "test_data": true
    }
  ],
  "has_more": false
}

Response fields

objectenumrequired
"list"
dataarray of objectrequired
data[].idstringrequired
data[].objectenumrequired
"transfer"
data[].environmentenumrequired
"sandbox", "live"
data[].amountintegerrequired
data[].feeintegerrequired
Fee charged by GLORESEND in minor units. Pricing is not yet configured, so this is currently 0.
data[].currencyenumrequired
ISO 4217 currency code.
"USD", "EUR", "GBP", "XOF", "XAF", "NGN", "GHS", "KES"
data[].statusenumrequired
"processing", "succeeded", "failed"
data[].destinationobjectrequired
data[].destination.typeenumrequired
"bank_account", "mobile_money"
data[].destination.account_namestringrequired
data[].destination.countrystringrequired
data[].destination.bank_codestringoptional
data[].destination.networkstringoptional
data[].destination.last4stringrequired
Last four characters of the account or phone number. Full identifiers are never returned or stored after the request.
data[].referencestring | nullrequired
data[].descriptionstring | nullrequired
data[].metadatamap of stringrequired
data[].failure_codestring | nullrequired
data[].failure_messagestring | nullrequired
data[].created_atstringrequired
date-time
data[].completed_atstring | nullrequired
date-time
data[].test_databooleanrequired
has_morebooleanrequired

Errors

401authentication_requiredNo credentials were supplied. Send Authorization: Bearer <api key>.
401invalid_api_keyThe API key is unknown, revoked or expired.
401environment_mismatchThe API key belongs to a different environment than the base URL you called. Sandbox keys (gs_test_) only work against the Sandbox base URL, Live keys (gs_live_) only against the Live base URL.
429rate_limitedToo many requests. Wait for the number of seconds in the Retry-After header.
400validation_errorThe request body, query or headers failed validation. param points at the first invalid field.
403insufficient_scopeThe API key does not have the scope required for this endpoint.