List recipients
Saved recipients with their last payment (“Last paid 26 Oct”, “Failed 25 Oct”). Archived recipients are
left out unless status=archived is sent. q matches name, nickname, bank name and account number.
include=total_count gives the tab badge count.
Error codes: invalid_api_key, parameter_invalid, scope_missing, rate_limited.
Authorizations
Server API key, scoped. pk_test_ keys hit the sandbox tenant.
Headers
Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always
our own req_… id. We log your value with the request as client_request_id, so support can find a request by
either id. A longer value is refused with 400 parameter_invalid.
128Query Parameters
Page size, 1–100.
1 <= x <= 100Cursor from the previous page's next_cursor. Returns older items. Don't send with before.
Cursor for the reverse direction: returns the items newer than this one. The page is still sorted newest first;
has_more and next_cursor then continue in the same (newer) direction, so pass next_cursor as before to
keep paging towards the newest items. Don't send with after.
Free-text search.
200Set to total_count to add total_count to the list response.
total_count Comma-separated. Default active.
Only recipients in this currency.
ISO 4217. Only NGN is live at launch; others return 422 currency_not_enabled.
NGN, USD, GBP, EUR, GHS, KES -created_at (default, newest first) or -last_paid_at (most recently paid first, never-paid last;
the order of the Recipients table and the "Saved" chips in Pay).
-created_at, -last_paid_at Response
A page of recipients.
Cursor page. Domain files compose this with allOf and set data.items.
"list"Recipients.
True when another page exists.
Cursor for the next page in the same direction: pass it as after if this page was read with after (or no cursor), as before if it was read with before. Null when has_more is false.
Only when include=total_count was sent.