Skip to main content
POST
Create beneficiary

Authorizations

x-service-key
string
header
required

Body

application/json
currency
enum<string>
required

The currency code for the beneficiary

Available options:
NGN
Example:

"ngn"

identity_id
string
required

The identity ID associated with this beneficiary

Example:

"68bf2de7196a18d7bd165ffb"

details
Nigerian Bank Account · object
required

Banking details based country

Response

201 - application/json

Beneficiary created successfully

success
boolean
Example:

true

status
integer
Example:

201

message
string
Example:

"Beneficiary created successfully"

timestamp
string<date-time>
Example:

"2025-09-08T20:40:35.538Z"

data
object