Corgi BankDocumentation
OpenAPI

Apply an approved clearing exception resolution

POST/cards/clearing/resolutions/{id}/applications

Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Carries out the exact approved resolution once; a retry returns the recorded result. A posting the clearing path refuses ends as refused and the exception stays open for another proposal. A posting after the file settled relieves the suspense: a debit through a claimed settlement batch from 2320, a credit by 2320 to 2310. A return retains its instruction before sending it; the acknowledgement is not the money.

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

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

content_sha256stringRequired

Returns

201 Created

amount_minorintegerRequired
card_account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

content_sha256stringRequired
created_atstring · date-timeRequired
directionstringRequired
exception_idstringRequired
exception_kindstringRequired
idstringRequired
ordinalintegerRequired
proposed_bystringRequired
record_sha256stringRequired
requestobjectRequired

ResolutionRequest proposes how an exception ends.

4 child attributes
actionstringRequired
card_idstringOptional

Post: the card the record belongs to

Example card_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidencearray of objectsRequired
2 child attributes
referencestringRequired
sha256stringRequired
reasonstringRequired
resultobject or nullOptional

ResolutionResult is what applying a resolution did.

7 child attributes
actorstringRequired
authorization_idstringOptional

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

completed_atstring · date-timeRequired
detailstringOptional
journal_idsarray of stringsRequired
outcomestringRequired

Posted, returned, written_off, refused

returnobject or nullOptional

ReturnReceipt is the network's acknowledgement of a return instruction. An acknowledgement is not the money: the later return credit or debit in a clearing file is.

3 child attributes
accepted_atstring · date-timeRequired
referencestringRequired
sourcestringRequired
reviewobject or nullOptional

Review is a retained independent decision.

5 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionstringRequired
reasonstringRequired
settled_at_proposalbooleanRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close