Create a beneficiary
Create a beneficiary using the recipient's bank details.
You can also specify other details including an alias for the beneficiary (i.e. an easy-to-remember name different from the account name.)
Authorizations
Body
currencystring | nullableOptional
countrystring | nullableOptional
full_namestring | nullableOptional
emailstring | nullableOptional
phone_numberstring | nullableOptional
descriptionstring | nullableOptional
account_numberstring | nullableOptional
bank_codestring | nullableOptional
bank_namestring | nullableOptional
account_namestring | nullableOptional
street_numberstring | nullableOptional
street_namestring | nullableOptional
citystring | nullableOptional
postal_codestring | nullableOptional
Responses
200
Success
application/json
post
POST /v1/beneficiaries/create/bank-transfer HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 276
{
"currency": "text",
"country": "text",
"full_name": "text",
"email": "text",
"phone_number": "text",
"description": "text",
"account_number": "text",
"bank_code": "text",
"bank_name": "text",
"account_name": "text",
"street_number": "text",
"street_name": "text",
"city": "text",
"postal_code": "text"
}
200
Success
{
"status": "success",
"message": "text",
"data": {
"id": "text",
"beneficiary_type": "bankAccount",
"currency": "text",
"country": "text",
"full_name": "text",
"email": "text",
"phone_number": "text",
"description": "text",
"account_number": "text",
"account_name": "text",
"bank_name": "text",
"bank_code": "text",
"created_at": "2025-07-06T16:38:48.163Z",
"edited_at": "2025-07-06T16:38:48.163Z"
},
"meta": {},
"errors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"is_error": true
}
Authorizations
Body
currencystring | nullableOptional
countrystring | nullableOptional
full_namestring | nullableOptional
emailstring | nullableOptional
phone_numberstring | nullableOptional
descriptionstring | nullableOptional
merchant_id_or_codestring | nullableOptional
recipient_gateway_codestring | nullableOptional
Responses
200
Success
application/json
post
POST /v1/beneficiaries/create/gateway-transfer HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 174
{
"currency": "text",
"country": "text",
"full_name": "text",
"email": "text",
"phone_number": "text",
"description": "text",
"merchant_id_or_code": "text",
"recipient_gateway_code": "text"
}
200
Success
{
"status": "success",
"message": "text",
"data": {
"id": "text",
"beneficiary_type": "bankAccount",
"currency": "text",
"country": "text",
"full_name": "text",
"email": "text",
"phone_number": "text",
"description": "text",
"account_number": "text",
"account_name": "text",
"bank_name": "text",
"bank_code": "text",
"created_at": "2025-07-06T16:38:48.163Z",
"edited_at": "2025-07-06T16:38:48.163Z"
},
"meta": {},
"errors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"is_error": true
}
Last updated