Axiym

Create a Withdrawal

Create an outgoing payment from sourceAccountId. destinationId selects one of your registered whitelisted own accounts. It must be ACTIVE and in the source account's currency — an unknown destination or a whitelisted own account in any other status rejects the request. The response embeds the resolved whitelisted own account in full.

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
Idempotency-Key*string

Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

An outgoing payment from sourceAccountId. amount is in the source account's currency. destinationId references one of your whitelisted own accounts; it must be ACTIVE and in the source Axiym account's currency.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json