Depositing funds

A deposit moves funds from a registered external account into an Axiym account. The external bank account or wallet and the receiving Axiym account must belong to the same represented client.

You do not create a deposit with an API request. You retrieve deposit instructions for the intended Axiym account, send the payment outside the Trade API, and then use the API to track the incoming payment detected by Axiym.

The three parts of a deposit

Part	Role
Registered external account	The owned bank account or wallet from which the payment is permitted to originate.
Deposit instructions	The receiving details to which the payment must be sent to credit a specific Axiym account.
Deposit	The incoming payment record created after Axiym detects the payment.

The registered external account answers where may the payment come from. The deposit instructions answer where must it be sent.

Before sending funds

Confirm that the sending external account is registered and active in the represented client.
Select the Axiym account whose currency and payment rail match the payment you intend to send.
Retrieve the current deposit instructions for that Axiym account.

Do not send a payment from an unregistered or third-party account. Do not reuse deposit instructions from another Axiym account, resource scope, or environment.

Deposit instructions

Deposit instructions depend on the Axiym account's payment rail.

Bank deposit

Bank instructions contain the receiving beneficiary name, account number, bank name, SWIFT/BIC, and a reference assigned to the Axiym account.

Initiate the transfer from the registered external bank account and include the supplied reference. Axiym uses the reference to match the incoming payment to the intended account. Formatting spaces in the reference do not affect matching.

Wallet deposit

Wallet instructions contain a walletAddress and network. Send from the registered external wallet using only the Axiym account's currency and the specified network.

The receiving wallet address is used to associate the incoming payment with the Axiym account.

Deposit lifecycle

After Axiym detects the incoming payment, it appears as a deposit. The Axiym account is credited only when processing completes.

Do not infer the next status from the current one. Use webhook events or retrieve the deposit again to observe changes.

Status	Meaning
`PENDING`	The payment was detected and is awaiting crediting.
`HELD`	Processing is paused for review or another operational check. Continue monitoring the deposit for a later status change.
`COMPLETED`	The payment completed and the Axiym account was credited.
`CANCELED`	The deposit did not complete.
`REJECTED`	The deposit was rejected.

A canceled or rejected deposit can include a reasonCode. A completed wallet deposit can include the network transaction hash.

Deposit record and account balance

The deposit represents the incoming payment and its processing status. The Axiym account represents the resulting balance held with Axiym.

A completed deposit tells you the credited account, amount, fee, currency, and available sender or network information. Depending on the rail, it can also include:

remitterName, as reported by the sending bank or network;
an Axiym payment code; or
a blockchain transactionHash.

Use the deposit for the business status of the incoming payment. Use the account statement for the corresponding posted credit and running balance.

Deposit checklist

Confirm that the sending bank account or wallet is registered and active in the same represented client.
Select the intended Axiym account by accountId and confirm its currency and payment rail.
Retrieve the deposit instructions for that account.
Send the correct currency from the registered external account using the returned receiving details and network.
Include the returned reference on a bank transfer.
Wait for the deposit to become COMPLETED before relying on the credited funds.
Reconcile the deposit with the Axiym account statement.