Axiym

Register bank account

Registers an external bank account owned by the selected client. Partner-owned and third-party accounts are not allowed. The account starts in PENDING_REVIEW. After it becomes ACTIVE, it may fund the client's deposits and receive the client's withdrawals. The destination.activated webhook reports this change.

Authorization

Default
AuthorizationBearer <token>

In: header

Path Parameters

clientId*string

Client identifier (UUID) assigned when an onboarding case is created. It identifies the onboarding case and, once active, the client's Trade API resources. The client must belong to your partnership; anyone else's id returns 404.

Formatuuid

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

TypeScript Definitions

Use the request body type in TypeScript.

Register an owned external bank account as a permitted deposit source and withdrawal recipient. The registered account starts in PENDING_REVIEW.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json