Overview

The Trade API lets a partner hold, move, and convert funds on behalf of onboarded clients. The partner retains the client relationship; the client's Trade accounts and activity are operated through its clientId. Funds enter and leave Axiym through registered external accounts owned by the client whose funds you operate.

Third-party funding and third-party withdrawals are not supported. The owner of the registered external account must be the same as the owner of the Axiym account.

One client context per workflow

The partner access token identifies your partnership. Every business operation uses /clients/{clientId} paths, where clientId identifies the client that owns the accounts and activity.

Resources belonging to different clients cannot be combined. Webhook subscriptions belong to the partnership and use event clientId values to route client-owned activity.

The core model

The API is organized around six connected resources.

Resource	What it represents
Registered external account	A bank account or wallet owned by the represented client and registered with Axiym. It is the permitted source of deposits and recipient of withdrawals.
Axiym account	A balance with Axiym in one currency, connected to a specific payment rail.
Deposit	An incoming payment from a registered external account that credits an Axiym account.
Conversion pair	Permission to sell one currency and buy another over specified payment rails, in one direction.
Conversion	An exchange that debits the sell-side Axiym account and credits the buy-side Axiym account resolved by a conversion pair.
Withdrawal	An outgoing payment from an Axiym account to a registered external account.

An Axiym account is the center of the balance model. Deposits increase its balance, withdrawals decrease it, and conversions move value between Axiym accounts.

The external account at the start and end represents the same type of registered resource. A workflow does not have to include a conversion, and it does not have to use every registered external account for both directions.

How money enters Axiym

Register the external bank account or wallet before funding an Axiym account. The incoming payment must originate from that registered account.

Deposit instructions then tell you where to send the payment so that Axiym can credit the intended Axiym account:

for a bank payment, they contain the receiving bank details and payment reference;
for a blockchain payment, they contain the receiving wallet address and network.

The registered external account and the deposit instructions therefore answer different questions: where may the payment come from, and where must it be sent.

How money leaves Axiym

A withdrawal sends funds from an Axiym account to a registered external account in the same resource scope. The API identifies that external account with destinationId when you create the withdrawal.

Despite the identifier name, the registered account is not only a withdrawal destination. It is the same external-account concept used to establish the permitted origin of deposits.

A typical workflow

Select the client. Use the represented client's clientId throughout the workflow.
Register an external account. Register an owned bank account or wallet in the same resource scope and wait for Axiym's review.
Find the Axiym accounts. Identify the account for each currency you plan to hold or move.
Fund an Axiym account. Retrieve its deposit instructions and send funds from the registered external account using the specified details.
Wait for the deposit. Wait until the deposit completes and the Axiym account is credited.
Convert funds if needed. Select a permitted conversion pair, create a conversion to lock the rate, and confirm it before the quote expires.
Withdraw funds. Use destinationId to send funds to a registered external account in the same scope and currency.
Reconcile activity. Use deposits, conversions, withdrawals, and account statements to reconcile the resulting balance movements.

Not every integration needs every step. For example, you can deposit and withdraw without converting when the incoming and outgoing currency is the same.

Understand these distinctions

An Axiym account holds a balance

An Axiym account is identified by accountId. It is not an external bank account number or wallet address.

A registered external account establishes ownership

It identifies an owned bank account or wallet that may send funds into Axiym and receive funds from Axiym. Third-party accounts cannot be used.

Deposit instructions identify the receiving details

They tell you where to send a bank or blockchain payment to credit a specific Axiym account. They do not replace registration of the external account from which the payment originates.

A conversion pair is a permission

A conversion pair identifies the permitted sell-to-buy direction and payment rails. Its pairId resolves the corresponding Axiym accounts when you create a conversion.

Direction matters

USD to USDT and USDT to USD are different conversion permissions with different pairId values. Access to one direction does not imply access to the reverse direction.

Where to continue

When you understand the model, use the Integration Guide to set up credentials and make your first sandbox requests.