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
presentment_type	The type of presentment (First, Chargeback, Second or Arbitration)	string	Yes
transaction_type	Used to identify the type of service used	string	Yes
transaction_service	Numerical value associated with the transaction_type	string	Yes
reason_code	Typically used in dispute transactions to identify the reason of dispute. Will not be provided for Non Dispute Financials	string	Optional
reference_number	The Retrieval Reference Number for the network message if present/applicable	string	No - optional for Discover
sequence_number	The sequence number of the clearing record. Used to identify multiple clearing transactions associated to the same authorization. Default value is 0	string	Yes
date	Date of transaction as per clearing record: Visa: MMDD Mastercard / Discover: YYYY-MM-DD	string	Yes
authorization_code	A six position code. Supported values are: Spaces A to Z 0 to 9	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 Product base currency, with 6 decimal places	string	Yes
transaction_to_base_currency_rate	The rate applied to the transaction amount	string	No - optional for Discover
base_to_billing_currency_rate	The rate applied to calculate billing amount.	string	No - optional for Discover
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.	UUID	Yes
card_ending	The last four digits of the PAN.	string	Under Development
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
last_multiple_record	Where multiple clearings relate to one original authorization: "false" Further clearing records are expected "true" No further clearing records are expected	string	No
transaction_link_id	The Identifier of the transaction assigned by the Network to match to the Authorization	string	No
pan_entry_mode	Identifies the PAN entry method	string	Yes
cardholder_condition	Cardholder condition indicator provided during the authorization. Possible values are: “00” cardholder present, normal transaction “01” cardholder not present “02” cardholder present “03” card present, suspicious activity “05” cardholder present “08” cardholder not present, mail or telephone order “59” cardholder not present, electronic order (ecommerce) “71” cardholder present (Used in US only)	string	No
chip_indicator	Indicates if the Integrated Chip Card was used: “n”, “contact”, or “contactless”	string	Yes
pin_indicator	Indicates whether the PIN for the transaction was checked, its nature and the result: “n”, “offline_passed”, “offline_failed”, “online_passed”, or “online_failed”	string	Yes
dcc_indicator	Indicates whether Dynamic Currency Conversion took place, either “y”, or “n”	string	Yes
3ds_indicator	Indicates whether 3D-Secure Authentication took place for this transaction, either “y”, or “n”	string	Yes
eci	E-Commerce authentication indicator. For an e-commerce transaction, when available, identifies the various security measures applied before transaction submission. Possible values: "0" - Not applicable to the transaction "1" - Single transaction of mail/phone order "2" - Recurring transaction "3" - Instalment payment "4" - Mail/Telephone order type unknown “5” - Fully authenticated “6” - Authentication attempted but unsuccessful "7" - Authentication not attempted "8" - Non-secure transaction	string	No - optional for Discover
fees
amount	The amount of the fee.	string	No
type	The type of fee applied: fixed_fee variable_fee minimum_fee maximum_fee fx_markup_fee	string	No
revised_cardholder_billing_conversion_rate	This rate will be used instead of the cardholder_billing_conversion_rate where a fx_markup_fee is applicable	string	No. Only present for the fx_markup_fee
fees_amount	The total amount of fees to be charged. The revised_cardholder_billing_amount should be used. This is independent of any Network fees	string	No
revised_cardholder_billing_amount	The amount to be debited where there are fees included in the clearing	string	No
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
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
accounts
account_id	*Under Development* The identifier of the Account associated with the card_id	uuid	Yes for On Ledger Products
actual_balance	*Under Development* The actual balance prior to any entries. A minus figure indicates a debit balance	string	Yes for On Ledger Products
available_balance	*Under Development* The available balance prior to any entries. A minus figure indicates a debit balance	string	Yes for On Ledger Products
overdraft_value	*Under Development* The value of the agreed overdraft	string	Yes for On Ledger Products
authorized	*Under Development* The total amount of authorized spend to date	string	Yes for On Ledger Products