Take a parked receipt for one approved protected accounts command before it posts

POST/transfers/retirement-receipts/{rail}/{receipt}/claims

Internal accounts service handoff. Takes a claimable receipt for one approved custodian_transfer_in command before its protected journal posts, for the receipt's exact account and amount; replaying the same command's terms returns the live claim. While claimed or applied, operators cannot apply, review or return the receipt.

Path parameters

railstringRequired

receiptstringRequired

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

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amount_minorintegerRequired

command_idstringRequired

transfer_idstringRequired

Example acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amount_minorintegerRequired

claimed_atstring · date-timeRequired

claimed_bystringRequired

command_idstringRequired

currencystringRequired

idstringRequired

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_keystringRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

railstringRequired

receipt_idstringRequired

Example achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm

resolved_atstring · date-time or nullOptional

statusstringRequired

transfer_idstringRequired

Example acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Errors

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

400401403404409412413422424429500503