Reversal Request

Reversal Request - Full & Partial

FieldDescriptionFormatMandatory
message_type“reversal”stringYes
message_qualifier“request”stringYes
sourceIdentifies the source of the message, such as the networkstringYes
cardContains vital information about the card as held in the CLOWD9 database
card_idThe ID of the card related to the transaction or messageuuidYes
card_form_factorForm factor of card. Possible values:
“physical”
“virtual”
stringYes
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"

stringYes
card_endingThe last four digits of the PANstringUnder Development
customerContains vital information about the customer as held in the CLOWD9 database
customer_idThe ID of the customer associated with the carduuidYes
customer_external_refExternal ID of the customer associated with the card, if knownstringNo
transactionDetails of the transaction
auth_typeUsed to identify the type of an authorization message:
"preauth",
"incremental",
"completion",
"recurring_initial"
"recurring_subsequent", or
"anticipated_amount_verification"
stringNo
credential_on_file

Indicates if the transaction was a credential on file transaction. Possible values:

“y”
"n"

stringYes
reversal_type"full"
"partial"
stringYes
transaction_typeUsed to identify the type of service usedstringYes
transaction_serviceNumerical value associated with the transaction_typestringYes
transaction_idThe unique identifier of the transaction log entry in the CLOWD9 databaseuuidYes
system_trace_audit_numberThe System Trace Audit Number for the network messagestringYes
retrieval_reference_numberThe Retrieval Reference Number for the network messagestringYes
network_transaction_idThe unique identifier of the transaction assigned by the networkstringYes
transmission_dateThe date the message was received, as indicated in the message from the networkstring (MMDD)Yes
transmission_timeThe time the message was received, as indicated in the message from the networkstring (hhmmss)Yes
transaction_local_dateThe local date at the point of transaction originationstring (MMDD)No
transaction_local_timeThe local time at the point of transaction originationstring (hhmmss)No
transaction_amountThe amount to be authorized with the transaction. Can be “0” for non-financial messages. Note: Integer formatstringYes
transaction_currency_codeThe ISO currency code in which transaction_amount is representedstring (3)Yes
cardholder_billing_amountThe amount to be billed against the cardholder’s account, if the transaction currency is different to card settlement currency. Note: Integer formatstringYes
cardholder_billing_currency_codeThe ISO currency code in which cardholder_billing_amount is representedstring (3)Yes
cardholder_billing_conversion_rateThe conversion rate used to calculate cardholder_billing_amount from transaction_amountstringYes
revised_cardholder_billing_amountThe total amount for Authorization including any Product feesstringno
revised_cardholder_billing_rateThe new rate to be used for International transactions if applicable. The markup % is added to the Network conversion rate to calculate the markup_conversion_ratestringno
transaction_fee_amountThe amount of the transaction fee. Note that this is already accounted for in transaction_amountstringNo
from_account

The source account type of the transaction request. Valid values:

“default”
“savings”
“checking”
“credit”

stringNo
to_account

The destination account type of the transaction request. Valid values:

“default”
“savings”
“checking”
“credit”

stringNo
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

stringYes
dcc_indicator

Indicates whether Dynamic Currency Conversion took place. Possible values:

“y”
“n”

stringYes
chip_indicator

Indicates if the transaction was an ICC transaction, and if so contact or contactless. Possible values:

“n”
“contact”
“contactless”

stringYes
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”

stringYes
3ds_indicator

Indicates whether 3D-Secure Authentication took place for this transaction. Possible values:

“y”
“n”

stringYes
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

stringYes
partial_approval_supported

Indicates whether Partial Approval is supported. Possible values:

“y”
“n”

stringYes
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)

stringNo
authorization_codeA six digit code generated by CLOWD9, associated with the authorization requeststringYes
fees
amountThe amount of the feestringNo
typeThe type of fee applied:
fixed_fee variable_fee
minimum_fee
maximum_fee
markup_fee
stringNo
fees_amountThe 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
stringNo
transaction_link_idThe Identifier of the transaction assigned by the Network. The Identifier will be provided in all future Financial messages.stringNo
status
response_codeResponse code of the transaction. In notification messages, it is the final outcome of the authorization process. In request messages, it may contain a value indicating the outcome of previous checksstringYes
response_source

Indicates the source of the response_code value. Possible values:

“scheme”
“clowd9”

stringYes
response_reasonA description of the reason for the assigned response_codestringYes
updateUsed in transactions where context from original/previous transaction is of relevance, such as reversals or pre-auth completion messages
original_message_typeThe Message Type from the related transactionstringNo
original_message_qualifierThe Message Qualifier from the related transactionstringNo
original_transaction_idThe CLOWD9 transaction log identifier of the related transactionuuidNo
original_system_trace_audit_numberThe System Trace Audit Number from the related transactionstringNo
original_retrieval_reference_numberThe Retrieval Reference Number from the related transactionstringNo
original_transmission_dateThe date the related transaction was receivedstring (MMDD)No
original_transmission_timeThe time related to when transaction was receivedstringNo
original_transaction_amountThe Transaction Amount from the related transactionstringNo
actual_transaction_amountThe Actual Transaction Amount to be applied in a partial reversalstringNo
actual_billing_amountThe Actual Billing Amount to be applied in a partial reversalstringNo
acquirerInformation about the entity and point of transaction capture
acquiring_institution_id_codeThe identification code of the Acquiring InstitutionstringYes
acquiring_institution_country_codeThe ISO country code of the Acquiring InstitutionstringYes
merchant_category_codeThe Merchant Category CodestringYes
card_acceptor_terminal_idThe identifier of the terminal where the transaction took placestringNo
card_acceptor_idThe identifier of the card acceptor entitystringYes
card_acceptor_nameThe name of the card acceptor entitystringYes
card_acceptor_cityThe city of the card acceptor entitystringNo
card_acceptor_country_codeThe country of the card acceptor entitystringYes
card_acceptor_post_codeThe Post code of the card acceptor entitystringNo

Did this page help you?