Terminology
Use this glossary when a Client Account API field or resource name is unfamiliar.
| Term | Meaning |
|---|
| Axiym account | A balance held with Axiym in one currency and connected to one payment rail. The API refers to this resource as an account. |
accountId | The UUID identifying an Axiym account. It is not a bank account number or wallet address. |
| Axiym account statement | Opening and closing balances, credit and debit totals, and posted ledger movements for one Axiym account and period. |
| Client | A legal entity associated with your partnership that remains your customer. Its record may be onboarding, active, or disabled; only ACTIVE clients can perform Client Account API business operations. |
clientId | The Axiym-issued identifier for a client and its onboarding case. |
| Conversion | A currency-exchange record between two Axiym accounts. Creation locks a quote; confirmation begins execution. |
conversionId | The UUID identifying one conversion and its lifecycle. |
| Conversion pair | Permission to sell one currency and buy another over specified payment rails, in one direction and subject to a minimum sell amount. |
pairId | The unique identifier of a permitted conversion pair. |
| Deposit | An incoming payment from a whitelisted external account detected by Axiym. A completed deposit credits an Axiym account. |
depositId | The UUID identifying one incoming deposit and its lifecycle. |
| Deposit instructions | The receiving bank details or wallet address to which a payment must be sent to credit a specific Axiym account. |
| External account | A bank account or wallet outside Axiym, registered for review and whitelisting before use. |
| Address book entry | The record of an external account, including its registration details and review status. |
| Address book | The collection of external account records registered for a client. |
| Destination | The role an external account plays as the recipient of a withdrawal. It is not a separate account type. |
destinationId | The unique identifier of an external account’s address book record. |
| Withdrawal | An outgoing payment from an Axiym account to an active, whitelisted external account. |
withdrawalId | The UUID identifying one withdrawal and its lifecycle. |
| Term | Meaning |
|---|
| Balance | The amount currently available in an Axiym account. |
| Currency | An ISO 4217 currency such as USD or EUR, or a supported digital currency such as USDT or USDC. |
| External reference | Your identifier for correlating an Axiym conversion or withdrawal with a record in your system. |
| Fee amount | The fee Axiym reports for a deposit, conversion, or withdrawal. |
| Locked rate | The conversion rate returned when a conversion is created and available for acceptance for a limited time. |
| Payment rail | The bank rail or blockchain network associated with an Axiym account or payment, such as ZENUS_BANK or TRON. |
| Sell side | The currency and payment rail from which value is sold in a conversion. |
| Buy side | The currency and payment rail into which value is bought in a conversion. |
sellAccount | The Axiym account from which a conversion debits the sold funds. |
sellAmount | The amount sold, expressed in the conversion pair's sell currency. |
buyAccount | The Axiym account to which a conversion credits the bought funds. |
buyAmount | The amount bought and credited, expressed in the conversion pair's buy currency and net of the fee. |
| Rate | For a conversion, the units of buy currency received per one unit of sell currency. |
| Source account | For a withdrawal, the Axiym account from which funds are debited. Identified by sourceAccountId. |
| Term | Meaning |
|---|
| Idempotency key | A unique value supplied on a funds-moving request so the same request can be retried without creating a duplicate operation. |
| Partner context | The authenticated partner integration. It owns OAuth credentials and webhook subscriptions. |
| Client context | The represented client selected by clientId. It owns accounts, address book entries, deposits, conversions, withdrawals, and statements. |
| Event | A notification record that a Client Account API resource changed. It is a signal, not the authoritative current resource. |
| Webhook | The HTTPS delivery used to send an event from Axiym to your system. |
| Webhook subscription | The registration that identifies the HTTPS endpoint to which Axiym sends events. |
| Request ID | An identifier used to trace an API request when troubleshooting. |
| Sandbox | The isolated test environment used to build and validate an integration without moving production funds. |
| Status | Used by | Meaning |
|---|
PENDING_REVIEW | Address book entries | Registered and awaiting Axiym due diligence and compliance checks. |
ONBOARDING | Clients, onboarding cases | The client is undergoing KYB review and cannot yet perform Client Account API business operations. |
APPROVED | Onboarding cases | The onboarding application has been approved. |
DISABLED | Clients | The client cannot perform Client Account API business operations. |
ACTIVE | Clients, Axiym accounts, address book entries, conversions | Available for use; an external account has passed review and is whitelisted. For a conversion, execution is in progress. |
PENDING_CONFIRMATION | Withdrawals | Created and awaiting explicit confirmation; execution has not begun. |
PENDING | Deposits, conversions, withdrawals | Detected or in progress but not yet completed. A conversion specifically awaits confirmation; a confirmed withdrawal is awaiting execution. |
HELD | Deposits, withdrawals | Temporarily on hold while Axiym continues processing. |
COMPLETED | Deposits, conversions, withdrawals | Processing and the corresponding money movement completed. |
SUSPENDED | Axiym accounts, address book entries | Temporarily unavailable for use. |
CANCELED | Deposits, conversions, withdrawals | Processing ended without completion. A reasonCode can provide more context. |
REJECTED | Onboarding cases, deposits, withdrawals | The onboarding application or payment was rejected. A deposit or withdrawal can include reasonCode. |
CLOSED | Axiym accounts, address book entries | Permanently retired. |
Status words can have resource-specific behavior. Refer to the relevant
concept page for the complete lifecycle:
