Registered external accounts
A registered external account is a bank account or wallet outside Axiym that belongs to the represented client whose resources you are operating—and has been registered with Axiym.
It establishes the approved external boundary for moving money:
- deposits must originate from a registered external account; and
- withdrawals can be sent only to a registered external account.
Third-party accounts are not supported in either direction.
The two external-account nodes represent the same registered resource type; a
registered account can be used in either direction. An external account does
not hold an Axiym balance. The corresponding Axiym account is the
balance-holding resource identified by accountId.
Ownership follows the client
The client selected by /clients/{clientId} must own the registered account
and every Axiym resource it interacts with. An account belonging to one client
cannot fund or receive withdrawals for another client.
API terminology
The API contract calls this resource a whitelisted own account:
| Concept | API representation |
|---|---|
| Registered external account | A resource under /whitelisted-own-accounts. |
| Registered client external account | A resource under /clients/{clientId}/whitelisted-own-accounts. |
| External-account identifier | destinationId. |
The name destinationId reflects how the identifier is supplied when creating
a withdrawal. It identifies the registered external-account record even
though that account also establishes the permitted origin of deposits.
Register before moving funds
Registration creates a reusable record of the owned bank account or wallet. It does not itself move money.
Register the external account before initiating a deposit or withdrawal. Do not use a record that is pending review, suspended, or closed.
Account types
External bank account
Identified by its currency, account number, SWIFT/BIC, and bank name. A deposit must be sent from this account, and a withdrawal can return funds to it.
External wallet
Identified by its currency, wallet address, and blockchain network. A wallet deposit must originate from this wallet on the specified network, and a withdrawal can send funds back to it.
Account lifecycle
| Status | Meaning |
|---|---|
PENDING_REVIEW | Axiym is reviewing the registered account details. |
ACTIVE | The external account is available for supported deposits and withdrawals. |
SUSPENDED | The external account is temporarily unavailable. |
CLOSED | The external account has been permanently retired. |
Use destination.* webhook events or retrieve the registered record to observe
status changes.
How deposits use the registered account
The registered external account identifies where the incoming funds are allowed to come from. Deposit instructions identify where those funds must be sent to credit a particular Axiym account.
For a bank deposit, initiate the transfer from the registered bank account and include the reference returned in the deposit instructions. For a wallet deposit, send from the registered wallet to the returned wallet address over the specified network.
You do not create the deposit through the Trade API. Axiym detects the incoming payment and exposes the resulting deposit for tracking and reconciliation.
How withdrawals use the registered account
When creating a withdrawal, pass the registered account's destinationId.
The account must be active, belong to the same client as the source
Axiym account, and use the same currency.
Do not pass a bank account number, wallet address, or Axiym accountId in
place of destinationId.
Common mistakes
- Sending a deposit from an account or wallet that has not been registered.
- Registering an account owned by another person or organization.
- Mixing partner and client resource scopes.
- Using an external account before it becomes active.
- Sending a wallet payment over a different blockchain network.
- Treating
destinationIdas an AxiymaccountId.
Continue with Depositing Funds to learn how incoming payments are credited, or Withdrawing Funds to learn how funds leave Axiym.