API reference

Retrieve a transfer

GET/transfers/{id}

Retrieves a transfer by id. Transfers from other organizations or the other environment are never visible.

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

Parameters

idstring · pathrequired
max length 64

Example request

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

Response · 200

200 · application/json

{
  "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
}

Response fields

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

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.
403insufficient_scopeThe API key does not have the scope required for this endpoint.
404not_foundThe requested resource does not exist or is not visible to this API key.