Axiym

Schemas

Data models used by the Trade API.

46 schemas

OnboardingRequest

object
#

Legal-entity information needed to start KYB onboarding for a represented client.

legalEntityNameRequired
string

Official registered name of the client business.

incorporationDateRequired
string

Date the legal entity was established.

Formatdate
registrationDateRequired
string

Date the client joined your organization or service.

Formatdate
legalAddressRequired
Address

Client's registered legal address.

partnerClientIdRequired
string

Your stable identifier for the client. It must be unique within your partnership and is returned for correlation. A new onboarding request using an existing value returns `409 Conflict`.

OnboardingCase

object
#

A Trade client KYB onboarding case. A client can use Trade API paths only after Axiym approves the case.

clientIdRequired
string

Axiym identifier assigned to the represented client. Use it in `/clients/{clientId}/...` paths after approval.

Formatuuid
legalEntityNameRequired
string

Official registered name of the client business.

partnerClientIdRequired
string

Your identifier for this client.

statusRequired
string

Current onboarding state. `ONBOARDING` is under review; `ACTIVE` is ready for Trade API operations; `REJECTED` cannot use Trade API operations.

Allowed values
ONBOARDINGACTIVEREJECTED
rejectionReason
string

Reason Axiym provided when the case is rejected, where available.

Client

object
#

A client record associated with your partnership. The record may be onboarding, active, or disabled; only an active client can use Trade API operations.

clientIdRequired
string

Axiym identifier for this client. Use it in `/clients/{clientId}/...` paths.

Formatuuid
codeRequired
string

Human-readable Axiym client code.

legalEntityNameRequired
string

Official registered name of the client business.

legalAddressRequired
Address

Client's registered legal address.

incorporationDateRequired
string

Date the legal entity was established.

Formatdate
registrationDateRequired
string

Date the client joined your organization or service.

Formatdate
statusRequired
string

Current Axiym status. `ACTIVE` clients can use Trade API operations; `ONBOARDING` is under review and `DISABLED` cannot use them.

Allowed values
ONBOARDINGACTIVEDISABLED
partnerClientIdRequired
string

Your stable identifier for this client.

Address

object
#

Registered legal address of a business.

addressRequired
string

First address line.

addressExtended
string

Second address line, where applicable.

cityRequired
string

City or locality.

district
string

State, province, or region, where applicable.

postalCodeRequired
string

Postal or ZIP code.

countryRequired
string

ISO 3166-1 alpha-2 country code.

Pattern^[A-Z]{2}$

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 Axiym account that holds one currency on one payment rail. Retrieve its receiving details from `GET /clients/{clientId}/accounts/{accountId}/deposit-instructions`.

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.

AccountRef

object
#

Compact account reference. Fetch the account via `GET /clients/{clientId}/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.

PaymentRailsCode

string
#

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

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 carry 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
DEPOSITWITHDRAWALCONVERSION
relatedResourceId
string

Identifier of the linked resource, where present.

Formatuuid
occurredAtRequired
string

When the movement occurred. Formatted in ISO 8601.

Formatdate-time

ConversionStatus

string
#

`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`.

Allowed values
PENDINGACTIVECOMPLETEDCANCELED

ConversionPair

object
#

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.

pairIdRequired
string

Conversion pair identifier (UUID), stable for the pair and direction.

Formatuuid
pairRequired
string

Pair symbol, `<sellCurrency>-<buyCurrency>`.

sellRequired
ConversionPairSide

The side you sell.

buyRequired
ConversionPairSide

The side you buy.

minAmountRequired
Decimal

Minimum sell amount, in the sell currency.

ConversionPairSide

object
#

One side of a conversion pair.

currencyRequired
Currency

Side currency.

paymentRailsRequired
PaymentRailsCode

Rail the side settles on.

ConversionRequest

object
#

A conversion along one of your conversion pairs. `pairId` selects the accounts on both sides; `sellAmount` is in the pair's sell currency.

pairIdRequired
string

Conversion pair identifier from `GET /clients/{clientId}/conversion-pairs`.

Formatuuid
sellAmountRequired
Decimal

Amount to sell, in the pair's sell currency.

externalReference
ExternalReference

Your reference for correlation, echoed back on related objects.

Conversion

object
#
conversionIdRequired
string

Conversion identifier (UUID).

Formatuuid
pairIdRequired
string

The conversion pair this conversion runs along.

Formatuuid
statusRequired
ConversionStatus

Conversion status.

reasonCode
string

Present when `status` is `CANCELED` — the reason as reported by operations or the liquidity venue. Example: `RATE_EXPIRED`.

sellAccountRequired
AccountRef

The sell-side account, embedded as a compact reference.

sellAmountRequired
Decimal

Amount sold, in the sell currency.

buyAccountRequired
AccountRef

The buy-side account, embedded as a compact reference.

buyAmountRequired
Decimal

Amount bought and credited to the buy-side account, net of fee.

rateRequired
Decimal

Units of buy currency received for one unit of sell currency.

feeAmountRequired
Decimal

Fee charged in the pair's ISO 4217 currency. It is deducted from the sell amount when buying digital currency and from the buy proceeds when selling it.

feeCurrencyRequired
Currency

Currency of the fee — always the ISO 4217 currency of the pair.

externalReference
ExternalReference

Your reference for correlation, echoed back on related objects.

createdAtRequired
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time
completedAt
string

Completion timestamp. Formatted in ISO 8601.

Formatdate-time

ConversionEventData

object
#

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.

conversionIdRequired
string

Conversion identifier (UUID).

Formatuuid
pairId
string

The conversion pair this conversion runs along.

Formatuuid
statusRequired
ConversionStatus

Conversion status at the time the event was emitted.

externalReference
ExternalReference

Your reference submitted on creation, where present.

reasonCode
string

Present on `conversion.canceled` — the reason as reported by operations or the liquidity venue. Example: `RATE_EXPIRED`.

clientIdRequired
string

Axiym identifier of the client that owns the resource.

Formatuuid

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
Decimal

Amount credited to the account, before fee.

feeAmount
Decimal

Fee charged.

currencyRequired
Currency

Account currency.

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.

referenceRequired
string

ISO 11649 creditor reference (`RF` + check digits) assigned by Axiym to this account, formatted in groups of four. Include it on the transfer so the deposit is matched automatically; matching ignores the spaces.

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 /clients/{clientId}/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`.

clientIdRequired
string

Axiym identifier of the client that owns the resource.

Formatuuid

DestinationStatus

string
#

`PENDING_REVIEW` awaits review. `ACTIVE` may fund deposits and receive withdrawals. `SUSPENDED` is temporarily unavailable. `CLOSED` is permanently retired.

Allowed values
PENDING_REVIEWACTIVESUSPENDEDCLOSED

Destination

BankDestination | WalletDestination
#

A registered external bank account or wallet; the shape matches the account type.

BankDestination

object
#
destinationIdRequired
string

Registered external-account identifier (UUID).

Formatuuid
statusRequired
DestinationStatus

Registered external-account status.

currencyRequired
Currency

Currency associated with the registered external account.

accountNumberRequired
string

Bank account number.

swiftBicRequired
string

SWIFT/BIC code.

bankNameRequired
string

Bank name.

createdAt
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time

WalletDestination

object
#
destinationIdRequired
string

Registered external-account identifier (UUID).

Formatuuid
statusRequired
DestinationStatus

Registered external-account status.

currencyRequired
Currency

Currency associated with the registered external account.

walletAddressRequired
string

Wallet address of the registered external account; static and reusable.

networkRequired
Network

Network of the wallet address.

createdAt
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time

BankDestinationRequest

object
#

Register an owned external bank account as a permitted deposit source and withdrawal recipient. The registered account starts in `PENDING_REVIEW`.

currencyRequired
Currency

Currency associated with the external bank account.

accountNumberRequired
string

Bank account number.

swiftBicRequired
string

SWIFT/BIC code.

bankNameRequired
string

Bank name.

WalletDestinationRequest

object
#

Register an owned external wallet as a permitted deposit source and withdrawal recipient. The registered wallet starts in `PENDING_REVIEW`.

currencyRequired
Currency

Currency associated with the external wallet.

walletAddressRequired
string

Wallet address to register as an external account.

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` awaiting execution, `HELD` temporarily on hold — no action needed from you, `COMPLETED` done, `CANCELED`/`REJECTED` not completed (see `reasonCode`).

Allowed values
PENDINGHELDCOMPLETEDCANCELEDREJECTED

Withdrawal

object
#
withdrawalIdRequired
string

Withdrawal identifier (UUID).

Formatuuid
sourceAccountRequired
AccountRef

The sell-side account, embedded as a compact reference.

amountRequired
Decimal

Amount sent to the registered external account, before fee.

feeAmount
Decimal

Fee charged.

currencyRequired
Currency

Currency code (ISO 4217 or a supported digital currency).

destinationRequired
Destination

The registered external account selected by `destinationId`, embedded in full.

statusRequired
WithdrawalStatus

Withdrawal status.

code
string

System-assigned payment code, shown on the payment.

purpose
string

Free-text purpose of the payment, as submitted.

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
#

A withdrawal from `sourceAccountId` to a registered external account. `amount` uses the source account's currency. The `destinationId` must be `ACTIVE` and use the same currency.

sourceAccountIdRequired
string

Source account identifier (UUID).

Formatuuid
amountRequired
Decimal

Amount to send, before fee. In the source account's currency.

destinationIdRequired
string

Identifier of the registered external bank account or wallet to pay. It must be `ACTIVE` and in the source Axiym account's currency.

Formatuuid
purpose
string

Free-text purpose of the payment.

externalReference
ExternalReference

Your reference for correlation, echoed back on related objects.

WithdrawalEventData

object
#

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.

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`.

clientIdRequired
string

Axiym identifier of the client that owns the resource.

Formatuuid

AccountMovementEventData

object
#

A posted account movement. The event includes the movement amount but not the current balance. Retrieve the account when you need its latest 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
DEPOSITWITHDRAWALCONVERSION
relatedResourceId
string

Identifier of the linked resource, where present.

Formatuuid
occurredAtRequired
string

When the movement occurred. Formatted in ISO 8601.

Formatdate-time
clientIdRequired
string

Axiym identifier of the client that owns the resource.

Formatuuid

AccountStatusEventData

object
#

Account lifecycle notification.

accountIdRequired
string

Account identifier (UUID).

Formatuuid
statusRequired
AccountStatus

Account status at the time the event was emitted.

clientIdRequired
string

Axiym identifier of the client that owns the resource.

Formatuuid

DestinationEventData

object
#

Registered external-account lifecycle notification. The contract retains the `destinationId` field name.

destinationIdRequired
string

Registered external-account identifier (UUID).

Formatuuid
statusRequired
DestinationStatus

Registered external-account status when the event was emitted.

clientIdRequired
string

Axiym identifier of the client that owns the resource.

Formatuuid

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

Decimal

string
#

Decimal number serialized as a string to preserve precision.

ExternalReference

string
#

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.

Max length255

ValidationFieldErrors

ValidationError[] | object
#

Nested validation errors keyed by field name or array index. Leaf values are arrays of `ValidationError` objects.

One of

Network

string
#

Wallet network.

Allowed values
TRONAVALANCHE

ValidationError

object
#

One field-level validation error.

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.