Corgi BankDocumentation
OpenAPI

Quote a conversion from this account to another of the customer's deposit accounts in a different currency, on the bank's approved customer rate sheet (the customer's own instruction; Idempotency-Key bound to the request)

POST/accounts/{id}/fx-quotes

The customer's own instruction: a customer token (not an API key) with initiate permission on this account and on target_account_id; staff and services are refused 403. Both accounts are open, belong to the same primary customer, are held under an individual, joint or payable-on-death title as checking, savings or money market deposits, and are in different currencies; the source must be withdrawable and not debit-restricted. Exactly one of source_amount or target_amount is fixed, in its own account currency's minor units (JPY has none, KWD three). The accounts service asks the ledger under its ledger:fx:convert credential alone: the ledger prices on the treasury's independently approved customer sheet, applies its per-conversion and daily customer limits (ledger.fx_limit_exceeded, 422) and refuses a currency it does not hold (ledger.currency_unsupported, 422) or the absence of a valid sheet (ledger.fx_rate_unavailable, 409). The quote expires after the ledger's FX_QUOTE_TTL. The Idempotency-Key is scoped to the customer and account and bound to the request body; a replay returns the retained quote with 200.

Path parameters

idstringRequired

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

source_amountintegerOptional
target_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

target_amountintegerOptional

Returns

200 OK

actorstringRequired
created_atstring · date-timeRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired
kindstringRequired

Quote or conversion

quoteobjectRequired

Quote is a priced, short-lived offer on the current approved customer sheet.

13 child attributes
callerstringRequired
created_atstring · date-timeRequired
daily_limit_usd_minorintegerRequired
daily_used_usd_minorintegerRequired
expires_atstring · date-timeRequired
idstringRequired
ownerstringRequired
priceobjectRequired

ConversionPrice is the exact result of pricing a conversion on a customer sheet.

10 child attributes
customer_ratestringRequired

Target major units per source major unit, ten decimals, for display only

source_amountintegerOptional
source_currency_codestringRequired
source_usd_equivalentintegerRequired
source_usd_per_majorstringRequired
spread_usd_minorintegerRequired
target_amountintegerOptional
target_currency_codestringRequired
target_usd_equivalentintegerRequired
target_usd_per_majorstringRequired
rate_sheet_idstringRequired
source_amountintegerOptional
source_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

target_amountintegerOptional
target_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

quote_idstringRequired
source_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

target_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Errors

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

400401403404409412413422424429500503

to move to open esc to close