Collections
List collections
Retrieve a paginated list of payment collections for the authenticated merchant
get/api/v1/bila/collections
Query parameters
pagenumber
Example:1
Page number (default: 1)
perPagenumber
Example:50
Items per page (default: 50)
status'pending' | 'successful' | 'failed' | 'otp-required' | 'pay-offline'
Collection status
Example:pending
Filter by collection status
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
Collections retrieved successfully
Example response
{
"status": true,
"message": "Operation completed successfully",
"data": {
"data": [
{
"id": "col-001",
"reference": "order-12345",
"status": "pending",
"amount": 100,
"currency": "ZMW",
"feeBearer": "merchant",
"narration": "Payment for Order #12345",
"customer": {
"phone": "0977123456",
"name": "JOHN DOE",
"operator": "airtel"
},
"createdAt": "2024-01-15T10:30:00Z",
"completedAt": "2024-01-15T10:31:00Z"
}
],
"meta": {
"total": 150,
"perPage": 50,
"currentPage": 1,
"pageCount": 3
}
}
}