Axiym

Add a bank account

Adds an external bank account you own to the address book. Third-party accounts are not allowed. The account starts in PENDING_REVIEW. After it becomes ACTIVE, it may fund your deposits and receive your withdrawals. The destination.activated webhook reports this change.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid
Idempotency-Key*string

A unique key that makes a funds-moving request safe to retry. Reusing the key returns the original result instead of creating a duplicate. A UUID is recommended.

Lengthlength <= 255

Request Body

application/json

Add an owned external bank account to the address book as a permitted deposit source and withdrawal recipient. The entry starts in PENDING_REVIEW.

currency*Currency

Currency associated with the external bank account.

accountNumber*string

Bank account number.

bank*Bank

Destination bank details.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json