Overview

The Client Trade API lets a partner hold, move, and convert funds through Axiym accounts owned by its onboarded clients. The partner retains the client relationship and uses one set of credentials, while clientId selects the client that owns the accounts and activity for each operation. Funds enter and leave Axiym through address book entries owned by that client.

The deciding factor is the Axiym account model, not whether your business does work for clients. Use this API when each client should complete Axiym onboarding and own a separate Axiym resource context. Use the Direct Trade API when your organization should own the accounts and operate them in one context, even when the activity supports services for your clients.

Third-party funding and third-party withdrawals are not supported. The owner of the address book entry 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
Address book entry	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 an address book entry 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 an address book entry.

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 address book entry for both directions.

Bank deposits are matched using the reference in the deposit instructions; wallet deposits are matched by the receiving wallet address. Send funds only from an active entry in the client's address book. Withdrawals identify the registered recipient with destinationId.

A typical workflow

Select an active client. Verify that the client's status is ACTIVE and use its clientId throughout the workflow.
Build the client's address book. Add an owned bank account or wallet in the same resource scope and wait until the entry is ACTIVE.
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 address book entry 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. Create and confirm a withdrawal to send funds to an address book entry 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.

Where to continue

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

One client context per workflow

The core model

A typical workflow

Where to continue

On this page