Read a wire or ACH credit parked on transit for a protected IRA or HSA, as the accounts service matches it to an inbound custodian transfer

GET/transfers/retirement-receipts/{rail}/{receipt}

Internal: only the accounts service identity with payments:retirement-receipts and no API key. Reads a wire or ACH credit addressed to a protected IRA or HSA, which payments parks on transit GL 2320 instead of posting. claimable is true only while the cash waits there for that reason alone (or for that reason after the sanctions reviewer released a screened credit to it), with no return, operator review or apply under way and no live claim.

Path parameters

railstringRequired

receiptstringRequired

Returns

200 OK

account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

account_numberstringRequired

amount_minorintegerRequired

claimobject or nullOptional

RetirementReceiptClaim takes a receipt for one protected accounts command.

15 child attributes

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

claimablebooleanRequired

currencystringRequired

funding_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

railstringRequired

reasonstringOptional

receipt_idstringRequired

Example achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm

received_onstring · dateRequired

A business date, YYYY-MM-DD

referencestringRequired

sender_namestringRequired

sender_routingstringRequired

statusstringRequired

Errors

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

400401403404409412413422424429500503