Quotes & rates

Get an indicative rate

Price a corridor before a recipient exists.

GET

GET/payments/organizations/{orgId}/rates

curl -s "$AVVIO_BASE_URL/payments/organizations/$AVVIO_ORG_ID/rates?from=USD&to=MXN&amount=200.00" \
  -H "x-api-key: $AVVIO_API_KEY"

const res = await fetch(`${process.env.AVVIO_BASE_URL}/payments/organizations/${process.env.AVVIO_ORG_ID}/rates?from=USD&to=MXN&amount=200.00`, {
  headers: {
    'x-api-key': process.env.AVVIO_API_KEY,
  },
});
console.log(res.status, await res.json());

import os
import requests

res = requests.get(
    f"{os.environ['AVVIO_BASE_URL']}/payments/organizations/{os.environ['AVVIO_ORG_ID']}/rates",
    headers={
        "x-api-key": os.environ["AVVIO_API_KEY"],
    },
    params={
        "from": "USD",
        "to": "MXN",
        "amount": "200.00"
    },
)
print(res.status_code, res.json())

200OK

{
  "indicative": true,
  "sourceAmount": {
    "currency": "USD",
    "amount": "200.00"
  },
  "destinationAmount": {
    "currency": "MXN",
    "amount": "3384.65"
  },
  "fee": {
    "currency": "USD",
    "amount": "1.02"
  },
  "totalDebit": {
    "currency": "USD",
    "amount": "200.00"
  },
  "rate": "17.010001005126146",
  "limits": {
    "min": "1.00",
    "max": "5000.00"
  }
}

{
  "type": "BAD_REQUEST",
  "status": 400,
  "detail": "No payments provider available for this request",
  "requestId": "req-9uh",
  "message": "No payments provider available for this request",
  "statusCode": 400
}

{
  "type": "UNAUTHORIZED",
  "status": 401,
  "detail": "Invalid API key",
  "resolution": "Check the API key was copied whole and has not been revoked.",
  "requestId": "req-9bz",
  "message": "Invalid API key",
  "statusCode": 401
}

{
  "type": "FORBIDDEN",
  "status": 403,
  "detail": "This API key cannot access that organization",
  "resolution": "This key is scoped to a different organization.",
  "requestId": "req-9d0",
  "message": "This API key cannot access that organization",
  "statusCode": 403
}

{
  "type": "RATE_LIMITED",
  "status": 429,
  "detail": "ThrottlerException: Too Many Requests",
  "resolution": "Back off and retry after the Retry-After interval.",
  "requestId": "req-9e1",
  "message": "ThrottlerException: Too Many Requests",
  "statusCode": 429
}

Path parameters

orgIdstringRequired
The opaque organization id issued to you, normally CUID-shaped (for example cmsx…). It is not an org_-prefixed alias. Pass it unchanged in every organization-scoped path.

Query parameters

fromstringRequired
Three-letter ISO 4217 source currency code.
tostringRequired
Three-letter ISO 4217 destination currency code.
amountstringOptional
Decimal string. Omitting it prices $100 rather than returning an amountless rate, so a UI that renders the response shows a figure the user never typed. Pass the amount you are actually showing.

Behavior

What the recipient receives, the fee, the rate, and the corridor's minimum and maximum, with nothing created yet. This is what you show while someone is still choosing an amount.

Indicative, not locked. The binding price comes from POST /quotes/offramp against a real recipient. Show this as an estimate and confirm the final number before sending.

The fee is deducted from the amount you send, so destinationAmount = (sourceAmount - fee) x rate.

The query parameters are not validated on the server today. Always send from, to and a decimal amount as described: a missing currency can answer 500 INTERNAL rather than a 400, and a non-numeric amount returns amounts that are not numbers.

Responses

200Indicative price

Body · PreviewQuote

indicativebooleanOptional
Always true here. This is an estimate, not a locked rate.
sourceAmountobjectOptional
Always a decimal string, never a float and never base units. Floats lose cents at scale; base units mean every integrator re-derives the exponent.
Show 2 properties
- currencystringRequired
- amountstringRequired
destinationAmountobjectOptional
Always a decimal string, never a float and never base units. Floats lose cents at scale; base units mean every integrator re-derives the exponent.
Show 2 properties
- currencystringRequired
- amountstringRequired
feeobjectOptional
Charged on the send side and deducted before conversion.
Show 2 properties
- currencystringRequired
- amountstringRequired
totalDebitobjectOptional
What leaves your balance. On GET /rates the fee is deducted from the send rather than added on top, so this equals sourceAmount. A payout link's preview adds the fee on top, so there it is sourceAmount + fee. Read this field rather than assuming either.
Show 2 properties
- currencystringRequired
- amountstringRequired
ratestringOptional
The indicative mid-rate, before the fee: destination units per source unit converted, "1 USD = 17.01 MXN". destinationAmount = (sourceAmount - fee) x rate. This is a different number from Payout.rate, which is the effective rate with the fee inside (destination over source), so it reads lower by the fee share for the same conversion. The rate did not move.
limitsobjectOptional
The corridor's floor and ceiling, in the source currency.
Show 2 properties
- minstringOptional
- maxstringOptional

Errors

400
BAD_REQUEST: no such corridor for this organization. INDICATIVE_PRICING_UNAVAILABLE: your routing publishes no indicative rates. Do not retry; check capabilities.indicativePricing on the corridors call and price against a real recipient with POST /quotes/offramp instead.
401
The key was refused. Nothing ran.
- UNAUTHORIZED: missing, invalid or revoked, or a key on a route that does not accept one.
- KEY_EXPIRED: the key passed the expiry it was issued with. Issue a new one; an expired key cannot be rotated.
- KEY_IP_NOT_ALLOWED: the key is pinned to source addresses and this request came from another.
403
A valid key that may not make this call. Nothing ran.
- FORBIDDEN: the key belongs to a different organization.
- ACCOUNT_BLOCKED: API access for your organization is suspended, and every key is refused until we lift it. Contact support.
429
Too many requests. The default ceiling is 100 requests per minute per API credential on a 60-second window. High-volume payout and reconciliation routes declare a 600/minute override, and batch submission a 30/minute ceiling. A separate 2,000/minute per-source-IP abuse ceiling always applies.

Obey Retry-After; it is in seconds and is authoritative. A 429 means the request was refused before the handler ran. Retry reads normally; retry an idempotent mutation with its same Idempotency-Key.

Error body · Error

typestringRequired
Stable machine-readable code.
detailstringRequired
What went wrong, in a sentence. Always a string, so detail.toLowerCase() is safe.
More
This is the field to read on BAD_REQUEST and PROVIDER_REJECTED, where the type alone does not name the condition.
messagestringRequired
The same text as detail, kept for integrations written before detail existed. Read detail.
resolutionstringOptional
What to do about it, when there is a specific answer. It is not on every error (it is absent on BAD_REQUEST, NOT_FOUND, PAYOUT_NOT_CANCELABLE and DESTINATION_ACCOUNT_NOT_FOUND), so treat it as optional and fall back to detail.
statusintegerRequired
HTTP status, repeated in the body.
statusCodeintegerRequired
The same value as status, kept for integrations written before status existed. Read status.
requestIdstringRequired
Quote this to support and we can find the exact request. Also sent as the x-request-id response header, which is the only place it appears on a successful response. Success bodies do not carry it. Send your own x-request-id on the request and we use it, so your trace and ours share one identifier; otherwise we mint one.
errorsarray of stringOptional
Present on VALIDATION_ERROR; names each field that failed.
originalIdempotencyKeystringOptional
On DUPLICATE_REQUEST_DETECTED only. Send the request again with this to receive the original payout instead of making a second one. Without it there is no way to recover except by risking a double payment.
originalPayoutIdstringOptional
On DUPLICATE_REQUEST_DETECTED only. The payout the first request created.
originalBatchIdstringOptional
On a batch DUPLICATE_REQUEST_DETECTED. The run the first request created.
originalRequestIdstringOptional
On a 409 PAYOUT_OUTCOME_UNKNOWN replay. The requestId of the call whose outcome is unknown; quote it to support.
existingRecipientIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The recipient in your organization that already holds this account.
existingMethodIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The payment method on that recipient.

Branch on type, never on the status or the message. Every error type is listed with what to do about it.

Avvio Partner Payouts · Quotes & rates · operation getIndicativeQuote

Try it: Get an indicative rate

GET https://api.avvio.xyz/business/api/v1/payments/organizations/{orgId}/rates

API key Required

Test keys only. Sent as x-api-key through this site's proxy to the Avvio API, never saved, and cleared when you close this dialog.

orgId pathRequired

from queryRequired

to queryRequired

amount queryOptional

Was this page helpful?