Overview
The Payment API lets a partner use its Axiym account to pay a business beneficiary on behalf of a client. The client does not need to be onboarded by Axiym: the payout carries the complete sender, receiver, and transaction data. When currencies differ, Axiym converts the funds and delivers the payment in the beneficiary's local currency.
Each payment is represented by a payout resource. The payout contains the instruction to pay one beneficiary and records its progress through validation, approval, settlement, and execution.
Supported scope
- Business-to-business payments to business beneficiaries.
- Partner-owned Axiym accounts fund payments and receive settlement movements.
- Local fiat currency is delivered through supported destination banking routes.
BANKis currently the supported payout method.
The partner owns funding and settlement
The Axiym accounts returned by the Payment API belong to the partner. They hold the balance used to fund payments, receive the resulting settlement debit, and provide the account activity used for reconciliation.
The businesses named in the sender and receiver payloads are payment parties. They do not receive individual Axiym account records through the Payment API. The partner selects its own funded Axiym account when requesting a quote, then uses that account to fund the payment.
What every payment needs
A funded Axiym account
The account holds the funds used for the payment and determines the sell currency. It must be active, enabled for payouts, and sufficiently funded.
An active quote
The quote fixes the sell and buy amounts, exchange rate, fees, destination, and expiry. Confirming the payout accepts the quote.
A complete payment instruction
Every payout carries the full sender, receiver, transaction, and supporting document data required for validation and execution.
A way to track the outcome
Payouts are asynchronous. Use webhooks for status changes, API reads for current state, and account statements for reconciliation.
How a payment works
- Start with a funded Axiym account that is enabled for payouts.
- Request a quote for the destination country, fiat currency, payout method, and amount.
- Create the payout with complete sender, receiver, transaction, and supporting-document data. Review the mapped, normalized, and validated instruction returned by Axiym.
- Confirm the exact prepared payout before its confirmation deadline.
- Axiym validates and approves the confirmed payment instruction.
- Axiym settles the payment from the funded account.
- Axiym executes the payout through the selected local payment route.
- Track the payout through webhooks, API polling, or both, and reconcile the resulting account movement.
Your responsibilities and Axiym's
| Partner | Axiym |
|---|---|
| Keep the funding account sufficiently funded. | Determine the available payout routes and destination requirements. |
| Request a quote, create the payout, review it, and confirm it before expiry. | Prepare the exact instruction and begin processing only after confirmation. |
| Supply complete and accurate sender, receiver, transaction, and document data. | Settle the payment and execute it through the selected local route. |
| Process status updates and reconcile completed activity. | Normalize the execution outcome into a consistent payout status. |
The businesses in a payment
The partner access token identifies the partnership that owns the funding account, quote, payout, Party Data Map, webhook subscription, and account activity.
The sender and receiver payloads identify the businesses involved in the payment. They do not create Axiym client resources or individual funding accounts, which lets you use the client relationship and onboarding model that works for your business.
Every payout includes the sender, receiver, transaction, and supporting documents required for that payment. You can submit sender and receiver data in Axiym's documented structure, or reference a reusable Party Data Map when your systems use different field names or nesting. The map changes field paths only; transaction data remains in every payout request.
Axiym normalizes controlled values, such as payment purpose and source of funds, for each payout before validation. Review the prepared payout and its final values before confirming it.
Where to go next
- Read Payout lifecycle for the processing stages and failure boundaries.
- Read The payout payload to understand field mapping, value normalization, and testing representative data.
- Follow Make your first payout when you are ready to integrate.