Skip to content
Loading keys…
Authorization<token>

A public key (pk./pk_test.) is accepted on /payments, /customers, /links, /invoices and the catalogue reads (/channels, /providers, /countries, /currencies); anything that moves money out, reads the balance or manages the account answers 406 to it. It is an identifier, never an authorization. Use a secret key (sk./sk_test.) for sensitive operations (transfers, refunds, balance), or a restricted key (rk./rk_test.) scoped to specific permissions. The _test. variant of any key selects the sandbox environment, there is no separate sandbox URL. Never expose your secret key in client-side code.

In: header

Query Parameters

per_pageinteger | null

Max per page (1–100).

pageinteger

The page to read, from 1, for offset pagination. Ignored with `cursor`.

is_activeboolean | null

Filter by active status.

typestring | null

Filter by beneficiary type: `standard`, `privileged`, or `all`. Defaults to `standard`, `privileged` beneficiaries (added from the Konsole dashboard) are only included when explicitly requested.

cursorstring | null

The `next_cursor` of a previous response, a numbered page included: switches the list to cursor pagination.

searchstring | null

Search over the name, phone and email.

Response Body

application/json

curl -X GET "https://api.wajub.com/beneficiaries?per_page=10&page=2&is_active=true&type=standard&search=Dupont"
GET
/beneficiaries
{  "code": 200,  "status": "OK",  "message": "Beneficiaries retrieved",  "items": [    {      "id": "ben_Fw8Qa3Zr6Ty1Np5Jd2Lv",      "name": "Jean Dupont",      "email": "jean.dupont@example.com",      "phone": "+237670000000",      "country_code": "CM",      "note": "Pays every Friday",      "metadata": {        "seller_id": "42"      },      "sandbox": false,      "is_active": true,      "type": "standard",      "created_at": "2026-09-02T08:14:22+00:00",      "updated_at": "2026-09-02T08:14:22+00:00",      "verified": true,      "verification": "verified",      "payment_method": {        "id": "pm_Kx7Wq2Rm9Tz4Lb8Nv3Hd",        "type": "mobile_money",        "name": "MTN Mobile Money CM"      }    }  ],  "meta": {    "current_page": 1,    "last_page": 1,    "per_page": 25,    "total": 1,    "next_cursor": null,    "has_more": false  }}

OK

What did you think of this content?