Corgi BankDocumentation
OpenAPI

Read the approved customer rate sheet pricing conversions now (conversion service)

GET/ledger/fx/customer-rate-sheet

The conversion service (a service token with ledger:fx:convert, no API key) reads the approved, valid, unwithdrawn customer sheet a quote asked for now would be priced on; every other identity is 403. ledger.fx_rate_unavailable (409) when no sheet is valid. It is the same sheet POST /ledger/fx/quotes prices from, so the rate a customer is shown and the rate their quote is struck at come from one record.

Returns

200 OK

actorstringRequired
atstring · date-timeRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

content_sha256stringRequired
daily_customer_limit_usd_minorintegerOptional
decisionobject or nullOptional
5 child attributes
actorstringRequired
approvebooleanRequired
atstring · date-timeRequired
content_sha256stringRequired
evidencestringRequired
evidencestringRequired
idstringRequired
linesarray of objectsRequired
5 child attributes
currency_codestringRequired
customer_buy_spread_bpsintegerOptional

The customer buys the currency: ask = mid × (1 + bps/10000)

customer_sell_spread_bpsintegerOptional

The customer sells the currency: bid = mid × (1 − bps/10000)

max_conversion_usd_minorintegerOptional
usd_per_foreign_majorstringRequired
policy_referencestringRequired
purposestringRequired
rate_snapshot_idstringRequired
rate_snapshot_sha256stringRequired
statusstringRequired

Proposed, approved or rejected

valid_fromstring · date-time or nullOptional
valid_untilstring · date-time or nullOptional

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close