Skip to main content

Create a new beneficiary

POST 
/beneficiaries

Create a new beneficiary with bank account details

Request​

Body

required

Beneficiary details

    email emailnullable

    Email address of the beneficiary

    bank_name stringrequired

    Possible values: >= 3 characters

    Name of the bank

    bank_code stringrequired

    Bank code identifier

    account_number stringrequired

    Bank account number

    name stringrequired

    Possible values: >= 3 characters

    Full name of the beneficiary

    beneficiary_type stringrequired

    Possible values: [I, B]

    Type of beneficiary (I for Individual, B for Business)

    business_name stringnullable

    Possible values: >= 3 characters

    Name of the business (required if beneficiary_type is B)

    contact_name stringnullable

    Possible values: >= 3 characters

    Name of the contact person

    contact_email emailnullable

    Email of the contact person

    contact_phone stringnullable

    Phone number of the contact person

Responses​

Beneficiary created successfully

Schema
    account_number string
    bank_name string
    bank_code string
    name string
    email email
    updated_at date-time
    created_at date-time
    id integer
Loading...