Skip to content
Authorization<token>

Use a public key (pk./pk_test.) for payment initialization. Use a secret key (sk./sk_test.) for sensitive operations (transfers, refunds, balance), or a restricted key (rk./rk_test.) scoped to specific permissions. The _test. variant of any key selects the sandbox environment — there is no separate sandbox URL. Never expose your secret key in client-side code.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Must not be greater than 255 characters.

email?string | null

Must be a valid email address. Must not be greater than 255 characters.

phone?string | null

Must not be greater than 32 characters.

country_code?string | null

Must be 2 characters.

metadata?object | null

Response Body

application/json

application/json

curl -X PUT "https://example.com/beneficiaries/architecto" \  -H "Content-Type: application/json" \  -d '{}'
PUT
/beneficiaries/{id}
{
  "code": 200,
  "beneficiary": {
    "id": "bfn_01JXXX"
  }
}
{
  "code": 404
}