Getting Started
Use this guide to build and operate a Trade API integration. It assumes you already understand Axiym accounts, registered external accounts, deposits, conversions, withdrawals, and client resources as described in Concepts & Workflows.
Recommended path
1. Prepare access
Complete Access and environments to obtain sandbox credentials, provide your egress addresses, and confirm the Axiym accounts, conversion pairs, and external-account test fixtures available for testing.
2. Onboard the client
Complete Client onboarding.
A client may be onboarded through an API flow or manually with Axiym. In both
cases, wait until Axiym issues an active clientId before starting Trade API
operations.
3. Establish client context
Read Client context. Every
business-resource request uses /clients/{clientId} and every identifier in a
workflow must belong to that client.
4. Understand sandbox testing
Read Sandbox testing before moving funds. It explains which operations use sandbox ledger balances, which blockchain operations can use test networks, and how bank-rail tests differ from real bank payments.
5. Complete the quickstart
Make your first conversion takes you from authentication to a confirmed conversion. It is the shortest way to validate credentials, Axiym account access, permissions, idempotency, and the quote-and-confirm workflow.
6. Implement the workflows you need
| Guide | Use it to |
|---|---|
| Client onboarding | Complete KYB onboarding by API or manually, then retain the active clientId. |
| Register an external account | Register an owned bank account or wallet for use as a deposit source and withdrawal recipient. |
| Deposit funds | Send funds from a registered external account, identify the resulting deposit, and confirm the Axiym account credit. |
| Execute a conversion | Select a permitted pair, create a locked quote, confirm it, and track execution. |
| Withdraw funds | Send funds from an Axiym account to an active registered external account. |
| Reconcile activity | Join API resources to account statement entries and verify period balances. |
Register the external account before testing a deposit or withdrawal. The
workflow sequence always uses the represented client's
/clients/{clientId} paths.
7. Apply the shared conventions
The fundamentals apply across Trade API operations:
- Authentication
- Common Headers
- Idempotency
- Pagination and List Filters
- Error Handling and Retries
- Rate Limits
- Data Formats and Constants
- Payment Rails
- Blockchain Networks
Definition of a production-ready integration
Before moving production funds, your integration should be able to:
- obtain and refresh access tokens without exposing client secrets;
- attach request IDs and idempotency keys correctly;
- preserve
clientIdwith every client-owned resource; - track client onboarding and client availability through polling or webhooks;
- handle asynchronous deposit, conversion, registered external-account, and withdrawal states;
- distinguish simulated sandbox bank activity from real external settlement;
- retry only requests that are safe to retry;
- follow cursor pagination until
hasNextPageis false; and - reconcile completed operations against Axiym account statements.