List transfers

Retrieve transfers created with the authenticated API key and environment.

Endpoint

GET /api/transferts

Requires X-API-Key authentication.

Query parameters

ParameterTypeDefaultDescription
pageinteger1Page number.
sizeinteger10Number of transfers per page.

Example request

curl '<SANDBOX_API_URL>/transferts?page=1&size=10' \
  -H 'X-API-Key: <your_sandbox_api_key>'

Response

{
  "transferts": {
    "page": 1,
    "size": 10,
    "total": 1,
    "content": [
      {
        "id": "transfer_123",
        "reference": "TEST-TXN-1731493800000-123456",
        "amount": 2000,
        "status": "INIT",
        "createdAt": "2026-11-13T10:30:00.000Z",
        "service_mobile": {
          "name": "MTN Cameroon",
          "code_prefix": "MTN-CM"
        },
        "beneficiary": {
          "phone": "+237690000000"
        }
      }
    ]
  }
}

When more pages are available, the pagination object includes next_page. It includes previous_page when a previous page exists.

Transfer lifecycle

The transfer is stored before it is sent to the execution queue. The queue worker sends it to the Runner and later updates its status. Treat INIT as accepted and queued, not as completed.

Errors

  • 401 — missing or invalid API key;
  • 500 — unexpected server error.