Axiym accounts and funding

An Axiym account is a partner-owned balance-holding resource used to fund payouts. It holds one currency and is connected to a payment rail. The accounts returned by the Payment API belong to the partner, not to the businesses named in individual payment payloads.

It is not the sender's, receiver's, or client's external bank account. Sender and receiver bank details are carried in the payout instruction; they do not create individual Axiym account records.

Two different funding actions

Fund the Axiym account

Arrange funding so the account has an available balance. Account funding takes place outside the Payment API.

Fund the payment

Select that funded account in a Payment API quote. Its existing balance reserves the total payable when the payment is confirmed and pays it when the payment settles.

The Payment API can list eligible Axiym accounts and their balances, but it does not provide account-funding instructions or initiate funding. Arrange for the account to be funded before creating or confirming a payment.

What an account tells you

Field	Meaning
`accountId`	Stable identifier for the balance held with Axiym.
`currency`	Currency held by the account and used as the quote's sell currency.
`paymentRails`	Rail on which the account settles.
`balance`	Current amount held in the account currency.
`status`	Whether the account is active, suspended, or closed.

Amounts are decimal strings. Use decimal or fixed-point arithmetic rather than binary floating point.

Using an account to fund a payment

Once the account has been funded, the accountId supplied in the quote request determines:

which balance funds the payout;
the sell currency; and
where the sell amount and applicable fee are debited.

The account must be active, enabled for payouts, and sufficiently funded before the payment is confirmed. If the available balance cannot cover totalPayable, confirmation is not accepted. A successful confirmation reserves totalPayable, preventing that amount from funding another payment. The Payment API does not automatically deposit or pull funds from an external account to cover a shortfall.

The reservation remains in place while the confirmed payment is reviewed. At settlement, it becomes the account debit. If the payment ends before settlement, Axiym releases the reservation back to the account's available balance.

Balance movements

Funding the account creates a credit when funds are posted to the account. Confirming a payment reserves funds but does not yet create the final debit. Funding the payment creates that debit when Payment API settlement posts. Credits and settled debits appear in the account statement.

Use the payout as the business view of the operation and the statement entry as the ledger view of the balance change.

The statement reconciles as follows:

opening balance + total credited - total debited = closing balance

Account status

Status	Meaning
`ACTIVE`	Available for permitted operations.
`SUSPENDED`	Temporarily restricted.
`CLOSED`	Permanently retired.

Having an active account does not mean every payout destination is available. Use corridors to discover the routes enabled for the authenticated integration.