Sign in

v3

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-10283986.5 KB
Transfer Recipients

Create mobile money recipient

Create a new mobile money transfer recipient

post/api/v1/bila/transfer-recipients/mobile-money

Request body

phonestring required

Mobile phone number

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

Mobile money operator

accountNamestring

Account holder name (optional, will be resolved)

country'zm' required

Country code

Example request

{
  "phone": "0977433571",
  "operator": "airtel",
  "accountName": "John Doe",
  "country": "zm"
}

Response

Recipient created successfully

statusboolean required

Request success status

messagestring required

Response message

Example response

{
  "status": true,
  "message": "Operation completed successfully",
  "data": {
    "id": "68f11209-451f-4a15-bfcd-d916eb8b09f4",
    "type": "bank-account",
    "accountNumber": "1234567890",
    "accountName": "John Doe",
    "bankId": "bank-001",
    "bankName": "Zambia National Commercial Bank",
    "phone": "0977123456",
    "operator": "airtel",
    "country": "zm",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}