Transfers
List transfers
Retrieve a paginated list of transfers/payouts for the authenticated merchant
get/api/v1/bila/transfers
Query parameters
pagenumber
Example:1
Page number (default: 1)
perPagenumber
Example:50
Items per page (default: 50)
status'pending' | 'successful' | 'failed'
Filter by transfer status
type'bank-account' | 'mobile-money'
Transfer recipient type
Example:bank-account
Filter by transfer type
accountIdstring
Example:68f11209-451f-4a15-bfcd-d916eb8b09f4
Filter by account ID
startDatestring
Example:2024-01-01T00:00:00Z
Filter by start date (ISO 8601)
endDatestring
Example:2024-12-31T23:59:59Z
Filter by end date (ISO 8601)
Response
Transfers retrieved successfully
Example response
{
"status": true,
"message": "Operation completed successfully",
"data": {
"data": [
{
"id": "txn-001",
"reference": "payout-12345",
"type": "bank-account",
"status": "successful",
"amount": 1000,
"currency": "ZMW",
"narration": "Salary payment",
"recipient": {
"accountNumber": "1234567890",
"accountName": "JOHN DOE",
"bankName": "Zambia National Commercial Bank",
"phone": "0977123456",
"operator": "airtel"
},
"createdAt": "2024-01-15T10:30:00Z",
"completedAt": "2024-01-15T10:31:00Z"
}
],
"meta": {
"total": 150,
"perPage": 50,
"currentPage": 1,
"pageCount": 3
}
}
}