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.)

PreviousBeneficiaries NextList all beneficiaries

Last updated 3 months ago

Create a bank beneficiary for bank transfers

post

/v1/beneficiaries/create/bank-transfer

Authorizations

Body

currencystring | nullable

countrystring | nullable

full_namestring | nullable

emailstring | nullable

phone_numberstring | nullable

descriptionstring | nullable

account_numberstring | nullable

bank_codestring | nullable

bank_namestring | nullable

account_namestring | nullable

street_numberstring | nullable

street_namestring | nullable

citystring | nullable

postal_codestring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/beneficiaries/create/bank-transfer' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

200

{
  "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-02-20T19:22:56.368Z",
    "edited_at": "2025-02-20T19:22:56.368Z"
  },
  "meta": {},
  "is_error": true,
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Success