Clearing Messages
| Field | Description | Format | Mandatory |
|---|---|---|---|
| message_type | "clearing" | string | Yes |
| message_qualifier | "notification" | string | Yes |
| clearing | Information about clearing transactions | ||
| > > clearing_category | Identifies the category of a clearing transaction | string | Yes |
| > > transaction_type | The clearing transaction type. “1” - First presentment of clearing transaction “9” - Dispute | string | Yes |
| > > reason_code | Typically used in dispute transactions to identify the reason of dispute. Default is 00 | string | Yes |
| > > reference_number | Reference number of the clearing record provided by the Network | string | Yes |
| > > sequence_number | The sequence number of the clearing record. Used to identify multiple clearing transactions associated to the same authorization | string | Yes |
| > > date | Date of transaction as per clearing record | string(MMDD) | Yes |
| > > authorization_code | Authorization code associated with the original authorization | string(6) | Yes |
| > > cardholder_billing_amount | The cardholder billing transaction amount, represented in cardholder_billing_currency_code | string | Yes |
| > > cardholder_billing_currency_code | The cardholder billing currency code | string(3) | Yes |
| > > transaction_amount | The transaction amount, represented in transaction_currency_code | string | Yes |
| > > cashback_amount | The amount of cashback included in the transaction, represented in transaction_currency_code | string | No |
| > > transaction_currency_code | The transaction currency code | string(3) | Yes |
| > > interchange_fee | Represents the interchange fee amount, beginning with “C” for Credit and “D” for Debit. This is represented in the issuer’s base currency, with 6 decimal places | string | Yes |
| > > transaction_to_base_currency_rate | The rate applied to the transaction amount | string | Yes |
| > > base_to_billing_currency_rate | The rate applied to calculate billing amount | string | Yes |
| > > cardholder_billing_conversion_rate | The cardholder billing conversion rate | string | Yes |
| > > card_acceptor_name | The name of the merchant as received in the clearing record | string | Yes |
| > > card_id | The ID of the card related to the clearing record | uuif | Yes |
| > > clearing_outcome | Identifies the outcome of matching the clearing to the original authorization: “0” - Matching auth found, amounts match, “1” - Matching auth found, amounts mismatch within network rules, “8” - Matching auth found, amounts mismatch not within network rules, or “9” - Matching auth not found | string | Yes |
| > > record_id_clearing | The unique identifier of the clearing record in the CLOWD9 database | uuid | Yes |
| > > authorizations | Carries information about the authorization(s) related to the clearing message. Note: This is a repeating field and may contain reference to more than one authorization transaction | Yes | |
| > > > > auth_transaction_id | The ID of the authorization identified matching the clearing record | uuid | No |
| > > > > retrieval_reference_number | Retrieval Reference Number of authorization | string | No |
| > > > > system_trace_audit_number | System Trace Audit Number of authorization | string | No |
Updated 1 day ago