Axiym

Register a Bank Account

Register an external bank account owned by the authenticated partner. Third-party accounts are not allowed. A newly registered account starts in PENDING_REVIEW; after it becomes ACTIVE, it can receive withdrawals. The destination.activated webhook reports this change.

Authorization

Default
AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the X-Request-Id response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Register an owned external bank account as a whitelisted own account. The registered account starts in PENDING_REVIEW.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json