Add up arbitrary amounts
For a screen that has already fetched its own figures. Minor units in and minor units out. A total assembled from floats disagrees with the balances it was built from, and somebody eventually reconciles the two.
For a screen that has already fetched its own figures.
Minor units in and minor units out. A total assembled from floats disagrees with the balances it was built from, and somebody eventually reconciles the two.
Authorization
OAuth2PasswordBearer In: header
Cookie Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Amounts to add up, in minor units at each currency's ledger scale.
IN-302. For showing one figure across balances held in several currencies.
Indicative only — it converts at the display rate and reserves nothing, so
never settle against what this returns. Quote POST /fx/quotes for that.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/b/v1/fx/display/total" \ -H "Content-Type: application/json" \ -d '{ "amounts": { "RWF": 15000000, "USD": 100000 } }'{ "currency": "string", "amount_minor": 0, "as_of": "2019-08-24T14:15:22Z", "complete": true, "may_settle": true, "rate_sources": [ "string" ], "legs": [ { "currency": "string", "amount_minor": 0, "converted_minor": 0, "rate": "string", "rate_source": "string" } ]}Balances as one figure GET
Every balance this business holds, added up in one currency. A heading, not a quote. The rates behind it are usually reference rates that no counterparty would deal at, which is fine for a number on a screen and disqualifying for a trade — `may_settle` says which you have.
The rates a screen would use GET
So a dashboard's per-row conversions agree with its heading. `null` for a pair nothing can price — the same honesty as leaving a currency out of a total, in the shape a front end wants.