Withdrawing funds
A withdrawal moves funds from your organization's Axiym account to a whitelisted external account: a bank account or wallet that receives the outgoing payment.
Unlike a deposit, a withdrawal is initiated through the Account API. It
uses a two-step create-and-confirm flow: creation returns a
PENDING_CONFIRMATION withdrawal, and confirmation begins execution.
The three parts of a withdrawal
| Part | Role |
|---|---|
| Source Axiym account | Holds the balance from which funds are withdrawn. Identified by sourceAccountId. |
| External account | The whitelisted bank account or wallet that receives the payment. Identified by destinationId. |
| Withdrawal | The outgoing payment record created and tracked through the Account API. Identified by withdrawalId. |
The source Axiym account and external account must use the same currency.
Where funds can go
The receiving bank account or wallet must be whitelisted in your address book
and ACTIVE. Its currency must match the source Axiym account; wallet
withdrawals must also use the configured blockchain network.
The source Axiym account must be active and have enough funds to cover the withdrawal amount.
For example, a USD withdrawal sends funds from a USD Axiym account to a whitelisted USD bank account. A USDT withdrawal sends funds to a whitelisted USDT wallet on the configured network.
Create, review, and confirm
Creating a withdrawal prepares the payment for review. It records the source
account, receiving bank account or wallet, amount, and fee, and has status
PENDING_CONFIRMATION. Execution has not begun.
Review these details before confirming. Confirmation accepts the prepared
withdrawal and starts processing, with status PENDING.
Some destinations require supporting documents. Supply these when creating the withdrawal.
Amount and fee
The fee is deducted from the withdrawal amount. The recipient receives the remaining amount in the same currency. Both amounts and the fee are returned for review before confirmation.
Withdrawal lifecycle
Do not infer the next status from the current one. Use webhook events or retrieve the withdrawal again to observe changes.
| Status | Meaning |
|---|---|
PENDING_CONFIRMATION | The withdrawal was created and awaits explicit confirmation. Execution has not begun. |
PENDING | The withdrawal was accepted and is awaiting execution. |
HELD | Processing is temporarily on hold. 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.
The withdrawal keeps the external account details used for that payment, providing a record of where it was instructed to go.
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.
For request examples, confirmation, and safe retries, follow the Withdraw funds integration guide.