Independently fence an unposted estate instruction or recover already committed money

POST/accounts/{id}/estate-disbursements/{command}/cancellations

Fresh independent estate reviewer must resolve/fence the svc_accounts-owned ledger cancellation key before cancelling. Already committed money is recovered as executed. Retry must match exact retained reviewer/key/evidence.

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

decedent_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decided_atstring · date-time or nullOptional

decided_bystringOptional

executed_atstring · date-time or nullOptional

idstringRequired

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ownership_revisionintegerRequired

paymentsarray of objectsRequired

4 child attributes

amount_minorintegerRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ownership_revisionintegerRequired

recipientobjectRequired

4 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

beneficiary_indexintegerRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

identity_evidenceobjectRequired

3 child attributes

evidence_refstringRequired

evidence_sha256stringRequired

reasonstringRequired

proposed_atstring · date-timeRequired

proposed_bystringRequired

requestobjectRequired

17 child attributes

amount_minorintegerRequired

authority_refstringRequired

authority_sha256stringRequired

authority_typestringRequired

Pod_contract, letters_testamentary, letters_of_administration

authority_valid_untilstring · date-timeRequired

death_report_idstringRequired

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

death_revisionintegerRequired

evidence_refstringRequired

evidence_sha256stringRequired

executor_customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

jurisdictionstringRequired

minimum_recipient_ageintegerRequired

policy_refstringRequired

policy_sha256stringRequired

reasonstringRequired

recipientsarray of objectsRequired

4 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

beneficiary_indexintegerRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

identity_evidenceobjectRequired

3 child attributes

evidence_refstringRequired

evidence_sha256stringRequired

reasonstringRequired

restriction_idstringRequired

source_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

statusstringRequired

Errors

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

400401403404409412413422424429500503