Corgi BankDocumentation
OpenAPI

Propose a source-bound card scheme dispute with signed eligibility evidence

POST/cards/schemes/cases

Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.

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

authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

claim_minorintegerRequired
eligibilityobjectRequired
2 child attributes
payloadobjectRequired

SigningBytes is normative. The processor signs actual facts from its network adapter; current issued_at attests an independently retained effective_at.

27 child attributes
acknowledged_instruction_idstringOptional
acknowledged_instruction_sha256stringOptional
allowed_actionsarray of stringsOptional
amount_minorintegerRequired

Eligibility amount or signed actual movement

authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

case_idstringOptional

Example case_2tVh8nqLxq4GbDe0K1F6S9zRcWm

case_sha256stringOptional
currencystringRequired
effective_atstring · date-timeRequired
evidenceobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
issued_atstring · date-timeRequired
key_idstringRequired
kindstringRequired

Eligibility, network, cash

networkstringRequired
network_case_referencestringOptional
original_journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

outcomestringOptional
reason_codestringOptional
receipt_referencestringRequired
respond_bystring · date-timeOptional
rules_evidenceobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
rules_versionstringRequired
sequenceintegerRequired
settlement_referencestringOptional
stagestringOptional
submit_bystring · date-timeOptional
versionstringRequired
signaturestringRequired
evidencearray of objectsRequired
2 child attributes
referencestringRequired
sha256stringRequired

Returns

200 OK

activationobject or nullOptional
4 child attributes
activated_atstring · date-timeRequired
instruction_sha256stringRequired
pinobject or nullOptional
13 child attributes
actorstringRequired
amount_minorintegerRequired
content_sha256stringRequired
created_atstring · date-timeRequired
debit_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journalobjectRequired
2 child attributes
journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

keystringRequired
journal_sha256stringRequired
proposed_bystringRequired
purposestringRequired
reference_idstringRequired
reviewed_bystringRequired
source_idstringRequired
source_refstringRequired
stateobjectRequired
15 child attributes
allocated_minorintegerRequired
allowed_actionsarray of stringsOptional
net_recovery_minorintegerRequired
network_case_referencestringOptional
network_effective_atstring · date-timeOptional
network_sequenceintegerRequired
outcomestringOptional
payable_minorintegerRequired
pending_instruction_idstringOptional
pending_instruction_sha256stringOptional
receivable_minorintegerRequired
respond_bystring · date-timeOptional
settled_cash_minorintegerRequired
stagestringRequired
unallocated_recovery_minorintegerRequired
content_sha256stringRequired
created_atstring · date-timeRequired
eligibilityobjectRequired
4 child attributes
config_sha256stringRequired
keyobjectRequired
5 child attributes
idstringRequired
networkstringRequired
public_keystringRequired
valid_fromstring · date-timeRequired
valid_throughstring · date-timeRequired
receiptobjectRequired
2 child attributes
payloadobjectRequired

SigningBytes is normative. The processor signs actual facts from its network adapter; current issued_at attests an independently retained effective_at.

27 child attributes
acknowledged_instruction_idstringOptional
acknowledged_instruction_sha256stringOptional
allowed_actionsarray of stringsOptional
amount_minorintegerRequired

Eligibility amount or signed actual movement

authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

case_idstringOptional

Example case_2tVh8nqLxq4GbDe0K1F6S9zRcWm

case_sha256stringOptional
currencystringRequired
effective_atstring · date-timeRequired
evidenceobjectRequired
issued_atstring · date-timeRequired
key_idstringRequired
kindstringRequired

Eligibility, network, cash

networkstringRequired
network_case_referencestringOptional
original_journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

outcomestringOptional
reason_codestringOptional
receipt_referencestringRequired
respond_bystring · date-timeOptional
rules_evidenceobjectRequired
rules_versionstringRequired
sequenceintegerRequired
settlement_referencestringOptional
stagestringOptional
submit_bystring · date-timeOptional
versionstringRequired
signaturestringRequired
received_atstring · date-timeRequired
idstringRequired
proposed_bystringRequired
requestobjectRequired
4 child attributes
authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

claim_minorintegerRequired
eligibilityobjectRequired
2 child attributes
payloadobjectRequired

SigningBytes is normative. The processor signs actual facts from its network adapter; current issued_at attests an independently retained effective_at.

27 child attributes
acknowledged_instruction_idstringOptional
acknowledged_instruction_sha256stringOptional
allowed_actionsarray of stringsOptional
amount_minorintegerRequired

Eligibility amount or signed actual movement

authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

case_idstringOptional

Example case_2tVh8nqLxq4GbDe0K1F6S9zRcWm

case_sha256stringOptional
currencystringRequired
effective_atstring · date-timeRequired
evidenceobjectRequired
issued_atstring · date-timeRequired
key_idstringRequired
kindstringRequired

Eligibility, network, cash

networkstringRequired
network_case_referencestringOptional
original_journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

outcomestringOptional
reason_codestringOptional
receipt_referencestringRequired
respond_bystring · date-timeOptional
rules_evidenceobjectRequired
rules_versionstringRequired
sequenceintegerRequired
settlement_referencestringOptional
stagestringOptional
submit_bystring · date-timeOptional
versionstringRequired
signaturestringRequired
evidencearray of objectsRequired
2 child attributes
referencestringRequired
sha256stringRequired
reviewobject or nullOptional
5 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionstringRequired
reasonstringRequired
sourceobjectRequired
12 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amount_minorintegerRequired
card_idstringRequired

Example card_2tVh8nqLxq4GbDe0K1F6S9zRcWm

card_kindstringRequired
clearing_operation_keystringRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

debit_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journalobjectRequired
18 child attributes
adjusts_periodstringOptional

A sealed period this journal corrects, YYYY-MM

approved_bystringOptional
backdatedbooleanOptional

Effective_date is before posting_date (read only)

committed_atstring · date-timeOptional
effective_datestring · dateRequired

A business date, YYYY-MM-DD

entriesarray of objectsRequired
4 child attributes
amountintegerRequired

Minor units of the currency (cents for USD)

currency_codestringRequired

ISO 4217 code

directionstringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

fx_legsarray of objectsOptional

FXLegs is read only: the legs of a cross-currency journal the ledger's own conversion and close commands posted. A caller's posting never carries them.

7 child attributes
currency_codestringRequired
equivalent_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

native_amountintegerRequired
position_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

rate_sheet_idstringRequired
usd_equivalent_amountintegerRequired
usd_per_foreign_majorstringRequired
idstringOptional
kindstringRequired
posted_bystringOptional
posting_datestring · dateOptional

A business date, YYYY-MM-DD

protected_command_idstringOptional
reasonstringOptional

Required on a backdated journal

release_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
reversal_ofstringOptional
source_refstringRequired
source_servicestringRequired
journal_keystringRequired
journal_sha256stringRequired
networkstringRequired
network_refstringRequired
stateobject or nullOptional
15 child attributes
allocated_minorintegerRequired
allowed_actionsarray of stringsOptional
net_recovery_minorintegerRequired
network_case_referencestringOptional
network_effective_atstring · date-timeOptional
network_sequenceintegerRequired
outcomestringOptional
payable_minorintegerRequired
pending_instruction_idstringOptional
pending_instruction_sha256stringOptional
receivable_minorintegerRequired
respond_bystring · date-timeOptional
settled_cash_minorintegerRequired
stagestringRequired
unallocated_recovery_minorintegerRequired
unclaimed_original_minorintegerRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close