Propose posting, returning or writing off a clearing file exception
/cards/clearing/exceptions/{id}/resolutionsVerified 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. Proposes how an open exception ends: post (the record to a named card of the same network, through the clearing or refund path), return (an issuer return instruction to the network; its later return credit or debit in a clearing file clears the suspense) or write_off (a debit item the bank absorbs to 5500, only once the file settlement carried it into suspense). A reason and 1 to 50 retained evidence references with lowercase SHA-256 are required. Nothing moves until a different reviewer approves the exact proposal. One pending proposal per exception; refused while a settlement of the exception's file awaits review or application. The same proposal by the same maker under the same key replays.
Path parameters
idstringRequiredHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
actionstringRequiredcard_idstringOptionalPost: the card the record belongs to
Example card_2tVh8nqLxq4GbDe0K1F6S9zRcWm
evidencearray of objectsRequired2 child attributes
referencestringRequiredsha256stringRequiredreasonstringRequiredReturns
200 OK
amount_minorintegerRequiredcard_account_idstringOptionalExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
content_sha256stringRequiredcreated_atstring · date-timeRequireddirectionstringRequiredexception_idstringRequiredexception_kindstringRequiredidstringRequiredordinalintegerRequiredproposed_bystringRequiredrecord_sha256stringRequiredrequestobjectRequiredResolutionRequest proposes how an exception ends.
4 child attributes
actionstringRequiredcard_idstringOptionalPost: the card the record belongs to
Example card_2tVh8nqLxq4GbDe0K1F6S9zRcWm
evidencearray of objectsRequired2 child attributes
referencestringRequiredsha256stringRequiredreasonstringRequiredresultobject or nullOptionalResolutionResult is what applying a resolution did.
7 child attributes
actorstringRequiredauthorization_idstringOptionalExample auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm
completed_atstring · date-timeRequireddetailstringOptionaljournal_idsarray of stringsRequiredoutcomestringRequiredPosted, returned, written_off, refused
returnobject or nullOptionalReturnReceipt 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-timeRequiredreferencestringRequiredsourcestringRequiredreviewobject or nullOptionalReview is a retained independent decision.
5 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequireddecisionstringRequiredreasonstringRequiredsettled_at_proposalbooleanRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503