BIbilasdk
Transfers

Initiate mobile money transfer

Changed on

Initiate a transfer to a mobile money account. Creates a transaction record in your dashboard.

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

Request

Request body

amountnumber required

Transfer amount

referencestring required

Unique client reference

phonestring required

Recipient phone number

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

Mobile money operator

country'zm' | 'ng' required

Country code

narrationstring

Transfer narration

walletIdstring uuid

Source wallet ID to debit (defaults to main wallet if omitted)

recipientNamestring

Recipient name for the transaction record

Example request

{
  "amount": 250,
  "reference": "mobile-transfer-001",
  "phone": "0977433571",
  "operator": "airtel",
  "country": "zm",
  "narration": "Mobile money payout",
  "walletId": "68f11209-451f-4a15-bfcd-d916eb8b09f4",
  "recipientName": "Jane Doe"
}

Response

Transfer initiated successfully

statusboolean required

Request success status

messagestring required

Response message

Example response

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

Changes

  • 781041632c91Revision changes
    • 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