BIbilasdk
Collections

Initiate mobile money collection

Changed on

Initiate a payment collection from a mobile money account. Creates a transaction record in your dashboard.

post/api/v1/bila/collections/mobile-money

Request

Request body

amountnumber required

Collection amount

referencestring required

Unique client reference

phonestring required

Customer phone number

operator'airtel' | 'mtn' | 'zamtel' | 'vodacom' required

Mobile money operator

country'zm' | 'ng' required

Country code

bearer'merchant' | 'customer'

Who bears the transaction fee

narrationstring

Collection narration

walletIdstring uuid required

Target wallet ID to credit

customerNamestring

Customer name for the transaction record

Example request

{
  "amount": 100.5,
  "reference": "collection-001",
  "phone": "0977433571",
  "operator": "airtel",
  "country": "zm",
  "bearer": "customer",
  "narration": "Payment for subscription",
  "walletId": "68f11209-451f-4a15-bfcd-d916eb8b09f4",
  "customerName": "John Doe"
}

Response

Collection initiated 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": "successful",
    "amount": 100,
    "currency": "ZMW",
    "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"
  }
}

Changes

  • 781041632c91Revision changes
    • info

      the request property default value merchant was added

    • info

      added the new ng enum value to the request property

    • info

      added the new vodacom enum value to the request property

  • 60e9d9bed8ebRevision changes
    • breaking

      removed the enum value ng of the request property

    • breaking

      removed the enum value vodacom of the request property

    • info

      the request property default value merchant was removed