Propose an exactly priced same-day bank FX purchase or sale
POST
/ledger/fx/ordersHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
book_idstringRequiredevidencestringRequiredforeign_minorintegerRequiredquote_observed_atstring · date-timeRequiredquote_referencestringRequiredquote_sha256stringRequiredquote_valid_untilstring · date-timeRequiredsidestringRequiredBuy or sell foreign units against USD
usd_minorintegerRequiredusd_per_foreign_majorstringRequiredvalue_datestring · dateRequiredA business date, YYYY-MM-DD
Returns
200 OK
actorstringRequiredatstring · date-timeRequiredauthority_sha256stringRequiredbook_idstringRequiredcancel_evidencestringOptionalcancelled_bystringOptionalcontent_sha256stringRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredapprovebooleanRequiredatstring · date-timeRequiredcontent_sha256stringRequiredevidencestringRequireddispatched_atstring · date-time or nullOptionalevidencestringRequiredforeign_minorintegerRequiredhold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
idstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
quote_observed_atstring · date-timeRequiredquote_referencestringRequiredquote_sha256stringRequiredquote_valid_untilstring · date-timeRequiredreceiptobject or nullOptionalReceipt attests both actual external legs. This is a bank bridge contract, not a claim that an ISO message or SWIFT acknowledgement proves settlement.
18 child attributes
advice_sha256stringRequiredbook_idstringRequiredcurrency_codestringRequiredexternal_account_refstringRequiredforeign_minorintegerRequiredforeign_referencestringRequiredkey_idstringRequiredmaster_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
occurred_atstring · date-timeRequiredorder_idstringRequiredorder_sha256stringRequiredprotocolstringRequiredsidestringRequiredsignaturestringRequiredstatusstringRequiredSettled, or cancelled with no cash movement
usd_cash_referencestringRequiredusd_minorintegerRequiredvalue_datestring · dateRequiredA business date, YYYY-MM-DD
receipt_authority_sha256stringOptionalsidestringRequiredBuy or sell foreign units against USD
statusstringRequiredusd_minorintegerRequiredusd_per_foreign_majorstringRequiredvalue_datestring · dateRequiredA business date, YYYY-MM-DD
verified_receipt_public_keystringOptionalErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503