v3

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-10283986.5 KB
Collections

Get collection by reference

Retrieve collection status by client reference

get/api/v1/bila/collections/status/{reference}

Path parameters

referencestring required
Example:collection-001

Client reference

Response

Collection retrieved successfully

statusboolean required

Request success status

messagestring required

Response message

Example response

{
  "status": true,
  "message": "Operation completed successfully",
  "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"
  }
}