Skip to main content
GET
/
api
/
v1
/
bila
/
transfer-recipients
List transfer recipients
curl --request GET \
  --url https://api.usebila.com/api/v1/bila/transfer-recipients \
  --header 'x-api-key: <api-key>'
{
  "status": true,
  "message": "Operation completed successfully",
  "data": {
    "data": [
      {
        "id": "68f11209-451f-4a15-bfcd-d916eb8b09f4",
        "type": "bank-account",
        "accountName": "John Doe",
        "country": "zm",
        "createdAt": "2024-01-15T10:30:00Z",
        "accountNumber": "1234567890",
        "bankId": "bank-001",
        "bankName": "Zambia National Commercial Bank",
        "phone": "0977123456",
        "operator": "airtel"
      }
    ],
    "meta": {
      "total": 150,
      "perPage": 50,
      "currentPage": 1,
      "pageCount": 3
    }
  }
}

Authorizations

x-api-key
string
header
required

Merchant API key (e.g., sk_live_xxx or sk_test_xxx)

Query Parameters

page
number

Page number (default: 1)

Required range: x >= 1
Example:

1

perPage
number

Items per page (default: 50)

Required range: 1 <= x <= 100
Example:

50

type
enum<string>

Filter by recipient type

Available options:
bank-account,
mobile-money

Response

Recipients retrieved successfully

status
boolean
required

Request success status

Example:

true

message
string
required

Response message

Example:

"Operation completed successfully"

data
object