Reversal Notification
Reversal Notification - Full & Partial
| Field | Description | Format | Mandatory |
|---|---|---|---|
| message_type | “reversal” | string | Yes |
| message_qualifier | “notification” | string | Yes |
| source | Identifies the source of the message, such as the network. | string | Yes |
| card | Contains vital information about the card as held in the CLOWD9 database. | ||
| card_id | The ID of the card related to the transaction or message. | uuid | Yes |
| card_form_factor | Form factor of card. Possible values: “physical” “virtual” | string | Yes |
| card_status | Shows the current status of the card that is sent during the authorization process or following a successful status change.Supported card status types:"inactive" “active” "administrative" “destroyed” "fraud" "freeze" "lost" “stolen”Status generated by CLOWD9:"expired" "risk" | string | Yes |
| card_ending | The last four digits of the PA. | string | Under Development |
| customer | Contains vital information about the customer as held in the CLOWD9 database. | Yes | |
| customer_id | The ID of the customer associated with the card. | uuid | Yes |
| customer_external_ref | External ID of the customer associated with the card, if known. | string | No |
| transaction | Details of the transaction. | ||
| auth_type | Used to identify the type of an authorization message if provided:"preauth" "incremental" "completion" "recurring_initial" "recurring_subsequent" | string | Yes |
| credential_on_file | Indicates if the transaction was a credential on file transaction. Possible values:“y” "n" | string | Yes |
| reversal_type | "full" "partial" | 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 |
| transaction_id | The unique identifier of the transaction log entry in the CLOWD9 database. | uuid | Yes |
| system_trace_audit_number | The System Trace Audit Number for the network message. | string | Yes |
| retrieval_reference_number | The Retrieval Reference Number for the network message. | string | Yes |
| network_transaction_id | The unique identifier of the transaction assigned by the network. | string | Yes |
| transmission_date | The date the message was received, as indicated in the message from the network. | string (MMDD) | Yes |
| transmission_time | The time the message was received, as indicated in the message from the network. | string (hhmmss) | Yes |
| transaction_local_date | The local date at the point of transaction origination. | string (MMDD) | No |
| transaction_local_time | The local time at the point of transaction origination. | string (hhmmss) | No |
| transaction_amount | The amount to be authorized with the transaction. Can be “0” for non-financial messages. Note: Integer format. | string | Yes |
| transaction_currency_code | The ISO currency code in which transaction_amount is represented. | string (3) | Yes |
| cardholder_billing_amount | The amount to be billed against the cardholder’s account, if the transaction currency is different to card settlement currency. Note: Integer format. | string | Yes |
| cardholder_billing_currency_code | The ISO currency code in which cardholder_billing_amount is represented. | string (3) | Yes |
| cardholder_billing_conversion_rate | The conversion rate used to calculate cardholder_billing_amount from transaction_amount. | string | Yes |
| transaction_fee_amount | The amount of the transaction fee. Note that this is already accounted for in transaction_amount. | string | Yes |
| from_account | The source account type of the transaction request. Valid values:“default” “savings” “checking” “credit” | string | No |
| to_account | The destination account type of the transaction request. Valid values:“default” “savings” “checking” “credit” | string | No |
| 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 | Yes |
| dcc_indicator | Indicates whether Dynamic Currency Conversion took place. Possible values:“y” “n” | string | Yes |
| chip_indicator | Indicates if the transaction was an ICC transaction, and if so contact or contactless. Possible values:“n” “contact” “contactless” | string | Yes |
| pin_indicator | Indicates whether the PIN for the transaction was checked, its nature and the result. Possible values:“n” “offline_passed” “offline_failed” “online_passed” “online_failed” | string | Yes |
| 3ds_indicator | Indicates whether 3D-Secure Authentication took place for this transaction. Possible values:“y” “n” | string | Yes |
| avs_outcome | Provides information on the outcome of Address Verification performed by CLOWD9. For a list of possible values, refer to the CLOWD9 AVS Codes:"m" Both match "a" Address match only "p" Post code match only "n" Neither match "r" Error while processing | string | Yes |
| partial_approval_supported | Indicates whether Partial Approval is supported. Possible values:“y” “n” | string | Yes |
| cardholder_condition | Cardholder condition indicator provided during the authorization. Possible values are:“00” card holder present, normal transaction “01” card holder not present “02” card holder present “03” card present, suspicious activity “05” card holder present “08” card holder not present, mail or telephone order “59” card holder not present, electronic order (ecommerce) “71” card holder present (Used in US only) | string | No |
| authorization_code | A six digit code generated by CLOWD9, associated with the authorization request | string | Yes |
| transaction_link_id | The Identifier of the transaction assigned by the Network. The Identifier will be provided in all future Financial messages. Reserved for future use for Visa. | string | No |
| fees | |||
| amount | The amount of the fee | string | No |
| type | The type of fee applied: fixed_fee variable_fee minimum_fee maximum_fee markup_fee | string | No |
| markup_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. | 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. | string | No |
| status | |||
| response_code | Previous response code associated to the authorization message. | string | Yes |
| response_source | Indicates the source of the response_code value. Possible values:“scheme” “clowd9” | string | Yes |
| response_reason | A description of the reason for the assigned response_code | string | Yes |
| update | Used in transactions where context from original/previous transaction is of relevance, such as reversals or pre-auth completion messages. | ||
| original_message_type | The Message Type from the related transaction. | string | No |
| original_message_qualifier | The Message Qualifier from the related transaction. | string | No |
| original_transaction_id | The CLOWD9 transaction log identifier of the related transaction. | uuid | No |
| original_system_trace_audit_number | The System Trace Audit Number from the related transaction. | string | No |
| original_retrieval_reference_number | The Retrieval Reference Number from the related transaction. | string | Nio |
| original_transmission_date | The date the related transaction was received. | string (MMDD) | No |
| original_transmission_time | The time related to when transaction was received. | string | No |
| original_transaction_amount | The Transaction Amount from the related transaction. | string | No |
| actual_transaction_amount | The Actual Transaction Amount to be applied in a partial reversal. | string | No |
| actual_billing_amount | The Actual Billing Amount to be applied in a partial reversal. | string | No |
| acquirer | Information about the entity and point of transaction capture. | ||
| acquiring_institution_id_code | The identification code of the Acquiring Institution. | string | Yes |
| acquiring_institution_country_code | The ISO country code of the Acquiring Institution. | string | Yes |
| merchant_category_code | The Merchant Category Code. | string | Yes |
| card_acceptor_terminal_id | The identifier of the terminal where the transaction took place. | string | No |
| card_acceptor_id | The identifier of the card acceptor entity. | string | Yes |
| card_acceptor_name | The name of the card acceptor entity. | string | Yes |
| card_acceptor_city | The city of the card acceptor entity. | string | No |
| card_acceptor_country_code | The country of the card acceptor entity. | string | Yes |
| card_acceptor_post_code | The Post code of the card acceptor entity. | string | No |