Axiym

Schemas

Data models used by the Account API.

View MarkdownView complete reference
44 schemas

Currency

string
#

Currency code — ISO 4217 (e.g. USD, EUR) or a supported digital currency (USDT, USDC).

AccountStatus

string
#
Allowed values
ACTIVESUSPENDEDCLOSED

Account

object
#

An account holding a currency balance.

accountIdRequired
string

Account identifier (UUID).

Formatuuid
currencyRequired
Currency

Account currency.

paymentRailsRequired
PaymentRailsCode

Rail the account settles on.

balanceRequired
Decimal

Current balance.

statusRequired
AccountStatus

Account status.

PaymentRailsCode

string
#

Payment rail code the account settles on (e.g. `ZENUS_BANK`, `TRON`).

AccountRef

object
#

Compact account reference. Fetch the account via `GET /accounts/{accountId}` for the current balance and status; deposit instructions serve its payment details.

accountIdRequired
string

Account identifier (UUID).

Formatuuid
currencyRequired
Currency

Account currency.

paymentRailsRequired
PaymentRailsCode

Rail the account settles on.

StatementEntryType

string
#

Direction of movement on the account.

Allowed values
CREDITDEBIT

StatementEntry

object
#

A posted ledger movement on an account. Entries are returned in posting order and include the running balance, so consecutive entries reconcile against each other.

entryIdRequired
string

Ledger entry identifier (UUID).

Formatuuid
accountIdRequired
string

Account identifier (UUID).

Formatuuid
typeRequired
StatementEntryType

Credit or debit direction.

amountRequired
Decimal

Positive movement amount in the account currency; direction is in `type`.

currencyRequired
Currency

Account currency.

balanceBefore
Decimal

Running balance before this movement.

balanceAfterRequired
Decimal

Running balance after this movement.

relatedResourceType
string

Type of the linked money movement; absent for ledger adjustments with no linked resource.

Allowed values
DEPOSITWITHDRAWALCONVERSIONPAYOUT
relatedResourceId
string

Identifier of the linked resource, where present.

Formatuuid
occurredAtRequired
string

When the movement occurred. Formatted in ISO 8601.

Formatdate-time

Bank

object
#

Destination bank details. Present on bank destinations only. The bank address country selects the applicable payout corridor rules. Supply `swiftBic`, `clearingCode`, or `clearingSystemCode` when that corridor requires them.

bankNameRequired
string

Bank name.

Min length1
addressRequired
BankAddress
swiftBic
string

ISO 9362 SWIFT/BIC, when required for the corridor.

Pattern^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$
clearingCode
string

Local clearing or routing code, when required for the corridor.

clearingSystemCode
string

Clearing system the code belongs to. Axiym derives it from the bank country; supply it where a country has more than one system.

BankAddress

object
#

Postal address of the destination bank. `country` is always required because it selects the applicable corridor rules. Supply the remaining address fields when the corridor or a correspondent requires them.

streetName
string
buildingNumber
string
city
string
region
string
postalCode
string
countryRequired
CountryCode

CountryCode

string
#

ISO 3166-1 alpha-2 country code.

Pattern^[A-Z]{2}$

DepositStatus

string
#

`PENDING` awaits crediting. `HELD` is temporarily on hold. `COMPLETED` was credited to the account. `CANCELED` or `REJECTED` was not completed; see `reasonCode`.

Allowed values
PENDINGHELDCOMPLETEDCANCELEDREJECTED

Deposit

object
#
depositIdRequired
string

Deposit identifier (UUID).

Formatuuid
accountRequired
AccountRef

The account the deposit credits, embedded as a compact reference.

amountRequired
Money

Amount credited to the account.

fee
Money

Fee charged, when any.

statusRequired
DepositStatus

Deposit status.

remitterName
string

Name of the sender, as reported by the sending bank or network.

code
string

System-assigned payment code, shown on the payment.

transactionHash
string

The transaction hash on the network. Present for wallet deposits.

reasonCode
string

Present when `status` is `CANCELED` or `REJECTED` — the reason as reported by the bank, the network, or Axiym operations. Example: `SENDER_SCREENING_FAILED`.

createdAtRequired
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time

BankDepositInstruction

object
#
beneficiaryNameRequired
string

Name of the receiving party to put on the transfer.

accountNumberRequired
string

Receiving bank account number.

swiftBicRequired
string

SWIFT/BIC code of the receiving bank.

bankNameRequired
string

Receiving bank name.

reference
string

ISO 11649 creditor reference (`RF` + check digits) assigned by Axiym, formatted in groups of four. Present when the account is funded through a shared receiving account; include it on the transfer so the deposit is matched automatically (matching ignores the spaces). Absent when the receiving account number alone identifies the Axiym account.

WalletDepositInstruction

object
#
walletAddressRequired
string

Deposit address of the account; deposits are matched by the address itself.

networkRequired
Network

Network of the wallet address.

DepositEventData

object
#

A compact notification for routing and correlation. Retrieve the deposit from `GET /deposits/{depositId}` when you need its amount, transaction hash, or current state.

depositIdRequired
string

Deposit identifier (UUID).

Formatuuid
statusRequired
DepositStatus

Deposit status at the time the event was emitted.

reasonCode
string

Present on `deposit.canceled` / `deposit.rejected` — the reason as reported by the bank, the network, or Axiym operations. Example: `SENDER_SCREENING_FAILED`.

DestinationStatus

string
#

- `PENDING_REVIEW` — awaiting review. - `ACTIVE` — available for withdrawals. - `SUSPENDED` — temporarily unavailable. - `CLOSED` — permanently retired.

Allowed values
PENDING_REVIEWACTIVESUSPENDEDCLOSED

AddressBookEntry

BankAddressBookEntry | WalletAddressBookEntry
#

A registered external bank account or wallet address in the address book, with its status and creation date. - A bank destination contains `accountNumber` and `bank`. - A wallet destination contains `walletAddress` and `network`. The two field sets never appear together.

BankAddressBookEntry

object
#
destinationIdRequired
string

Address book entry identifier (UUID).

Formatuuid
statusRequired
DestinationStatus

Address book entry status.

currencyRequired
Currency

Currency the destination is paid in.

accountNumberRequired
string

Bank account number.

bankRequired
Bank

Destination bank details.

createdAt
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time

WalletAddressBookEntry

object
#
destinationIdRequired
string

Address book entry identifier (UUID).

Formatuuid
statusRequired
DestinationStatus

Address book entry status.

currencyRequired
Currency

Currency the destination is paid in.

walletAddressRequired
string

Destination wallet address; static and reusable.

networkRequired
Network

Network of the wallet address.

createdAt
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time

Destination

BankDestination | WalletDestination
#

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. - A bank destination contains `accountNumber` and `bank`. - A wallet destination contains `walletAddress` and `network`. The two field sets never appear together.

BankDestination

object
#
destinationId
string

Address book entry the destination was taken from, when applicable.

Formatuuid
currencyRequired
Currency

Currency delivered to the destination.

accountNumberRequired
string

Bank account number or IBAN.

bankRequired
Bank

Destination bank details.

WalletDestination

object
#
destinationId
string

Address book entry the destination was taken from, when applicable.

Formatuuid
currencyRequired
Currency

Currency delivered to the destination.

walletAddressRequired
string

Wallet address on the given network.

networkRequired
Network

Network of the wallet address.

PageInfo

object
#
hasNextPageRequired
boolean

When paginating forwards, are there more items?

endCursor
string

When paginating forwards, the cursor to continue.

WithdrawalStatus

string
#

- `PENDING_CONFIRMATION` — created and awaiting confirmation. - `PENDING` — confirmed and awaiting execution. - `HELD` — temporarily on hold; no action is needed. - `COMPLETED` — completed successfully. - `CANCELED` or `REJECTED` — not completed; see `reasonCode` when present.

Allowed values
PENDING_CONFIRMATIONPENDINGHELDCOMPLETEDCANCELEDREJECTED

Withdrawal

object
#
withdrawalIdRequired
string

Withdrawal identifier (UUID).

Formatuuid
sourceAccountRequired
AccountRef

The source account, embedded as a compact reference.

sourceAmountRequired
Money

Amount debited from the source account, in the source account currency.

destinationAmountRequired
Money

Amount delivered to the destination, in the destination currency. Equals `sourceAmount` less `fee`.

feeRequired
Money

Total deducted from `sourceAmount` before delivery, in the source account currency. Zero when no fee applies.

destinationRequired
Destination

Snapshot of the destination selected by `destinationId` at creation time.

statusRequired
WithdrawalStatus

Withdrawal status.

code
string

System-assigned payment code, shown on the payment.

reference
string

Text shown to the recipient, as submitted.

supportingDocuments
SupportingDocument[]

Documents accepted with the payment. File content is not returned.

externalReference
ExternalReference

Your reference for correlation, echoed back on related objects.

transactionHash
string

The transaction hash on the network. Present for wallet withdrawals once the withdrawal is `COMPLETED`.

reasonCode
string

Present when `status` is `CANCELED` or `REJECTED` — the cancellation/rejection reason as reported by the bank, the network, or Axiym operations. Example: `INSUFFICIENT_BENEFICIARY_DETAILS`.

createdAtRequired
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time

WithdrawalRequest

object
#

An outgoing payment from `sourceAccountId` to `destinationId`. `sourceAmount` is debited from the source account in its currency. The destination must be an `ACTIVE` address book entry in the same currency. Creation returns a withdrawal awaiting confirmation; it does not begin execution.

sourceAccountIdRequired
string

Source account identifier (UUID).

Formatuuid
sourceAmountRequired
Money

Amount to debit from the source account. Its currency must be the source account currency.

destinationIdRequired
string

Identifier of the address book entry to pay. It must be `ACTIVE` and in the source Axiym account's currency.

Formatuuid
reference
string

Text shown to the recipient, typically the invoice number.

Max length140
supportingDocuments
SupportingDocumentInput[]

Documents supporting the payment, such as an invoice. Required where the destination corridor requires evidence.

Max items10
externalReference
ExternalReference

Your reference for correlation, echoed back on related objects.

SupportingDocumentType

string
#

Axiym classification of evidence supplied with a payout.

Allowed values
PASSPORTNATIONAL_IDDRIVER_LICENSERESIDENCE_PERMITPROOF_OF_ADDRESSUTILITY_BILLBANK_STATEMENTTAX_CERTIFICATECERTIFICATE_OF_INCORPORATIONREGISTRY_EXTRACTARTICLES_OF_ASSOCIATIONSHAREHOLDER_REGISTERDIRECTOR_REGISTERUBO_DECLARATIONPOWER_OF_ATTORNEYBOARD_RESOLUTIONREGULATORY_LICENSEBUSINESS_LICENSEFINANCIAL_STATEMENTAUDIT_REPORTSOURCE_OF_FUNDSINVOICECONTRACTPURCHASE_ORDERPAYROLL_FILELOAN_AGREEMENTSHIPPING_DOCUMENTCUSTOMS_DECLARATIONOTHER

SupportingDocumentInput

object
#

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.

documentTypeRequired
SupportingDocumentType
dataRequired
string

Complete file encoded as base64 from its raw bytes. Do not include a data-URL prefix.

nameRequired
string

File name, including the extension.

Min length1Max length255

SupportingDocument

object
#

Metadata of a document accepted with the payment. File content is not returned.

documentTypeRequired
SupportingDocumentType
fileIdRequired
string

Identifier of the stored file.

Formatuuid
nameRequired
string

File name supplied with the document.

contentTypeRequired
string

MIME type detected from the file content.

sizeRequired
integer

File size in bytes.

WithdrawalEventData

object
#

Compact webhook payload for routing and correlation. Webhooks are notifications, not state transfer. Fetch `GET /withdrawals/{withdrawalId}` for the authoritative amounts, fee, destination, and transaction hash.

withdrawalIdRequired
string

Withdrawal identifier (UUID).

Formatuuid
statusRequired
WithdrawalStatus

Withdrawal status at the time the event was emitted.

externalReference
ExternalReference

Your reference submitted on creation, where present.

reasonCode
string

Present on `withdrawal.canceled` / `withdrawal.rejected` — the reason as reported by the bank, the network, or Axiym operations. Example: `INSUFFICIENT_BENEFICIARY_DETAILS`.

AccountMovementEventData

object
#

A posted ledger movement on an account. Movements are immutable facts, so the event contains the amount but not the current balance. Fetch `GET /accounts/{accountId}` for that balance.

accountIdRequired
string

Account identifier (UUID).

Formatuuid
amountRequired
Decimal

Positive movement amount in the account currency; direction is in the event type.

currencyRequired
Currency

Account currency.

relatedResourceType
string

Type of the linked money movement; absent for movements with no linked API resource.

Allowed values
DEPOSITWITHDRAWALCONVERSIONPAYOUT
relatedResourceId
string

Identifier of the linked resource, where present.

Formatuuid
occurredAtRequired
string

When the movement occurred. Formatted in ISO 8601.

Formatdate-time

AccountStatusEventData

object
#

Account lifecycle notification.

accountIdRequired
string

Account identifier (UUID).

Formatuuid
statusRequired
AccountStatus

Account status at the time the event was emitted.

DestinationEventData

object
#

Address book entry lifecycle notification.

destinationIdRequired
string

Address book entry identifier (UUID).

Formatuuid
statusRequired
DestinationStatus

Address book entry status at the time the event was emitted.

Event

object
#

Webhook event envelope delivered to your registered endpoint.

idRequired
string

Event ID. Use this for de-duplication.

Formatuuid
timestampRequired
string

Event timestamp. Formatted in ISO 8601.

Formatdate-time
type
string

Event type.

dataRequired
object

Event data.

Subscription

object
#
subscriptionIdRequired
string

Subscription identifier (UUID).

Formatuuid
endpointRequired
string

URL of the endpoint to subscribe to notifications. Must be publicly accessible, use HTTPS, and respond with a 2XX status to a POST request.

Formaturi

RequestStatus

object
#
statusRequired
string

Request status.

Allowed values
OK

Default OK

PublicKey

object
#
publicKeyIdRequired
string

Public key identifier (UUID).

Formatuuid
activeRequired
boolean

Indicates whether the key is active

algorithmRequired
string

Encryption algorithm

publicKeyRequired
string

Public Key

createdAtRequired
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time

Money

object
#

Monetary amount and its currency.

amountRequired
Decimal
currencyRequired
Currency

Decimal

string
#

Decimal number serialized as a string to preserve precision. Amounts sent to Axiym are positive and carry at most 8 decimal places.

ExternalReference

string
#

Optional identifier for correlating the resource with your system. Axiym returns it on reads and webhook events. It does not make retries safe; use `Idempotency-Key` to deduplicate retries.

Max length255

ValidationFieldErrors

ValidationError[] | object
#

Recursive validation-error structure. - A leaf field contains an array of `ValidationError` records. - A nested object is keyed by field name. - A list is keyed by array index.

One of

Network

string
#

Wallet network.

Allowed values
TRONAVALANCHE

ValidationError

object
#

Single validation error from the `validator` crate.

codeRequired
string

Validation rule code (e.g. 'length', 'email', 'invalid_currency', 'disbursement_account_required').

message
string | null

Human-readable message.

paramsRequired
object

Rule-specific parameters. Always includes `value` (the offending input). Additional keys depend on the rule (e.g. `min`, `max` for length).

value
unknown

The submitted value that failed validation.