Skip to main content
GET
Get beneficiaries

Authorizations

x-service-key
string
header
required

Service key for API authentication

Query Parameters

country
enum<string>

Filter by country.

Available options:
BJ,
CD,
CI,
CM,
ET,
GA,
GH,
GM,
GN,
KE,
LR,
ML,
MW,
NG,
RW,
SL,
SN,
TZ,
UG,
ZA,
ZM
currency
enum<string>

Filter by currency.

Available options:
CDF,
ETB,
GHS,
GMD,
GNF,
KES,
LRD,
MWK,
NGN,
RWF,
SLE,
TZS,
UGX,
USD,
XAF,
XOF,
ZAR,
ZMW
channel
enum<string>

Filter by channel.

Available options:
BANK,
MOBILEMONEY
category
enum<string>

Filter by account category.

Available options:
INDIVIDUAL,
BUSINESS

Filter by reference or keyword

Maximum string length: 200
page
integer
default:1

Results page number. Default 1.

Required range: x >= 1
limit
integer
default:10

Results per page. Default 10, maximum 100.

Required range: 1 <= x <= 100

Response

Beneficiaries retrieved successfully

success
boolean
required
message
string
required
timestamp
string<date-time>
required
data
object
required