Terminology
Resources and identifiers
| Term | Meaning |
|---|---|
| Axiym account | A balance held with Axiym in one currency and connected to one payment rail. |
accountId | UUID identifying the Axiym account that funds a quote and payout. |
| Corridor | An available route defined by origin country, sell currency, destination country, buy currency, and payout method. |
| Quote | Time-limited financial terms for one payout. |
quoteId | UUID used to attach the immutable quote terms to a payout request. |
| Payout | The instruction and lifecycle for paying one business receiver. |
payoutId | UUID used to retrieve and reconcile a payout. |
clientReference | Your unique business reference for a payout. |
| Party Data Map | An immutable field-path mapping from your sender and receiver structures to Axiym's party fields. It contains no party values or value translations. |
partyDataMapId | UUID returned after a reviewed portable party-data-map definition is stored through the authenticated API. |
| Prepared payout | The mapped, normalized, and validated instruction returned with PENDING_CONFIRMATION. It has not yet moved funds. |
| Payout Test | A non-financial check of representative payout data, optional Party Data Map application, value normalization, and destination requirements. |
| Client | Your customer, associated with your partnership, for whom you are authorized to perform payouts. |
Payment data
| Term | Meaning |
|---|---|
| Sender | The business sending or funding the payout, including ownership information. |
| Receiver | The business being paid and its destination bank account. |
| UBO | A natural person who ultimately owns or controls the sending business. |
| Transaction | Payout-specific purpose, source of funds, reference, and supporting evidence. |
| Supporting document | Base64-encoded evidence embedded in the payout request, such as an invoice. |
| Clearing system | Local routing scheme derived from the destination corridor and supplied routing data. |
| Controlled value | A payment-data value that must resolve to one member of an Axiym-managed vocabulary. |
| Value normalization | AI-assisted, per-payout resolution of an exact or descriptive controlled input to its final allowed Axiym value, followed by deterministic validation. |
Integration terms
| Term | Meaning |
|---|---|
| Partner context | The partnership selected by the access token. It owns OAuth credentials, accounts, corridors, quotes, payouts, Party Data Maps, webhook subscriptions, and account activity. |
| Idempotency key | A request header used to retry a state-changing operation without creating a duplicate. |
| Request ID | A tracing identifier sent in X-Request-Id and echoed by Axiym. |
| Event | A compact notification that a resource changed. |
| Webhook subscription | Registration of the HTTPS endpoint that receives events. |
| Sandbox | Isolated test environment whose credentials, resources, and balances are separate from production. |
Money and formats
| Term | Meaning |
|---|---|
| Sell amount | Amount sold from the funding account currency, excluding the fee. |
| Buy amount | Local fiat amount bought and delivered to the receiver. |
| Fee | Charge reported in the quote. |
| Total payable | Sell amount plus the applicable fee, payable from the funding account. |
| Amount basis | Whether the requested quote amount is expressed on the sell or buy side. |
| ISO 4217 | Three-letter currency code such as USD or PHP. |
| ISO 3166-1 alpha-2 | Two-letter country code such as SG or PH. |
| ISO 8601 UTC timestamp | Date-time such as 2026-08-04T05:07:00Z. |