# Schemas

Data models used by the Account API.

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

[Complete reference with related definitions](/account-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.

- [Currency](/account-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](/account-api/api-reference/0.3.0/schemas/AccountStatus.md)
- [Account](/account-api/api-reference/0.3.0/schemas/Account.md): An account holding a currency balance.
- [PaymentRailsCode](/account-api/api-reference/0.3.0/schemas/PaymentRailsCode.md): Payment rail code the account settles on (e.g. `ZENUS_BANK`, `TRON`).
- [AccountRef](/account-api/api-reference/0.3.0/schemas/AccountRef.md): Compact account reference. Fetch the account via `GET /accounts/{accountId}` for the current balance and status; deposit instructions serve its payment details.
- [StatementEntryType](/account-api/api-reference/0.3.0/schemas/StatementEntryType.md): Direction of movement on the account.
- [StatementEntry](/account-api/api-reference/0.3.0/schemas/StatementEntry.md): A posted ledger movement on an account.
- [Bank](/account-api/api-reference/0.3.0/schemas/Bank.md): Destination bank details. Present on bank destinations only.
- [BankAddress](/account-api/api-reference/0.3.0/schemas/BankAddress.md): Postal address of the destination bank.
- [CountryCode](/account-api/api-reference/0.3.0/schemas/CountryCode.md): ISO 3166-1 alpha-2 country code.
- [DepositStatus](/account-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](/account-api/api-reference/0.3.0/schemas/Deposit.md)
- [DepositInstruction](/account-api/api-reference/0.3.0/schemas/DepositInstruction.md): Axiym's receiving details for the account; the shape matches the account type.
- [BankDepositInstruction](/account-api/api-reference/0.3.0/schemas/BankDepositInstruction.md)
- [WalletDepositInstruction](/account-api/api-reference/0.3.0/schemas/WalletDepositInstruction.md)
- [DepositEventData](/account-api/api-reference/0.3.0/schemas/DepositEventData.md): A compact notification for routing and correlation. Retrieve the deposit from `GET /deposits/{depositId}` when you need its amount, transaction hash, or current state.
- [DestinationStatus](/account-api/api-reference/0.3.0/schemas/DestinationStatus.md): - `PENDING_REVIEW` — awaiting review.
- [AddressBookEntry](/account-api/api-reference/0.3.0/schemas/AddressBookEntry.md): A registered external bank account or wallet address in the address book, with its status and creation date.
- [BankAddressBookEntry](/account-api/api-reference/0.3.0/schemas/BankAddressBookEntry.md)
- [WalletAddressBookEntry](/account-api/api-reference/0.3.0/schemas/WalletAddressBookEntry.md)
- [Destination](/account-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](/account-api/api-reference/0.3.0/schemas/BankDestination.md)
- [WalletDestination](/account-api/api-reference/0.3.0/schemas/WalletDestination.md)
- [PageInfo](/account-api/api-reference/0.3.0/schemas/PageInfo.md)
- [WithdrawalStatus](/account-api/api-reference/0.3.0/schemas/WithdrawalStatus.md): - `PENDING_CONFIRMATION` — created and awaiting confirmation.
- [Withdrawal](/account-api/api-reference/0.3.0/schemas/Withdrawal.md)
- [WithdrawalRequest](/account-api/api-reference/0.3.0/schemas/WithdrawalRequest.md): An outgoing payment from `sourceAccountId` to `destinationId`. `sourceAmount` is debited from the source account in its currency.
- [SupportingDocumentType](/account-api/api-reference/0.3.0/schemas/SupportingDocumentType.md): Axiym classification of evidence supplied with a payout.
- [SupportingDocumentInput](/account-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](/account-api/api-reference/0.3.0/schemas/SupportingDocument.md): Metadata of a document accepted with the payment. File content is not returned.
- [WithdrawalEventData](/account-api/api-reference/0.3.0/schemas/WithdrawalEventData.md): Compact webhook payload for routing and correlation.
- [AccountMovementEventData](/account-api/api-reference/0.3.0/schemas/AccountMovementEventData.md): A posted ledger movement on an account.
- [AccountStatusEventData](/account-api/api-reference/0.3.0/schemas/AccountStatusEventData.md): Account lifecycle notification.
- [DestinationEventData](/account-api/api-reference/0.3.0/schemas/DestinationEventData.md): Address book entry lifecycle notification.
- [Event](/account-api/api-reference/0.3.0/schemas/Event.md): Webhook event envelope delivered to your registered endpoint.
- [Subscription](/account-api/api-reference/0.3.0/schemas/Subscription.md)
- [RequestStatus](/account-api/api-reference/0.3.0/schemas/RequestStatus.md)
- [PublicKey](/account-api/api-reference/0.3.0/schemas/PublicKey.md)
- [Money](/account-api/api-reference/0.3.0/schemas/Money.md): Monetary amount and its currency.
- [Decimal](/account-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](/account-api/api-reference/0.3.0/schemas/ExternalReference.md): Optional identifier for correlating the resource with your system. Axiym returns it on reads and webhook events.
- [ValidationFieldErrors](/account-api/api-reference/0.3.0/schemas/ValidationFieldErrors.md): Recursive validation-error structure.
- [Network](/account-api/api-reference/0.3.0/schemas/Network.md): Wallet network.
- [ValidationError](/account-api/api-reference/0.3.0/schemas/ValidationError.md): Single validation error from the `validator` crate.