Withdrawing funds
A withdrawal moves funds from an Axiym account to a registered external account. The Axiym account supplies the balance, and the registered external bank account or wallet receives the outgoing payment.
Unlike a deposit, a withdrawal is initiated through the Trade API. Creating the withdrawal submits it for execution; there is no separate confirmation step.
Third-party withdrawals are not supported.
The three parts of a withdrawal
| Part | Role |
|---|---|
| Source Axiym account | Holds the balance from which funds are withdrawn. Identified by sourceAccountId. |
| Registered external account | The owned bank account or wallet that receives the payment. Identified by destinationId. |
| Withdrawal | The outgoing payment record created and tracked through the Trade API. Identified by withdrawalId. |
These resources must belong to the same represented client. The source Axiym account and registered external account must also use the same currency.
Before creating a withdrawal
Confirm that:
- the external bank account or wallet is registered in the correct partner or same client;
- the registered external account is
ACTIVE; - its currency matches the source Axiym account;
- a wallet uses the intended blockchain network; and
- the source Axiym account is active and has sufficient balance for the withdrawal and reported fee.
Registering an external account does not move funds. It creates the reusable
record referenced by destinationId.
Creating a withdrawal
Create the withdrawal using sourceAccountId, destinationId, and the amount
to send. Use an idempotency key so the request can be retried safely without
creating another withdrawal.
For example, a USD withdrawal must use a USD Axiym account and an active USD external bank account. A USDT withdrawal must use a USDT Axiym account and an active USDT external wallet on the configured network.
The response contains the new withdrawalId, current status, amount, fee, and
the registered external-account details used for that payment. The embedded
details record where the specific withdrawal was instructed to go;
destinationId remains the reusable reference to the registered account.
Withdrawal lifecycle
Do not infer the next status from the current one. A withdrawal may be held for review before it continues. Use webhook events or retrieve the withdrawal again to observe changes.
| Status | Meaning |
|---|---|
PENDING | The withdrawal was accepted and is awaiting execution. |
HELD | Processing is paused for review or another operational check. Continue monitoring the withdrawal for a later status change. |
COMPLETED | The outgoing payment completed. |
CANCELED | The withdrawal was canceled before completion. |
REJECTED | The withdrawal was rejected and did not complete. |
A canceled or rejected withdrawal can include a reasonCode. A completed
wallet withdrawal can include a blockchain transactionHash.
Withdrawal record and account balance
The withdrawal represents the outgoing payment and its processing status. The source Axiym account represents the balance held with Axiym.
Use externalReference to associate the withdrawal with your own payment,
invoice, or treasury record. The withdrawal also receives an Axiym-generated
payment code.
Use the withdrawal for the business status, amount, fee, and payment details. Use the source Axiym account statement to reconcile the posted debit and running balance.
Withdrawal checklist
- Confirm that the receiving bank account or wallet is registered and active in the same represented client.
- Select the source Axiym account and confirm that its currency matches the registered external account.
- Confirm that the source account is active and has sufficient balance.
- Create the withdrawal using
sourceAccountId,destinationId, the amount, and an idempotency key. - Store the returned
withdrawalIdandexternalReferencewhere supplied. - Wait for the withdrawal to reach a terminal status.
- Reconcile a completed withdrawal with the source Axiym account statement.
Common mistakes
- Withdrawing to a third-party bank account or wallet.
- Passing an
accountId, bank account number, or raw wallet address asdestinationId. - Attempting a withdrawal while the registered external account is pending review, suspended, or closed.
- Using a registered external account whose currency differs from the source Axiym account.
- Mixing identifiers from different clients.
- Retrying withdrawal creation without the original idempotency key.
The Idempotency guide explains how to retry funds-moving requests safely.