Dated comparisons against a customer's bank deal
rate_deal_historyKeyed. Returns the dated history of comparisons for one customer and corridor: the rate on each prepared or reconciled payment against that day's official rate, the negotiated deal (margin in bps or a fixed spread, with the customer's own bank label), and a public market price when one was read. Drift is in bps and in the sent currency. above_negotiated is set when the gap over the deal exceeds the stored tolerance. A missing figure is null. The payment stays with the customer's own bank. A router key is required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ISO 4217 code of the destination currency (what lands), e.g. 'USD'. | |
| from | Yes | ISO 4217 code of the source currency (what leaves), e.g. 'ZAR'. | |
| access_key | No | A router key (rk_...), if not sent as a Bearer header. | |
| customer_id | Yes | Your own id for the customer whose negotiated deal is compared, e.g. 'acme'. |