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.

capabilities?array<string>
pricing?object | null
percentage_fee?number | null

Must be at least 0. Must not be greater than 100.

fixed_fee?number | null

Must be at least 0.

max_fee?number | null

Must be at least 0.

min_fee?number | null

Must be at least 0.

currency?string | null

This field is required when <code>pricing.type</code> is <code>fixed</code>. This field is required when <code>pricing.fixed_fee</code>, <code>pricing.min_fee</code>, or <code>pricing.max_fee</code> is present. Must be 3 characters.

callback?string | null

Must be a valid URL. Must not be greater than 2048 characters.

payment_status?"active" | "suspended"
"active""suspended"

Response Body

application/json

application/json

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