Request a quote

Create a quote after selecting a funded account and available corridor.

The quote is the immutable source of the payout's financial terms. Store the complete response and do not reconstruct amounts from the rate.

Request

curl --request POST \
  "https://partner-api.sandbox.axiym.io/api/v1/quotes" \
  --header "Authorization: Bearer $AXIYM_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --header "X-Request-Id: 94f11ca9-9fc8-4292-92a7-f4e59a149d23" \
  --header "Idempotency-Key: quote-payout-2026-001" \
  --data '{
    "accountId": "d96b90c1-b69e-4f5d-8154-46ecfcad8d0a",
    "buyCurrency": "PHP",
    "destinationCountry": "PH",
    "payoutMethod": "BANK",
    "amount": "56500.00",
    "amountBasis": "buy"
  }'

Field	Format	Meaning
`accountId`	UUID	Funded Axiym account enabled for payouts. Its currency becomes the sell currency.
`buyCurrency`	ISO 4217 alpha-3	Fiat currency bought and delivered to the receiver.
`destinationCountry`	ISO 3166-1 alpha-2	Destination country.
`payoutMethod`	`BANK`	Method used to deliver the payout.
`amount`	Decimal string	Amount expressed in the currency selected by `amountBasis`.
`amountBasis`	`sell` or `buy`	Which side of the quote is fixed by `amount`.

The origin country comes from the partner's onboarded location and is not sent in the request.

Response

{
  "quoteId": "978490c4-4227-4a75-9820-5f90482bb78b",
  "accountId": "d96b90c1-b69e-4f5d-8154-46ecfcad8d0a",
  "status": "ACTIVE",
  "originCountry": "SG",
  "destinationCountry": "PH",
  "payoutMethod": "BANK",
  "sell": { "amount": "1000.00", "currency": "USD" },
  "buy": { "amount": "56500.00", "currency": "PHP" },
  "fee": { "amount": "10.00", "currency": "USD" },
  "totalPayable": { "amount": "1010.00", "currency": "USD" },
  "rate": { "base": "USD", "quote": "PHP", "rate": "56.5000" },
  "requestedAt": "2026-08-04T05:07:00Z",
  "expiresAt": "2026-08-04T05:08:00Z"
}

Display or store sell, buy, fee, totalPayable, and expiresAt as one quote. Do not recompute the payout amount from the rate.

Use decimal or fixed-point arithmetic for every amount and rate. Monetary values are JSON strings, not binary floating-point numbers.

Before creating the payout

Confirm the quote is still ACTIVE.
Confirm the funding balance covers totalPayable.
Create the payout while the quote is active, then confirm the prepared payout before its confirmationExpiresAt deadline.
Use an account, corridor, quote, and payout available to the same integration.
Request a new quote if any amount, currency, destination, or payout method changes.

Confirmation consumes the quote and reserves totalPayable; requesting the quote itself does neither.

Request

Response

Before creating the payout

On this page