Specifications

JSON PATHDescriptionExample
file_date_and_timeUTC Date transmitted by processor Format: YYYY-MM-DD hmmss2023-01-15 011525
total_number_of_recordsDetails how many records are included in the report1
clearing_records
clearing.program_nameProgram Name associated with the cardCLOWD9 Travel
clearing_records.program_idProgram ID associated with the card. Generated by CLOWD9 represented as a GUID1028c3d4-06fc-401d-bbb2-9df36a06e06b
clearing_records.product_idProduct ID associated with card. Generated by CLOWD9 represented as a GUID0828c3d4-06fc-401d-bbb2-9df36a06e06b
clearing_records.card_idThe identifier associated to the card used represented as a GUIDf6ea4c96-db0b-4bd9-9d59-c745ea24b183
clearing_records.network_nameThe network associated with the BIN and card_idVisa
Mastercard
clearing_records.clearing_outcomeIdentifies the outcome of matching the clearing to the original authorization0
clearing_records.clearing_cycleIdentifies the cycle file containing the clearing record.
Note: This field is only applicable to Mastercard programs
1
clearing_records.authorizations
clearing_records.authorizations.transaction_idThe ID of the authorization identified to be matching the clearing record represented as a GUID1ae4af71-720d-4657-a742-24c7bc809985
clearing_records.authorizations.system_trace_audit_numberSystem Trace Audit Number of authorization105308
clearing_records.authorizations.retrieval_reference_numberRetrieval Reference Numbers of authorization74541834244288088530027
12345678910
clearing_records.record_id_clearingThe unique identifier of the clearing record in the CLOWD9 database represented as a GUID8de0972-bd31-46ac-bb3c-014b2b438c55
clearing_records.clearing_categoryIdentifies the category of a clearing transactionsales_debit
https://docs.clowd9.io/docs/presentment-typeThe presentment type1
clearing_records.from_accountReserved for future use and defaults to 0000
clearing_records.to_accountReserved for future use and defaults to 0000
clearing_records.directionTo identify if the amount is a Debit or CreditDebit
Credit
clearing_records.transaction_amountThe transaction amount in units represented in transaction_currency_code. For example 1000 = 10.00225
clearing_records.transaction_currency_codeThe transaction currency code978
clearing_records.reconciliation_amountThe actual billing amount in units from the clearing record.
For example 1000 = 10.00
150
clearing_records.reconciliation_currency_codeThe currency code of the reconciliation amount826
clearing_records.cardholder_billing_amountThe cardholder billing transaction amount in units, represented in billing_currency_code.
For example 857 = 8.57
150
clearing_records.cardholder_billing_currency_codeBilling_currency_code826
clearing_records.cardholder_billing_conversion_rateRate provided by the Network represented as a string in decimal format
Domestic values will use the rate 1.0000000 or 1
0.8444444
clearing_records.transaction_to_base_currency_rateRate 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
clearing_records.base_to_billing_currency_rateRate 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
clearing_records.dateDate of transaction as per clearing record. YYYY-MM-DD2024-01-22
clearing_records.sequence_numberThe sequence number of the clearing record. Used to identify multiple clearing transactions associated to the same authorization001
clearing_records.reason_codeTypically used in dispute transactions to identify the reason of dispute00
clearing_records.merchant_category_codeThe Merchant Category Code (MCC)5542
clearing_records.reference_numberReference number of the clearing record, such as Acquirer Reference Number (ARN)080000100059
clearing_records.acquiring_institution_id_codeThe identification code of the Acquiring Institution00000999901
clearing_records.forwarding_institution_id_codeThe identification code of the Forwarding Institution999901
clearing_records.authorization_codeFollowing successful matching, the value will be that of the original authorization.
If the clearing record cannot be matched, the field will not be populated
239845
clearing_records.card_acceptor_terminal_idThe identifier of the terminal where the transaction took place12345678
clearing_records.card_acceptor_idThe identifier of the card acceptor entityR-5411-GBR
clearing_records.card_acceptor_nameThe name of the card acceptor entity7 CLOWD9 Street
clearing_records.card_acceptor_cityThe city of the card acceptor entityLondon
clearing_records.card_acceptor_post_codeThe post code of the card acceptor entityCL0 4DN
clearing_records.card_acceptor_country_codeThe country of the card acceptor entityUSA
SG
clearing_records.licensed_product_identifierNetwork Product IdentifierMDT
MDS
clearing_records.network_file_referenceReserved for future use001
clearing_records.network_card_program_identifierIdentifies the Program TypeMDS
clearing_records.bin_typeReserved for future use and will identify the BIN typedebit
credit
prepaid
clearing_records.product_typeReserved for future use and will identify the Product typeconsumer
corporate
clearing_records.central_site_business_dateCentral Processing Date from the clearing file. YYYY-MM-DD2023-01-14
clearing_records.special_condition_indicatorProvides additional information regarding dispute financials and adjustments1, 2, 3
N, F, H, L
clearing_records.settlement_service_level_codeNumeric value (1) identifying type of settlement, Domestic or International1
clearing_records.settlement_dateDate of settlement from the network YYYY-MM-DD2023-01-14
clearing_records.additional_amount_typeIdentifies the additional amount typeCashback
clearing_records.additional_amountThe value of the additional amount in units. For example 500 = 5.00500
clearing_records.additional_amount_currency_codeThe transaction currency code of the amount826
clearing_records.interchange_feeRepresents 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 placesC000000000000123000