Specifications
| JSON PATH | Description | Example | Format | Mandatory |
|---|---|---|---|---|
| file_date_and_time | UTC Date transmitted by processor Format: YYYY-MM-DD hmmss | 2023-01-15 011525 | string | Yes |
| total_number_of_records | Details how many records are included in the report | 1 | string | Yes |
| clearing_records | ||||
| program_name | Program Name associated with the card | CLOWD9 Travel | string | Yes |
| program_id | Program ID associated with the card. Generated by CLOWD9 represented as a GUID | 1028c3d4-06fc-401d-bbb2-9df36a06e06b | uuid | Yes |
| product_id | Product ID associated with card. Generated by CLOWD9 represented as a GUID | 0828c3d4-06fc-401d-bbb2-9df36a06e06b | uuid | Yes |
| card_id | The identifier associated to the card used represented as a GUID | f6ea4c96-db0b-4bd9-9d59-c745ea24b183 | uuid | Yes |
| card_ending | The last four digits of the PAN | 1234 | string | Yes |
| network_name | The network associated with the BIN and card_id | visa Mastercard Discover | string | Yes |
| clearing_outcome | Identifies the outcome of matching the clearing to the original authorization | 0 | string | Yes |
| clearing_cycle | Identifies the cycle file containing the clearing record. Note: This field is only applicable to Mastercard programs | 1 | string | No |
| authorizations | ||||
| transaction_id | The ID of the authorization identified to be matching the clearing record represented as a GUID | 1ae4af71-720d-4657-a742-24c7bc809985 | uuid | Yes |
| system_trace_audit_number | System Trace Audit Number of authorization | 105308 | string | Yes |
| retrieval_reference_number | The Retrieval Reference Number for the network message if present/applicable. Optional for Discover | 622445763665 | string | No |
| record_id_clearing | The unique identifier of the clearing record in the CLOWD9 database represented as a GUID | 8de0972-bd31-46ac-bb3c-014b2b438c55 | uuid | Yes |
| clearing_category | Identifies the category of a clearing transaction | sales_debit | string | Yes |
| presentment_type | The type of presentment (First, Chargeback, Second or Arbitration) | 0 | string | Yes |
| transaction_type | Numerical value associated with the transaction_type | 00 | string | Yes |
| transaction_service | The alpha value associated with the transaction_type | Goods and Services | string | Yes |
| from_account | Reserved for future use | 00 | string | No |
| to_account | Reserved for future use | 00 | string | No |
| direction | To identify if the amount is a Debit or Credit | Debit Credit | string | Yes |
| partial_indicator | The indicator of F (Full) or P (Partial) will only be populated for Dispute Financials | P | string | No |
| original_transaction_amount | The original amount of the transaction relating to the Disputed Financial in units represented in original_transaction_currency_code | 1000 | string | No |
| original_transaction_currency_code | The currency code for the original transaction amount for Disputed Financials | 978 | string | No |
| transaction_amount | The transaction amount in units represented in transaction_currency_code. For example 1000 = 10.00 | 225 | string | Yes |
| transaction_currency_code | The Numeric currency code in which transaction_amount is represented | 978 | string | Yes |
| reconciliation_amount | The reconciliation (settlement) in units represented in reconciliation_currency_code For example 1000 = 10.00 | 150 | string | Yes |
| reconciliation_currency_code | The currency code for the reconciliation amount | 826 | string | Yes |
| cardholder_billing_amount | The cardholder billing transaction amount in units, represented in billing_currency_code. For example 857 = 8.57 | 150 | string | Yes |
| cardholder_billing_currency_code | The currency code for the billing amount | 826 | string | Yes |
| cardholder_billing_conversion_rate | Rate provided by the Network represented as a string in decimal format. Domestic values will use the rate 1.0000000 or 1 | 0.8444444 | string | No |
| transaction_to_base_currency_rate | Rate if provided by the Network represented as a string in decimal format. This is used with the base_to_billing_currnecy_rate to calculate the cardholder_billing_converstion_rate. Note: If not provided, this will default to cardholder_billing_conversion_rate Domestic values will use the rate 1.0000000 or 1 | 0.8444444 | string | No - optional for Discover |
| base_to_billing_currency_rate | Rate if provided by the Network represented as a string in decimal format. This is used with the transaction_to_base_currency_rate to calculate the cardholder_billing_converstion_rate. Domestic values will use the rate 1.0000000 or 1 Note: If not provided, this will default to cardholder_billing_conversion_rate | 0.8444444 | string | No - optional for Discover |
| fees | ||||
| amount | The amount of the fee | 1000 | string | No |
| type | The type of fee applied: fixed_fee variable_fee minimum_fee maximum_fee markup_fee | minimum_fee | string | No |
| revised_cardholder_billing_conversion_rate | The new rate to be used for International transactions if applicable. The markup % is added to the Network conversion rate to calculate the markup_conversion_rate | 0.8666666 | string | No |
| fees_amount | The total amount of fees to be applied to the Network cardholder_billing_amount. The revised_cardholder_billing_amount will include the total fees. This is independent of any Network fees | 1000 | string | No |
| revised_cardholder_billing_amount | The total amount for Authorization | 10000 | string | No |
| date | Date of transaction as per clearing record. Visa: MMDD Mastercard/ Discover: YYYY-MM-DD | 1204 2024-12-04 | string | Yes |
| sequence_number | The sequence number of the clearing record. Used to identify multiple clearing transactions associated to the same authorization | 0 | string | No |
| reason_code | Typically used in dispute transactions to identify the reason of dispute | 00 | string | No |
| merchant_category_code | The Merchant Category Code (MCC) | 5542 | string | Yes |
| reference_number | Reference number of the clearing record, such as Acquirer Reference Number (ARN) | 080000100059 | string | Yes |
| acquiring_institution_id_code | The identification code of the Acquiring Institution | 00000999901 | string | No |
| forwarding_institution_id_code | The identification code of the Forwarding Institution | 999901 | string | No |
| authorization_code | A six digit code to indicate approval of a transaction | 239845 | string | Yes |
| card_acceptor_terminal_id | The identifier of the terminal where the transaction took place | 12345678 | string | No |
| card_acceptor_id | The identifier of the card acceptor entity | R-5411-GBR | string | Yes |
| card_acceptor_name | The name of the card acceptor entity | 7 CLOWD9 Street | string | Yes |
| card_acceptor_city | The city of the card acceptor entity | London | string | Yes |
| card_acceptor_post_code | The post code of the card acceptor entity | CL0 4DN | string | No |
| card_acceptor_country_code | The country of the card acceptor entity in Alpha 2-3 | GB GBR | string | Yes |
| licensed_product_identifier | Network Product Identifier | MDT MDS | string | No |
| network_file_reference | Reserved for future use | 001 | string | No |
| network_card_program_identifier | Identifies the Program Type | MDS | string | No |
| bin_type | Reserved for future use and will identify the BIN type | debit credit prepaid | string | No |
| product_type | Reserved for future use and will identify the Product type | consumer corporate | string | No |
| central_site_business_date | Central Processing Date from the clearing file. YYYY-MM-DD | 2023-01-14 | string | Yes |
| special_condition_indicator | Provides additional information regarding dispute financials and adjustments | 1, 2, 3 N, F, H, L | string | No - Optional for Discover |
| settlement_service_level_code | Numeric value (1) identifying type of settlement, Domestic or International | 1 | string | No - Optional for Discover |
| settlement_date | Date of settlement from the network YYYY-MM-DD | 2023-01-14 | string | Yes |
| additional_amount_type | Identifies the additional amount type | Cashback | string | No |
| additional_amount | The value of the additional amount in units. For example, 500 = 5.00 | 500 | string | No |
| additional_amount_currency_code | The transaction currency code of the amount | 826 | string | No |
| 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 | C000000000000123000 | string | Yes |
| transaction_link_id | The Identifier of the transaction assigned by the Network to match to the Authorization | 315204374419372 | string | Yes |
| chip_indicator | Indicates if the transaction was made using the Integrated Circuit Card (ICC Chip) i.e. Contact / Contactless. | contact | string | Yes |
| pin_indicator | Indicates whether PIN for the transaction was checked, its nature and the result. | y n | string | Yes |
| dcc_indicator | Indicates whether Dynamic Currency Conversion took place. | y n | string | Yes |
| 3ds_indicator | Indicates whether 3D-Secure Authentication took place for this transaction | y n | string | Yes |
| eci | E-Commerce authentication indicator "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 | 0 | string | No - optional for Discover |
| pan_entry_mode | Identifies the PAN entry method | 101 | string | No - Optional for Discover |
| 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) | 00 | string | Yes |
Updated 13 days ago
Did this page help you?