Calculate what a payment costs
calculate_payment_costWhat this payment costs through your current provider against the official rate: effective rate, FX spread, transaction, intermediary and payout fees, total cost in money and bps, and what the beneficiary receives; with each alternative route's cost at the same size. One analysis (POST /api/v1/payment-analyses), the same service for every payment-intelligence tool. Every figure labelled LIVE, INDICATIVE, HISTORICAL or ESTIMATED; estimated savings are never realised. Free: shares the route-assessment allowance.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | No | Amount, in currency (default the source currency). | |
| weights | No | Your own scoring weights: { total_cost, speed, reliability, liquidity, compliance }, non-negative, normalised to 1. | |
| currency | No | The currency of amount: the source currency, or the destination one (then it is what the supplier receives). | |
| due_date | No | YYYY-MM-DD: a route that cannot settle by then is not eligible. | |
| priority | No | Sets the default scoring weights. Default balanced. | |
| supplier | No | Optional. The supplier's name as on the invoice, e.g. 'Lusaka Copper Supplies Ltd'; echoed in the analysis. | |
| reference | No | Optional. Your invoice or payment reference, e.g. 'INV-2207'; echoed in the analysis. | |
| access_key | No | A router key (rk_...), if not sent as a Bearer header: names the routes and is not counted. | |
| analysis_id | No | Read a kept analysis (pa_...) instead of making a new one. | |
| invoice_text | No | Paste the invoice or a sentence (e.g. 'Invoice INV-2207, Lusaka Copper Supplies Ltd, Zambia. Amount due: EUR 80,000. Due 2026-11-20'). Or the fields below. | |
| source_currency | No | ISO code you pay from, e.g. EUR or ZAR. | |
| existing_provider | No | Your current provider: { provider, kind: quote | entered_rate | past_payment, rate (destination per source unit) or landed_amount, fees: { transaction, intermediary, payout } in the source currency, fees_deducted_destination, quoted_at, valid_until }. | |
| beneficiary_amount | No | What the supplier must receive, in the destination currency (instead of amount). | |
| destination_country | No | ISO 3166 alpha-2 or name, e.g. ZM or Mozambique. | |
| destination_currency | No | ISO code the supplier is paid in, e.g. ZMW. Or destination_country. |