Read a clearing file exception and its resolutions

GET/cards/clearing/exceptions/{id}

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. Reads one exception: kind (unknown_card, card_mismatch, refused, duplicate, duplicate_conflict, unmatched_reversal, over_reversal, unmatched_return), direction, amount, the record and its resolutions.

Path parameters

idstringRequired

Returns

200 OK

amount_minorintegerRequired

created_atstring · date-timeRequired

detailstringRequired

directionstringRequired

file_idstringRequired

Example achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired

kindstringRequired

networkstringRequired

recordobjectRequired

Record is one transaction in a clearing file.

24 child attributes

amount_minorintegerRequired

The cardholder billing and settlement amount in USD

approval_codestringOptional

arnstringRequired

authorization_refstringOptional

The network reference the authorisation carried; empty for an offline presentment

channelstringOptional

clearing_countintegerOptional

Multiple clearing: how many presentments the authorisation will have

clearing_sequenceintegerOptional

Multiple clearing: this presentment's number

conversionobject or nullOptional

Conversion is the currency conversion a presentment carries when the merchant's currency is not the cardholder's: the amount in the transaction currency and the rate the network applied. Rate is eight digits: the first is the number of decimal places, the other seven the rate (the ISO 8583 conversion-rate representation).

3 child attributes

ratestringRequired

source_amount_minorintegerRequired

source_currencystringRequired

currencystringRequired

fee_reasonstringOptional

interchange_minorintegerRequired

Signed: positive is paid to the issuer

mccstringOptional

merchant_citystringOptional

merchant_countrystringOptional

merchant_idstringOptional

merchant_namestringOptional

merchant_postal_codestringOptional

merchant_regionstringOptional

original_arnstringOptional

A reversal, a refund naming its purchase, or a return: the record it refers to

pan_tokenstringOptional

scheme_fee_minorintegerRequired

Signed: positive is paid by the issuer

sequenceintegerRequired

transaction_datestring · dateRequired

A business date, YYYY-MM-DD

typestringRequired

record_idstringRequired

resolutionsarray of objectsRequired

15 child attributes

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

statusstringRequired

Open, returned (awaiting the network's return credit or debit), resolved

Errors

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

400401403404409412413422424429500503