Schemas

When paginating forwards, are there more items?

When paginating forwards, the cursor to continue.

Account identifier (UUID).

Account currency.

Rail the account settles on.

Current balance.

Account status.

Ledger entry identifier (UUID).

Account identifier (UUID).

Credit or debit direction.

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

Account currency.

Running balance before this movement.

Running balance after this movement.

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

Identifier of the linked resource, where present.

When the movement occurred. Formatted in ISO 8601.

Derived from the partner's onboarded location.

Currency sold from the funding account.

Destination country for the payout.

Fiat currency bought and delivered to the receiver.

Method used to deliver the payout.

Current availability of the payout route.

Smallest buy amount that can be paid through the corridor.

Largest buy amount that can be paid through the corridor.

A funded Axiym account enabled for payouts. The sell currency is derived from this account.

Fiat currency to deliver to the receiver.

Destination country for the payout.

Amount expressed in the currency selected by amountBasis.

Indicates whether amount is expressed in the sell or buy currency.

Derived from the partner's onboarded location.

Amount sold from the funding account currency, excluding the fee.

Amount bought and delivered to the beneficiary.

Total amount payable from the funding account, including the fee.

Fields whose requiredness, format, validation or normalization is specific to this corridor.

Destination-specific compliance information that may affect the payout data Axiym validates.

Partner-facing payment-data field path.

Human-readable field name.

Requiredness for this corridor.

Human-readable value format.

Regular expression used to validate the value when one applies.

Normalization applied before validation when one applies.

Additional guidance for supplying the field.

International phone number in E.164 format.

How you describe the identification type. Provide an accepted Axiym value or descriptive text; Axiym normalizes it before validation.

How you describe the individual's ownership or control relationship. Axiym normalizes it to the final UBO designation before validation.

ISO 9362 BIC, when required for the corridor.

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

How you describe the bank-account type. Provide an accepted Axiym value or descriptive text; Axiym normalizes it before validation.

ISO 9362 BIC, when required for the corridor.

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

How you describe the receiver's relationship to the sender. Provide an accepted Axiym value or descriptive text; Axiym normalizes it before validation.

Version of the portable party-data-map document format.

Version of Axiym's partner-facing party fields used when the map was authored.

Source paths keyed to their Axiym target paths. Array paths use `[]`, for example `owners[].fullName`.

Partner-facing name for the stored map.

Optional note describing the source structures or integration that uses this map.

Stored resource version. A changed definition is stored as a new immutable party data map.

SHA-256 digest of Axiym's canonical serialization of the map definition.

How you describe the supporting document. Provide an accepted Axiym value or descriptive text; Axiym normalizes it before validation.

The business reason for the payment. Provide an accepted Axiym value or descriptive text; Axiym normalizes it before validation.

Where the payment funds originated. Provide an accepted Axiym value or descriptive text; Axiym normalizes it before validation.

Partner's unique, idempotent reference to the payout.

Partner's unique, idempotent reference to the payout.

Immutable saved mapping applied to sender and receiver only.

Currency that would fund the payment.

Country where the beneficiary would be paid.

Local fiat currency that would be delivered to the beneficiary.

Stored Party Data Map applied to the representative sender and receiver objects.

True when the mapped and normalized payload satisfies the baseline and destination requirements selected by context.

Party Data Map used by the test. Omitted when the submitted parties used Axiym's structure.

Controlled values changed during normalization. Exact Axiym values that passed through unchanged are not included.

Non-blocking mapping or validation observations, such as unused source fields.

Mapping or validation failures keyed by the mapped payout-data path; null when `valid` is true.

Axiym payout-data path containing the normalized value.

Final allowed Axiym value.

Controlled vocabulary used for normalization.

Partner source path or mapped Axiym path associated with the warning.

Amount sold from the funding account currency, excluding the fee.

Amount bought and delivered to the beneficiary.

Total amount payable from the funding account, including the fee.

Deadline for confirming a payout with status PENDING_CONFIRMATION. Derived from the referenced quote's expiry.

Present after the partner has confirmed the prepared payout.

SHA-256 digest of the decoded document content. The API does not echo base64 document data in payout responses.

Indicates whether backside document content was supplied.

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

Subscription identifier (UUID).

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

Request status.

Default OK

Public key identifier (UUID).

Indicates whether the key is active

Encryption algorithm

Public Key

Creation timestamp. Formatted in ISO 8601.

HTTP status code, duplicated in the body.

Human-readable message describing the error.

Additional error details; null when there are none.

HTTP status code, duplicated in the body.

Invalid Parameters for validation failures; the rejection reason otherwise.

Validation failures are keyed by field name. Business rejections return null.

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

Human-readable message.

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