Assess a cross-border payment route before paying
assess_routePrices a cross-border payment before the business commits to it: every known route for the pair, assessed on SwapEazi's independent data. Returns deterministic JSON: the routes known for the pair, each cost and FX figure with its source, read time, freshness (fresh, aging, stale, unknown) and evidence type (observed, executable, indicative, published; the official rate as reference), settlement facts, the requirements on record with sources, what changed since the last assessment of the corridor, data-quality flags (stale, contradictory, missing, indicative only), unknowns, and the evidence behind each finding, under an assessment_id whose record is kept and retrievable (GET /api/v1/route-assessments/{id}; a content hash, not a signature). Never ranks a route as advice, never executes, never claims a figure is executable unless a provider's firm quote is on record. Free; same as GET /api/v1/route-assessments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Destination currency, ISO code, e.g. ZMW. | |
| from | No | Source currency, ISO code, e.g. EUR. | |
| sort | No | Your chosen order for the routes: landed cost against the official rate, stated days to land, or the measured 7-day answer rate. It is your order, stated as yours; SwapEazi does not rank routes. | |
| as_of | No | Assessment time, ISO 8601, within 15 minutes of now (default now). A past assessment is retrieved by assessment_id, never recomputed. | |
| amount | No | Amount leaving, in the source currency. Optional: without it the corridor is assessed at about USD 10,000, labelled. | |
| corridor | No | Instead of from and to: e.g. EUR-ZMW. | |
| assessment_id | No | Retrieve a kept assessment record instead of making a new one. | |
| charge_option | No | Who pays the banks' charges on a wire: OUR (payer pays all), SHA (shared), BEN (beneficiary). | |
| exclude_types | No | Leave out routes of these rail types. Each route left out is listed with the reason. | |
| include_types | No | Keep only routes of these rail types. Each route left out is listed with the reason. | |
| payer_country | No | Two-letter country the money leaves from. Needed when from and to are the same currency (e.g. USD from LR to a USD account in CN): the payment is then assessed as a cross-border transfer, banks' charges and rules, no conversion. | |
| min_answer_rate | No | Percent, 0 to 100: leave out routes whose measured 7-day answer rate is lower, or not measured (not enough reads). Each is listed with the reason. | |
| beneficiary_country | No | Two-letter country of the beneficiary's account; with payer_country for a same-currency payment. |