Create Beneficiary

POST /beneficiary

Creates a new beneficiary for the authenticated account.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

name

string

Full Name

type

boolean

0 = Personal, 1 = Business

addressLine1

string

Address Line 1

addressLine2

string

Address Line 1

country

string

ISO2 Code for Country

city

string

City

postalCode

string

Postal Code

iban

string

iBan Number

bic

string

BIC Number

Response

{
    "statusCode": 201,
    "statusMessage": "Resource was created",
    "payload": {
        "id": "9361b0f7-8c8a-486f-bc53-cfda39acbc98",
        "name": "Beneficiary Name",
        "type" : 0,
        "addressLine1": "Address Line 1", 
        "addressLine2": "Address Line 2",
        "country": "Country ISO Code",
        "city": "City",
        "postalCode": "XXXXXX",
        "iban": "...",
        "bic": "...",
        "traceId": "gdlyfx1kn79mm0e66an",
    }
}

Last updated