Get All Transfers

Retrieve a paginated list of all transfer transactions.

Endpoint

GET /api/transferts

Query Parameters

pagenumber
Page number (starts from 0)
sizenumber
Number of items per page

Example Request

GET /api/transferts?page=0&size=10
X-API-Key: sk_test_your_api_key_here

Response

Response Body Example

[
  {
    "id": "transfer_123",
    "reference": "TRANS_123456789",
    "amount": 2000,
    "name": "John Doe",
    "phone": "+2250102030405",
    "service_mobile_code": "ORANGE_CI",
    "status": "COMPLETE",
    "createdAt": "2024-01-15T11:00:00Z",
    "updatedAt": "2024-01-15T11:05:00Z"
  },
  {
    "id": "transfer_124",
    "reference": "TRANS_987654321",
    "amount": 1500,
    "name": "Jane Smith",
    "phone": "+2250607080910",
    "service_mobile_code": "MTN_CI",
    "status": "PENDING",
    "createdAt": "2024-01-15T12:00:00Z",
    "updatedAt": "2024-01-15T12:00:00Z"
  },
  {
    "id": "transfer_125",
    "reference": "TRANS_456789123",
    "amount": 3000,
    "name": "Alice Johnson",
    "phone": "+221778899001",
    "service_mobile_code": "ORANGE_SN",
    "status": "FAILED",
    "createdAt": "2024-01-15T13:00:00Z",
    "updatedAt": "2024-01-15T13:02:00Z"
  }
]

Pagination Metadata

{
  "data": [], // Array of transfers
  "total": 45,
  "page": 0,
  "size": 10,
  "totalPages": 5
}

Response Fields

idstring
Unique identifier for the transfer
referencestring
Unique reference number for the transfer
amountnumber
Transfer amount
namestring
Recipient's name
phonestring
Recipient's phone number
service_mobile_codestring
Mobile service code used for the transfer
statusstring
Current status of the transfer
createdAtstring
Transfer creation timestamp (ISO 8601)
updatedAtstring
Last update timestamp (ISO 8601)

Error Responses

401 Error Example

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

403 Error Example

{
  "statusCode": 403,
  "message": "Forbidden resource",
  "error": "Forbidden"
}
Initialize Transfer
Create a new mobile money transfer