Skip to main content
GET
/
api
/
v1
/
bila
/
collections
List collections
curl --request GET \
  --url https://api.usebila.com/api/v1/bila/collections \
  --header 'x-api-key: <api-key>'
{
  "status": true,
  "message": "Operation completed successfully",
  "data": {
    "data": [
      {
        "id": "col-001",
        "reference": "order-12345",
        "status": "successful",
        "amount": 100,
        "currency": "ZMW",
        "customer": {
          "phone": "0977123456",
          "name": "JOHN DOE",
          "operator": "airtel"
        },
        "createdAt": "2024-01-15T10:30:00Z",
        "narration": "Payment for Order #12345",
        "completedAt": "2024-01-15T10:31:00Z"
      }
    ],
    "meta": {
      "total": 150,
      "perPage": 50,
      "currentPage": 1,
      "pageCount": 3
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Merchant API key (e.g., sk_live_xxx or sk_test_xxx)

Query Parameters

​
page
number

Page number (default: 1)

Required range: x >= 1
Example:

1

​
perPage
number

Items per page (default: 50)

Required range: 1 <= x <= 100
Example:

50

​
status
enum<string>

Filter by collection status

Available options:
pending,
successful,
failed,
otp-required,
pay-offline
​
accountId
string

Filter by account ID

Example:

"68f11209-451f-4a15-bfcd-d916eb8b09f4"

​
startDate
string

Filter by start date (ISO 8601)

Example:

"2024-01-01T00:00:00Z"

​
endDate
string

Filter by end date (ISO 8601)

Example:

"2024-12-31T23:59:59Z"

Response

Collections retrieved successfully

​
status
boolean
required

Request success status

Example:

true

​
message
string
required

Response message

Example:

"Operation completed successfully"

​
data
object