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

Create a bank beneficiary for bank transfers

POST/v1/beneficiaries/create/bank-transfer

Body

currencynullable string

countrynullable string

full_namenullable string

emailnullable string

phone_numbernullable string

descriptionnullable string

account_numbernullable string

bank_codenullable string

bank_namenullable string

account_namenullable string

street_numbernullable string

street_namenullable string

citynullable string

postal_codenullable string

Response

Success

Body

statusApiStatusResponse (enum)

successerror

messagenullable string

dataViewBankBeneficiaryDto (object)

metaNoMeta (object)

errorsnullable object

is_errorboolean

Request

const response = await fetch('/v1/beneficiaries/create/bank-transfer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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": "2024-11-16T16:50:37.275Z",
    "edited_at": "2024-11-16T16:50:37.275Z"
  },
  "is_error": false
}