Skip to main content
POST
Create beneficiary

Authorizations

x-service-key
string
header
required

Service key for API authentication

Body

application/json
direction
enum<string>
required
Available options:
OFFRAMP,
ONRAMP
country
enum<string>
required
Available options:
BJ,
CD,
CI,
CM,
ET,
GA,
GH,
GM,
GN,
KE,
LR,
ML,
MW,
NG,
RW,
SL,
SN,
TZ,
UG,
ZA,
ZM
beneficiary
Receive to saved beneficiary · object
required

Beneficiary details.

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

Response

Beneficiary created successfully

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