Match and post a clearing file's records
/cards/clearing/files/{id}/processingVerified 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. Matches and posts every record without a disposition, in file order, through the existing clearing, refund and force post paths. The matching decision is captured before money moves, so a retry after a lost response repeats it. A refusal of the clearing path records the record as an exception; a failure a retry can finish (the ledger or accounts unavailable) stops the run with the records before it disposed, and the next call resumes. Processing a fully disposed file returns processed 0.
Path parameters
idstringRequiredHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Returns
200 OK
fileobjectRequiredIngestedFile is a retained clearing file.
11 child attributes
content_sha256stringRequireddispositionsobjectRequiredDispositions count a file's records by outcome.
5 child attributes
exceptionsintegerRequiredfeesintegerRequiredpendingintegerRequiredpostedintegerRequiredreturn_matchedintegerRequiredheaderobjectRequiredHeader is a file without its records.
7 child attributes
file_referencestringRequiredformatstringRequiredinstitution_idstringRequirednetworkstringRequiredprocessing_datestring · dateRequiredA business date, YYYY-MM-DD
settlement_datestring · dateRequiredA business date, YYYY-MM-DD
totalsobjectRequiredTotals are a file's trailer control totals.
8 child attributes
credit_countintegerRequiredcredit_minorintegerRequireddebit_countintegerRequireddebit_minorintegerRequiredinterchange_minorintegerRequirednet_settlement_minorintegerRequiredSigned: positive is paid to the issuer
scheme_fee_minorintegerRequiredtransaction_countintegerRequiredidstringRequiredreceived_atstring · date-timeRequiredreceived_bystringRequiredreplayedbooleanRequiredsettlement_idstringOptionalThe applied settlement reconciliation
size_bytesintegerRequiredsourcestringRequiredsource_referencestringRequiredprocessedintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503