Corgi BankDocumentation
OpenAPI

Execute or repair a reviewed retirement command through a journal-bound protected ledger proof

POST/accounts/{id}/retirement-commands/{command}/executions

Captures immutable exact journal and capacity reservation before posting. Ledger independently verifies protected account IDs, full request hash and command/key against accounts online, enforcing available funds on both accounts. Retry uses the same execution key/evidence and recovers the original receipt after lost acknowledgment. No external settlement is fabricated.

Path parameters

idstringRequired
commandstringRequired

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

evidence_refstringRequired
evidence_sha256stringRequired
reasonstringRequired

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

cash_datestring · dateOptional

A business date, YYYY-MM-DD

conversion_rmdarray of objectsOptional
7 child attributes
bank_command_idsarray of stringsRequired
bank_paid_minorintegerRequired
outside_paid_minorintegerRequired
required_minorintegerRequired
review_idstringRequired
review_sha256stringRequired
tax_yearintegerRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decedent_customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decided_atstring · date-time or nullOptional
decided_bystringOptional
distribution_codestringOptional
executed_atstring · date-time or nullOptional
gross_minorintegerRequired
idstringRequired
inbound_receiptobject or nullOptional

InboundReceipt is the matched receipt as the command relies on it.

12 child attributes
amount_minorintegerRequired
confirmation_idstringRequired
delivering_referencestringRequired
distribution_datestring · dateRequired

A business date, YYYY-MM-DD

outstanding_at_year_endbooleanRequired
railstringRequired
receipt_idstringRequired

Example achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm

received_onstring · dateRequired

A business date, YYYY-MM-DD

referencestringRequired
sender_namestringRequired
sender_routingstringRequired
transfer_idstringRequired

Example acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ira_typestringOptional
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

origin_cash_datestring · dateOptional

A business date, YYYY-MM-DD

other_ownership_revisionintegerRequired
ownership_revisionintegerRequired
proposed_atstring · date-timeRequired
proposed_bystringRequired
recipientsarray of objectsOptional
7 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amount_minorintegerRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

distribution_codestringOptional
inheritance_idstringRequired
ownership_revisionintegerRequired
share_bpsintegerRequired
requestobjectRequired
22 child attributes
beneficiary_paymentobject or nullOptional

BeneficiaryPaymentEvidence supports full cash settlement to the sole adult individual named in the original IRA title, with death before the owner's RBD.

15 child attributes
authority_refstringRequired
authority_sha256stringRequired
authority_valid_untilstring · date-timeRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

death_report_idstringRequired

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

death_revisionintegerRequired
election_refstringRequired
election_sha256stringRequired
jurisdictionstringRequired
minimum_recipient_ageintegerRequired
policy_refstringRequired
policy_sha256stringRequired
restriction_idstringRequired
rmd_policy_idstringRequired
tax_rule_idstringRequired
conversionobject or nullOptional

ConversionEvidence authorizes only an immediate same-bank cash conversion. It does not authorize a recharacterization, inherited transfer or 60-day deposit.

7 child attributes
as_of_datestring · dateRequired

A business date, YYYY-MM-DD

authority_refstringRequired
instruction_refstringRequired
instruction_sha256stringRequired
policy_sha256stringRequired
rmd_policy_idstringRequired
rmd_review_idsarray of stringsOptional
custodianobject or nullOptional

CustodianTransferEvidence retains the successor trustee's acceptance of a direct transfer that involves no payment to the owner or beneficiary. ReceivingPlanType is the plan the successor trustee accepted into, which must be the source's own plan type.

14 child attributes
acceptance_refstringRequired
acceptance_sha256stringRequired
inheritance_idstringOptional
inherited_rmd_review_idstringOptional
inherited_titlebooleanRequired
instruction_refstringRequired
instruction_sha256stringRequired
payee_referencestringRequired
receiving_account_referencestringRequired
receiving_custodianstringRequired
receiving_plan_typestringRequired
receiving_title_sha256stringRequired
rmd_policy_idstringOptional
rmd_review_idsarray of stringsOptional
earnings_minorintegerOptional

Evidenced signed net income attributable, return_excess only

eligibility_idstringRequired
evidence_refstringRequired
evidence_sha256stringRequired
inbound_transferobject or nullOptional

InboundReceiptEvidence names the payments receipt a custodian_transfer_in applies.

3 child attributes
railstringRequired

Wire or ach

receipt_idstringRequired

Example achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm

transfer_idstringRequired

Example acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm

income_tax_yearintegerOptional

Return_excess income attribution, reviewed against tax code

inheritanceobject or nullOptional

InheritanceCommandEvidence authorizes death_transfer and death_distribution (every captured beneficiary in title order) and inherited_distribution (one).

8 child attributes
account_idsarray of stringsOptional
authority_refstringOptional
authority_sha256stringOptional
authority_valid_untilstring · date-timeRequired
inheritance_idsarray of stringsRequired
instruction_refstringRequired
instruction_sha256stringRequired
tax_rule_idstringOptional
kindstringRequired

Contribution, distribution, return_excess, rollover, trustee_transfer, conversion, beneficiary_distribution, death_transfer, death_distribution, inherited_distribution, recharacterization, custodian_transfer, custodian_transfer_in

medical_use_attestedbooleanOptional

Evidence only: trustee does not determine HSA expense deductibility

movementobject or nullOptional
10 child attributes
authority_refstringRequired
instruction_refstringRequired
instruction_sha256stringRequired
ordinary_owner_cash_onlybooleanRequired
outside_inventory_as_ofstring · dateOptional

A business date, YYYY-MM-DD

outside_inventory_completebooleanRequired
outside_originalobject or nullOptional

OutsideDistribution is another custodian's actual distribution that the owner received and is redepositing here, evidenced by that custodian's own statement.

8 child attributes
custodianstringRequired
distribution_datestring · dateRequired

A business date, YYYY-MM-DD

gross_minorintegerRequired
ira_typestringOptional
referencestringRequired
statement_refstringRequired
statement_sha256stringRequired
wrapperstringRequired
outside_rolloversarray of objectsOptional
6 child attributes
amount_minorintegerRequired
contribution_datestring · dateRequired

A business date, YYYY-MM-DD

distribution_datestring · dateRequired

A business date, YYYY-MM-DD

original_bank_command_idstringOptional
referencestringRequired
wrapperstringRequired
policy_sha256stringRequired
rmd_policy_idstringOptional
original_command_idstringOptional

The bank's original regular contribution

other_account_idstringRequired

Same-owner ordinary account; trustee_transfer/conversion name the protected destination

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

principal_minorintegerRequired
reasonstringRequired
recharacterizationobject or nullOptional

RecharacterizationEvidence retains the owner's election and the reviewed net income attributable; the trustee does not calculate that income here.

6 child attributes
authority_refstringRequired
earnings_refstringRequired
earnings_sha256stringRequired
instruction_refstringRequired
instruction_sha256stringRequired
policy_sha256stringRequired
tax_yearintegerRequired
withholding_bpsinteger or nullOptional

Nil uses reviewed traditional-IRA nonperiodic default

withholding_election_refstringOptional
withholding_election_sha256stringOptional
statusstringRequired
taxable_minorinteger or nullOptional
taxable_undeterminedbooleanRequired
withheld_minorintegerRequired
wrapperstringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close