Axiym

Add a wallet address

Adds an external wallet owned by the selected client to the client's address book. Partner-owned and third-party wallets are not allowed. The wallet 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.

View MarkdownView complete reference

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 Client 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

Add an owned external wallet 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 wallet.

walletAddress*string

Wallet address to register as an external account.

network*Network

Network of the wallet address.

Allowed values

  • "TRON"
  • "AVALANCHE"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json