v3

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

List transfer recipients

Retrieve a paginated list of saved transfer recipients

get/api/v1/bila/transfer-recipients

Query parameters

pagenumber
Example:1

Page number (default: 1)

perPagenumber
Example:50

Items per page (default: 50)

type'bank-account' | 'mobile-money'

Transfer recipient type

Example:bank-account

Filter by recipient type

Response

Recipients retrieved successfully

statusboolean required

Request success status

messagestring required

Response message

Example response

{
  "status": true,
  "message": "Operation completed successfully",
  "data": {
    "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"
      }
    ],
    "meta": {
      "total": 150,
      "perPage": 50,
      "currentPage": 1,
      "pageCount": 3
    }
  }
}