# Schemas

Data models used by the Client Trade API.

Product: Client Trade API
API reference version: 0.3.0 (current)
OpenAPI contract: https://docs.axiym.io/openapi/trade-api/0.3.0.yaml
Canonical page: https://docs.axiym.io/trade-api/api-reference/0.3.0/schemas

[Complete reference with related definitions](/trade-api/api-reference/0.3.0/schemas.full.md)

Fetch individual schemas as needed. Each export preserves the original schema and links to related types.

- [OnboardingRequest](/trade-api/api-reference/0.3.0/schemas/OnboardingRequest.md): Client onboarding request.
- [OnboardingCase](/trade-api/api-reference/0.3.0/schemas/OnboardingCase.md): Snapshot of a client onboarding application. Created in the submitted state and reviewed by Axiym compliance; while the review is in progress the status stays ONBOARDING. Once approved, the client appears in `GET /clients`; a rejected application ends in REJECTED.
- [Client](/trade-api/api-reference/0.3.0/schemas/Client.md)
- [Address](/trade-api/api-reference/0.3.0/schemas/Address.md)
- [DisbursementAccount](/trade-api/api-reference/0.3.0/schemas/DisbursementAccount.md): Bank account at the Payment Network that receives funding disbursements.
- [Currency](/trade-api/api-reference/0.3.0/schemas/Currency.md): Currency code — ISO 4217 (e.g. USD, EUR) or a supported digital currency (USDT, USDC).
- [AccountStatus](/trade-api/api-reference/0.3.0/schemas/AccountStatus.md)
- [Account](/trade-api/api-reference/0.3.0/schemas/Account.md): An account holding a currency balance. Receiving details for funding it are served by the deposit instructions.
- [AccountRef](/trade-api/api-reference/0.3.0/schemas/AccountRef.md): Compact account reference. Fetch the account via `GET /clients/{clientId}/accounts/{accountId}` for the current balance and status; deposit instructions serve its payment details.
- [PaymentRailsCode](/trade-api/api-reference/0.3.0/schemas/PaymentRailsCode.md): Payment rail code the account settles on (e.g. `ZENUS_BANK`, `TRON`).
- [StatementEntryType](/trade-api/api-reference/0.3.0/schemas/StatementEntryType.md): Direction of movement on the account.
- [StatementEntry](/trade-api/api-reference/0.3.0/schemas/StatementEntry.md): A posted ledger movement on an account. Entries are returned in posting order and carry the running balance, so consecutive entries reconcile against each other.
- [ConversionStatus](/trade-api/api-reference/0.3.0/schemas/ConversionStatus.md): `PENDING` awaits confirmation and appears only in the create response. `ACTIVE` is executing. `COMPLETED` means the funds were exchanged. `CANCELED` means the conversion stopped; see `reasonCode`.
- [ConversionPair](/trade-api/api-reference/0.3.0/schemas/ConversionPair.md): An allowed exchange direction. You sell the `sell` side and buy the `buy` side. Use its stable `pairId` to create a conversion; Axiym selects the corresponding accounts.
- [ConversionPairSide](/trade-api/api-reference/0.3.0/schemas/ConversionPairSide.md): One side of a conversion pair.
- [ConversionRequest](/trade-api/api-reference/0.3.0/schemas/ConversionRequest.md): A conversion along one of your conversion pairs. `pairId` selects the accounts on both sides; `sellAmount` is in the pair's sell currency.
- [Conversion](/trade-api/api-reference/0.3.0/schemas/Conversion.md)
- [ConversionEventData](/trade-api/api-reference/0.3.0/schemas/ConversionEventData.md): A compact notification for routing and correlation. Retrieve the conversion from `GET /clients/{clientId}/conversions/{conversionId}` when you need its amounts, rate, or current state.
- [DepositStatus](/trade-api/api-reference/0.3.0/schemas/DepositStatus.md): `PENDING` awaits crediting. `HELD` is temporarily on hold. `COMPLETED` was credited to the account. `CANCELED` or `REJECTED` was not completed; see `reasonCode`.
- [Deposit](/trade-api/api-reference/0.3.0/schemas/Deposit.md)
- [DepositInstruction](/trade-api/api-reference/0.3.0/schemas/DepositInstruction.md): Axiym's receiving details for the account; the shape matches the account type.
- [BankDepositInstruction](/trade-api/api-reference/0.3.0/schemas/BankDepositInstruction.md)
- [WalletDepositInstruction](/trade-api/api-reference/0.3.0/schemas/WalletDepositInstruction.md)
- [DepositEventData](/trade-api/api-reference/0.3.0/schemas/DepositEventData.md): A compact notification for routing and correlation. Retrieve the deposit from `GET /clients/{clientId}/deposits/{depositId}` when you need its amount, transaction hash, or current state.
- [Bank](/trade-api/api-reference/0.3.0/schemas/Bank.md): Destination bank details. Present on bank destinations only. The address country selects the applicable corridor rules.
- [BankAddress](/trade-api/api-reference/0.3.0/schemas/BankAddress.md): Postal address of the bank. Only the country is required — it selects the corridor rules. Supply the rest when the corridor or a correspondent asks for it.
- [CountryCode](/trade-api/api-reference/0.3.0/schemas/CountryCode.md): ISO 3166-1 alpha-2 country code.
- [DestinationStatus](/trade-api/api-reference/0.3.0/schemas/DestinationStatus.md): `PENDING_REVIEW` awaits review. `ACTIVE` may fund deposits and receive withdrawals. `SUSPENDED` is temporarily unavailable. `CLOSED` is permanently retired.
- [AddressBookEntry](/trade-api/api-reference/0.3.0/schemas/AddressBookEntry.md): An address book entry — a registered external bank account or wallet owned by the client. The variant is signaled by its fields: a bank destination carries `accountNumber` and the `bank` block; a wallet destination carries `walletAddress` and `network`. The two sets never appear together.
- [BankAddressBookEntry](/trade-api/api-reference/0.3.0/schemas/BankAddressBookEntry.md)
- [WalletAddressBookEntry](/trade-api/api-reference/0.3.0/schemas/WalletAddressBookEntry.md)
- [Destination](/trade-api/api-reference/0.3.0/schemas/Destination.md): Where the funds are delivered, as recorded on the operation at creation time. This is a snapshot: it carries the account or wallet details and, when the destination was taken from the address book, its `destinationId`. It does not carry the address book entry's status or creation date; read the address book entry for its current state.
- [BankDestination](/trade-api/api-reference/0.3.0/schemas/BankDestination.md)
- [WalletDestination](/trade-api/api-reference/0.3.0/schemas/WalletDestination.md)
- [BankDestinationRequest](/trade-api/api-reference/0.3.0/schemas/BankDestinationRequest.md): Add an owned external bank account to the address book as a permitted deposit source and withdrawal recipient. The entry starts in `PENDING_REVIEW`.
- [WalletDestinationRequest](/trade-api/api-reference/0.3.0/schemas/WalletDestinationRequest.md): Add an owned external wallet to the address book as a permitted deposit source and withdrawal recipient. The entry starts in `PENDING_REVIEW`.
- [PageInfo](/trade-api/api-reference/0.3.0/schemas/PageInfo.md)
- [WithdrawalStatus](/trade-api/api-reference/0.3.0/schemas/WithdrawalStatus.md): `PENDING_CONFIRMATION` is awaiting explicit confirmation and has not started execution. `PENDING` is queued for execution. `HELD` is temporarily on hold — no action needed from you. `COMPLETED` is done. `CANCELED` and `REJECTED` did not complete (see `reasonCode`).
- [Withdrawal](/trade-api/api-reference/0.3.0/schemas/Withdrawal.md)
- [WithdrawalRequest](/trade-api/api-reference/0.3.0/schemas/WithdrawalRequest.md): A withdrawal from `sourceAccountId` to an address book entry. `sourceAmount` is debited from the source account in its currency. The `destinationId` must be `ACTIVE` and use the same currency. Creating the withdrawal returns `PENDING_CONFIRMATION`; call `POST /clients/{clientId}/withdrawals/{withdrawalId}/confirm` to begin execution.
- [SupportingDocumentType](/trade-api/api-reference/0.3.0/schemas/SupportingDocumentType.md): Axiym classification of evidence supplied with a payout.
- [SupportingDocumentInput](/trade-api/api-reference/0.3.0/schemas/SupportingDocumentInput.md): A document supporting the payment, such as an invoice or contract. One item is one file of up to 10 MB in PDF, JPEG or PNG format; supply the file content as base64.
- [SupportingDocument](/trade-api/api-reference/0.3.0/schemas/SupportingDocument.md): Metadata of a document accepted with the payment. File content is not returned.
- [WithdrawalEventData](/trade-api/api-reference/0.3.0/schemas/WithdrawalEventData.md): A compact notification for routing and correlation. Retrieve the withdrawal from `GET /clients/{clientId}/withdrawals/{withdrawalId}` when you need its amount, fees, transaction hash, or current state.
- [AccountMovementEventData](/trade-api/api-reference/0.3.0/schemas/AccountMovementEventData.md): A posted account movement. The event includes the movement amount but not the current balance. Retrieve the account when you need its latest balance.
- [AccountStatusEventData](/trade-api/api-reference/0.3.0/schemas/AccountStatusEventData.md): Account lifecycle notification.
- [DestinationEventData](/trade-api/api-reference/0.3.0/schemas/DestinationEventData.md): Address book entry lifecycle notification. The contract retains the `destinationId` field name and the `destination.*` event names.
- [Event](/trade-api/api-reference/0.3.0/schemas/Event.md): Webhook event envelope delivered to your registered endpoint.
- [Subscription](/trade-api/api-reference/0.3.0/schemas/Subscription.md)
- [RequestStatus](/trade-api/api-reference/0.3.0/schemas/RequestStatus.md)
- [PublicKey](/trade-api/api-reference/0.3.0/schemas/PublicKey.md)
- [Money](/trade-api/api-reference/0.3.0/schemas/Money.md): Monetary amount and its currency.
- [Decimal](/trade-api/api-reference/0.3.0/schemas/Decimal.md): Decimal number serialized as a string to preserve precision. Amounts sent to Axiym are positive and carry at most 8 decimal places.
- [ExternalReference](/trade-api/api-reference/0.3.0/schemas/ExternalReference.md): Your optional identifier for correlating the resource with your system. Axiym returns it on reads. It does not make retries safe; use `Idempotency-Key` for that.
- [ValidationFieldErrors](/trade-api/api-reference/0.3.0/schemas/ValidationFieldErrors.md): Nested validation errors keyed by field name or array index. Leaf values are arrays of `ValidationError` objects.
- [Network](/trade-api/api-reference/0.3.0/schemas/Network.md): Wallet network.
- [ValidationError](/trade-api/api-reference/0.3.0/schemas/ValidationError.md): One field-level validation error.