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.
Authorization Notification
The following will be provided to you by CLOWD9.
| Field | Description | Format | Mandatory |
|---|---|---|---|
| message_type | “authorization” | string | Yes |
| message_qualifier | “notification” | string | Yes |
| source | Identifies the source of the message, such as the network: "visa" "mastercard" "clowd9" | string | |
| card | Contains vital information about the card as held in the CLOWD9 database. | ||
| > > card_id | The Identifier of the card associated to the authorization request | uuid | Yes |
| > > card_form_factor | Form factor of card. Supported 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 values for use: "inactive" “active” "administrative" “destroyed” "fraud" "freeze" "lost" “stolen” Status values for CLOWD8 use only: "expired" "risk" | string | |
| > > card_prev_status | Previous 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" | string | |
| > > card_status_change_reason | Free-text field giving insight into the reason for the card status change. | string | |
| customer | Contains vital information about the customer as held in the CLOWD9 database. | ||
| > > customer_id | The ID of the customer associated with the card. | uuid | |
| > > customer_external_ref | External ID of the customer associated with the card, if known. | string | |
| account | Contains vital information about the account as held in the CLOWD9 database. | ||
| > > account_id | The ID of the account related to the transaction or message. | uuid | |
| > > account_currency_code | The ISO currency code of the account. Note: This may have implications to the decimal place in the transaction amount and balances fields. | string(3) | |
| > > amount_in_account_currency | The transaction amount in the account currency as applied against the account. | string | |
| > > balance_before | Balance of the account prior to the transaction. | string | |
| > > balance_after | Balance of the account after the transaction. | string | |
| transaction_raw_data | The raw transaction message received from the network. Be aware using this field has PCI implications. | hex | |
| transaction | Details of the transaction. | ||
| > > auth_type | Used to identify the type of an authorization message: "preauth", "incremental", "completion", "recurring_initial" "recurring_subsequent", or "anticipated_amount_verification" | string | |
| > > credential_on_file | Indicates if the transaction was a credential on file transaction. Supported values: “y” "n" | string | |
| > > reversal_type | Used to identify the type of a reversal message. Supported values: "full" "partial" | string | |
| > > transaction_type | Used to identify the type of service used | string | |
| > > 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 if present/applicable. | string | |
| > > retrieval_reference_number | The Retrieval Reference Number for the network message if present/applicable. | string | |
| > > network_transaction_id | The unique identifier of the transaction assigned by the network, such as Visa TID. | string | |
| > > transmission_date | The date the message was received, as indicated in the message from the network. | string (MMDD) | |
| > > transmission_time | The time the message was received, as indicated in the message from the network. | string (hhmmss) | |
| > > transaction_local_date | The local date at the point of transaction origination. | string (MMDD) | |
| > > transaction_local_time | The local time at the point of transaction origination. | string (hhmmss) | |
| > > transaction_amount | The amount to be authorized with the transaction. Can be “0” for non-financial messages. Note: we only accept integers format | string | |
| > > transaction_currency_code | The ISO currency code in which transaction_amount is represented. Note that this may have implications on the decimal place. | string (3) | |
| > > cardholder_billing_amount | The 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 | string | |
| > > cardholder_billing_currency_code | The ISO currency code in which cardholder_billing_amount is represented. Note that this may have implications on the decimal place. | string (3) | |
| > > cardholder_billing_conversion_rate | The conversion rate used to calculate cardholder_billing_amount from transaction_amount. | string | |
| > > transaction_fee_amount | The amount of the transaction fee. Note that this is already accounted for in transaction_amount. | string | |
| > > transaction_fee_program | Name of the fee configuration that was used to calculate transaction_fee_amount. | string | |
| > > from_account | The source account type of the transaction request. Valid values: “default” “savings” “checking” “credit” | string | |
| > > to_account | The destination account type of the transaction request. Valid values: “default” “savings” “checking” “credit” | string | |
| > > from_account_id | The source account ID in the CLOWD9 database, if known | string | |
| > > to_account_id | The destination account ID in the CLOWD9 database, if known | string | |
| >>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 | |
| > > > > original_message_qualifier | The Message Qualifier from the related transaction | string | |
| > > > > original_transaction_id | The CLOWD9 transaction log identifier of the related transaction | uuid | |
| > > > > original_system_trace_audit_number | The System Trace Audit Number from the related transaction | string | |
| > > > > original_retrieval_reference_number | The Retrieval Reference Number from the related transaction | string | |
| > > > > original_transmission_date | The date the related transaction was received | string (MMDD) | |
| > > > > original_transmission_time | The time related to when transaction was received | string | |
| > > > > original_transaction_amount | The Transaction Amount from the related transaction | string | |
| > > > > actual_transaction_amount | The Actual Transaction Amount to be applied in a partial reversal | string | |
| > > 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 | |
| > > dcc_indicator | Indicates whether Dynamic Currency Conversion took place. Possible values: “y” “n” | string | |
| > > chip_indicator | Indicates if the transaction was an ICC transaction, and if so contact or contactless. Possible values: “n” “contact” “contactless” | string | |
| > > 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 | |
| > > 3ds_indicator | Indicates whether 3D-Secure Authentication took place for this transaction. Possible values: “y” “n” | string | |
| > > 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 | |
| > > partial_approval_supported | Indicates whether Partial Approval is supported. Possible values: “y” “n” | string | |
| > > 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 | |
| >>3ds_additional_data | Additional information related to 3D-Secure Authentication. | ||
| > > > > 3ds_provider | Name of used 3D-Secure provider configuration. | string | |
| > > > > 3ds_authentication_method | Indicates the 3D-Secure Authentication method. Possible values: “OTP” “OTP_SQ” | string | |
| > > > > 3ds_otp_delivery_method | Indicates the delivery method of the One Time Password. Possible values: “C9 SMS” “C9 email” “Company API” | string | |
| > > > > 3ds_reference_number | The reference number from the 3D-Secure Authentication provider. | string | |
| >>status | |||
| > > > > response_code | Response code numeric value used by CLOWD9 and you for the final outcome of the request. List of values can be found here | string | |
| > > > > response_source | Indicates the source of the response_code value. Possible values: “scheme” “clowd9” | string | |
| > > > > response_reason | The alpha description associated to the response_code. List of descriptions can be found here | string | |
| > > > > authorization_id_response | The authorization code associated with the approved authorization. | string | |
| acquirer | Information about the entity and point of transaction capture. | ||
| > > acquiring_institution_id_code | The identification code of the Acquiring Institution. | string | |
| > > acquiring_institution_country_code | The ISO country code of the Acquiring Institution. | string | |
| > > merchant_category_code | The Merchant Category Code. | string | |
| > > card_acceptor_terminal_id | The identifier of the terminal where the transaction took place. | string | |
| > > card_acceptor_id | The identifier of the card acceptor entity. | string | |
| > > card_acceptor_name | The name of the card acceptor entity. | string | |
| > > card_acceptor_city | The city of the card acceptor entity. | string | |
| > > card_acceptor_country_code | The country of the card acceptor entity. | string | |
| > > card_acceptor_post_code | The Post code of the card acceptor entity. | string |
Updated 13 days ago