Convert on an unexpired quote the same customer was given on this account, once (fresh step-up; Idempotency-Key bound to the quote)

POST/accounts/{id}/fx-conversions

The customer who obtained the quote on this account converts it, with authentication within five minutes (step_up_required, 403) and an Idempotency-Key bound to the quote. Both accounts are checked again under their control locks, so a freeze, debit restriction or closure placed after the quote refuses the conversion before the ledger is asked. The instruction is retained with the customer's identity before the ledger posts one journal through the FX positions; a lost ledger response is recovered by the service's ledger key, and a replay of the customer's key answers the same conversion with 200. A quote converts once: another key for it is refused 409, and an expired quote is ledger.fx_quote_expired (409).

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

quote_idstringRequired

Returns

200 OK

actorstringRequired

conversionobjectRequired

Conversion is a posted customer conversion.

11 child attributes

business_datestring · dateRequired

A business date, YYYY-MM-DD

callerstringRequired

created_atstring · date-timeRequired

idstringRequired

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

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

quote_idstringRequired

rate_sheet_idstringRequired

source_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

target_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

created_atstring · date-timeRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired

kindstringRequired

Quote or conversion

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