Axiym

Schemas

Data models used by the Account API.

28 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
#

Current summary of an account holding a currency balance.

accountIdRequired
string

Account identifier (UUID).

Formatuuid
currencyRequired
Currency

Account currency.

paymentRailsRequired
string

Payment rail associated with the account.

balanceRequired
Decimal

Current balance.

statusRequired
AccountStatus

Account status.

AccountRef

object
#

Compact account reference embedded in a withdrawal.

accountIdRequired
string

Account identifier (UUID).

Formatuuid
currencyRequired
Currency

Account currency.

paymentRailsRequired
string

Payment rail associated with the account.

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

DestinationStatus

string
#

`PENDING_REVIEW` awaiting compliance review, `ACTIVE` usable for withdrawals, `SUSPENDED` temporarily unusable, `CLOSED` permanently retired. Mirrors the account status vocabulary.

Allowed values
PENDING_REVIEWACTIVESUSPENDEDCLOSED

BankDestination

object
#
destinationIdRequired
string

Destination identifier (UUID).

Formatuuid
statusRequired
DestinationStatus

Whitelisted own account status.

currencyRequired
Currency

Currency the destination is paid in.

accountNumberRequired
string

Bank account number.

swiftBicRequired
string

SWIFT/BIC code.

bankNameRequired
string

Bank name.

createdAt
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time

BankDestinationRequest

object
#

Register an owned external bank account as a whitelisted own account. The registered account starts in `PENDING_REVIEW`.

currencyRequired
Currency
accountNumberRequired
string

Bank account number.

swiftBicRequired
string

SWIFT/BIC code.

bankNameRequired
string

Bank name.

WalletDestinationRequest

object
#

Register an owned external wallet as a whitelisted own account. The registered wallet starts in `PENDING_REVIEW`.

currencyRequired
Currency
walletAddressRequired
string

Wallet address to register.

networkRequired
Network

WalletDestination

object
#
destinationIdRequired
string

Destination identifier (UUID).

Formatuuid
statusRequired
DestinationStatus

Whitelisted own account 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

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 source account, embedded as a compact reference.

amountRequired
Decimal

Amount sent to the whitelisted own account, before fee.

feeAmount
Decimal

Fee charged.

currencyRequired
Currency

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

destinationRequired
Destination

The whitelisted own account the destination resolved to, 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
#

An outgoing payment from `sourceAccountId`. `amount` is in the source account's currency. `destinationId` references one of your whitelisted own accounts; it must be `ACTIVE` and in the source Axiym account's 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 whitelisted own account 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
#

Compact event payload: enough to route the event and correlate it with your records. Webhooks are notifications, not state transfer — fetch the authoritative withdrawal via `GET /withdrawals/{withdrawalId}` when you need amounts, fees, or the 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 amount is carried in the event; the current balance is not — fetch it via `GET /accounts/{accountId}`.

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

DestinationEventData

object
#

Whitelisted own account lifecycle notification.

destinationIdRequired
string

Destination identifier (UUID).

Formatuuid
statusRequired
DestinationStatus

Whitelisted own account 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

Decimal

string
#

Decimal number serialized as a string to preserve precision.

ExternalReference

string
#

Your own identifier for this object, for correlation with your system. Optional, echoed back on reads. This is for business correlation, not retry-safety — use the `Idempotency-Key` header to deduplicate retries.

Max length255

ValidationFieldErrors

ValidationError[] | object
#

Recursive structure: either an array of ValidationError records (leaf field), an object keyed by nested field names (Struct variant), or an object keyed by array indices (List variant).

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.