# Depositing funds

Product: Client Account API
Guides follow API reference 0.3.0 and event reference 0.2.0.
Canonical page: https://docs.sandbox.axiym.io/client-account-api/concepts/depositing-funds

A deposit transfers funds from a
[whitelisted external account](/client-account-api/concepts/address-book)
to a client's Axiym account. The sending external account must be whitelisted
in that client's address book.

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

## The three parts of a deposit

| Part                 | Role                                                                                        |
| -------------------- | ------------------------------------------------------------------------------------------- |
| External account     | The whitelisted 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 whitelisted external account answers **where may the payment come from**.
The deposit instructions answer **where must it be sent**.



```mermaid
sequenceDiagram
  participant Integration as Your integration
  participant Sender as External account
  participant Trade as Client Account API
  participant Network as Bank or network

  Integration->>Trade: Request deposit instructions
  Trade-->>Integration: Return receiving details
  Sender->>Network: Send funds using the instructions
  Network->>Trade: Deliver the incoming payment
  Trade-->>Integration: Send deposit webhook event
  Integration->>Trade: Fetch current deposit when needed
  Trade-->>Integration: Return the deposit
```



## Before sending funds

1. Confirm that the sending bank account or wallet is whitelisted in the client’s
   address book and `ACTIVE`. Axiym performs due diligence and compliance
   checks before activation.
2. Select the Axiym account whose currency and payment rail match the payment
   you intend to send.
3. Retrieve the current deposit instructions for that Axiym account.

Send funds only from an `ACTIVE`, whitelisted external account. Do not reuse
deposit instructions from another Axiym account, client, or environment.

## Deposit instructions

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

Bank deposit

Bank instructions identify the receiving beneficiary and bank account.
When they include a payment reference, it helps match the incoming
transfer to the intended Axiym account.

Send from the whitelisted bank account using the supplied receiving
details, including the reference when one is provided.

Wallet deposit

Wallet instructions identify the receiving wallet address and blockchain
network. Send from the whitelisted wallet using the specified currency
and network.

The receiving address links the incoming payment to 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 temporarily on hold. 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 records the credited account, amount, currency, and any
fee, together with available sender or network information.

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

For requests, transfer details, and tracking, follow the
[Deposit funds integration guide](/client-account-api/integration-guide/deposit-funds).