Update beneficiary

PATCH

/customers/v1/beneficiaries/{id}

Send status and/or metadata to update them. Returns the full updated beneficiary.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "status": "INACTIVE",
    "metadata": {}
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/customers/v1/beneficiaries/' \
--header 'x-client-id;' \
--header 'Content-Type: application/json' \
--data '{
    "status": "INACTIVE",
    "metadata": {}
}'

Responses

🟢200OK

application/json

The updated beneficiary.

Bodyapplication/json

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "account_number": "string",
    "bank_code": "string",
    "bank_code_type": "BSB",
    "bank_country": "string",
    "bank_name": "string",
    "pay_id": "string",
    "pay_id_type": "EMAIL",
    "pay_id_name": "string",
    "pay_id_status": "ENABLED",
    "pay_id_registered_at": "2019-08-24T14:15:22.123Z",
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z",
    "status": "ACTIVE",
    "person": {
        "name": "string"
    },
    "company": {
        "name": "string"
    },
    "metadata": {
        "property1": "string",
        "property2": "string"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2026-08-05 04:06:25

Create Payid beneficiary

Cards API