Authorization Notification

Where an Authorization request has been received and either CLOWD9 or the Network has already made the decision, an Authorization Notification will be sent to you for acknowledgment and processing.

You will not be able to change the outcome.

The following will be provided to you by CLOWD9.

FieldDescriptionFormatMandatory
message_type“authorization” stringYes
message_qualifier“notification”stringYes
sourceIdentifies the source of the message, such as the network:
"visa"
"mastercard"
"clowd9"
stringYes
card Contains vital information about the card as held in the CLOWD9 database.
card_idThe Identifier of the card associated to the authorization requestuuidYes
card_endingThe last four digits of the PANstringUnder Development
card_form_factorForm factor of card. Supported values:

“physical”
“virtual”
stringYes
card_statusShows the current status of the card that is sent during the authorization process or following a successful status change.

Supported values for use:

"inactive"
“active”
"administrative"
“destroyed”
"fraud"
"freeze"
"lost"
“stolen”

Status values for CLOWD8 use only:
"expired"
"risk"
stringNo
card_prev_statusPrevious status of the card. Only present when card status changes.

Supported values for use:

"inactive"
“active”
"administrative"
“destroyed”
"fraud"
"freeze"
"lost"
“stolen”

Status values for CLOWD9 use only:

"expired"
"risk"
stringNo
card_status_change_reasonFree-text field giving insight into the reason for the card status change.stringNo
customerContains vital information about the customer as held in the CLOWD9 database.
customer_idThe ID of the customer associated with the card.uuidYes
customer_external_refExternal ID of the customer associated with the card, if known.stringNo
accountContains vital information about the account as held in the CLOWD9 database.
account_idThe ID of the account related to the transaction or message.uuidNot applicable for Off Ledger
account_currency_codeThe ISO currency code of the account.
Note: This may have implications to the decimal place in the transaction amount and balances fields.
string(3)Not applicable for Off Ledger
amount_in_account_currencyThe transaction amount in the account currency as applied against the account.stringNot applicable for Off Ledger
balance_beforeBalance of the account prior to the transaction.stringNot applicable for Off Ledger
balance_afterBalance of the account after the transaction.stringNot applicable for Off Ledger
transaction Details 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_fileIndicates if the transaction was a credential on file transaction. Supported values:

“y”
"n"
stringNo
reversal_typeUsed to identify the type of a reversal message. Supported values:

"full"
"partial"
stringNo
> > transaction_type](<https://docs.clowd9.io/docs/transaction-type-service>)Used to identify the type of service usedstringYes
transaction_service In Development
Numerical value associated with the transaction_type
string
transaction_idThe unique identifier of the transaction log entry in the CLOWD9 database.uuidYes
system_trace_audit_numberThe System Trace Audit Number for the network message if present/applicable.stringYes
retrieval_reference_numberThe Retrieval Reference Number for the network message if present/applicable.stringYes
network_transaction_idThe unique identifier of the transaction assigned by the network, such as Visa TIDstringYes
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_amountThe amount to be authorized with the transaction. Can be “0” for non-financial messages.
Note: we only accept integers format
stringYes
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: we only accept integers format
stringYes
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
transaction_fee_amountThe amount of the transaction fee. Note that this is already accounted for in transaction_amountstringNo
transaction_fee_programName of the fee configuration that was used to calculate transaction_fee_amountstringNo
from_accountThe source account type of the transaction request. Valid values:

“default”
“savings”
“checking”
“credit”
stringNo
to_accountThe destination account type of the transaction request. Valid values:

“default”
“savings”
“checking”
“credit”
stringNo
from_account_idThe source account ID in the CLOWD9 database, if knownstringNo
to_account_idThe destination account ID in the CLOWD9 database, if knownstringNo
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 transactionstring
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
eciE-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
stringNo
dcc_indicatorIndicates whether Dynamic Currency Conversion took place. Possible values:

“y”
“n”
stringNo
chip_indicatorIndicates if the transaction was an ICC transaction, and if so contact or contactless. Possible values:

“n”
“contact”
“contactless”
stringNo
pin_indicatorIndicates whether the PIN for the transaction was checked, its nature and the result. Possible values:

“n”
“offline_passed”
“offline_failed”
“online_passed”
“online_failed”
stringNo
3ds_indicatorIndicates whether 3D-Secure Authentication took place for this transaction. Possible values:

“y”
“n”
stringNo
avs_outcomeProvides 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
stringNo
partial_approval_supportedIndicates whether Partial Approval is supported. Possible values:

“y”
“n”
stringNo
cardholder_conditionCardholder 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
status
response_codeResponse code numeric value used by CLOWD9 and you for the final outcome of the request. List of values can be found
here
stringYes
response_sourceIndicates the source of the response_code value. Possible values:

“scheme”
“clowd9”
stringYes
response_reasonThe alpha description associated to the response_code. List of descriptions can be found
here
stringYes
authorization_codeThe authorization code associated with the authorization notification if received or generated by CLOWD9 stringNo
transaction_link_idThe Identifier of the transaction assigned by the network. The Identifier will be provided in all future Financial messages.
Reserved for future use for Visa
stringNo
acquirer Information 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 placestringYes
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 entitystringYes
card_acceptor_country_codeThe country of the card acceptor entitystringYes
card_acceptor_post_codeThe Post code of the card acceptor entitystringYes