Create beneficiary

POST

/customers/v1/beneficiaries

The standard beneficiary creation endpoint. You must provide either person OR company details, but not both.

Request

Body Params application/json

Examples

with company detailswith person details

{
    "account_number": "123456789",
    "bank_code": "062000",
    "bank_code_type": "BSB",
    "bank_country": "AUS",
    "bank_name": "Commonwealth Bank",
    "company": {
        "name": "Acme Corporation Pty Ltd"
    },
    "metadata": {}
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

with company detailswith person details

curl --location --request POST '/customers/v1/beneficiaries' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account_number": "123456789",
    "bank_code": "062000",
    "bank_code_type": "BSB",
    "bank_country": "AUS",
    "bank_name": "Commonwealth Bank",
    "company": {
        "name": "Acme Corporation Pty Ltd"
    },
    "metadata": {}
}'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "e232ba4c-9322-4fac-8aa5-ceaf9a1c1c44",
    "account_number": "123456789",
    "bank_code": "062000",
    "bank_code_type": "BSB",
    "bank_country": "AUS",
    "bank_name": "Commonwealth Bank",
    "pay_id": null,
    "pay_id_type": null,
    "pay_id_name": null,
    "pay_id_status": null,
    "pay_id_registered_at": null,
    "created_at": "2026-01-21T06:08:25.452Z",
    "updated_at": "2026-01-21T06:08:25.452Z",
    "status": "ACTIVE",
    "person": null,
    "company": {
        "name": "Acme Corporation Pty Ltd"
    },
    "metadata": {}
}

Modified at 2026-01-21 06:32:01

Get beneficiary by ID

Update beneficiary