Authorization Request
CLOWD9 will transmit an authorization request to your configured endpoint, for your decision, which is provided in the Authorization response.
In the event your response is not received in time, CLOWD9 will return a 100 - Do Not Honour response to the network / scheme.
Authorization Request
| Field | Value | Format | Mandatory |
|---|---|---|---|
| message_type | “authorization” | string | Yes |
| message_qualifier | “request” | string | Yes |
| source | Identifies the source of the message, such as the network: visa mastercard clowd9 | string | Yes |
| 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 CLOWD9 use only: "expired" "risk" | string | Yes |
| customer | Contains vital information about the customer as held in the CLOWD9 database | ||
| > > customer_id | The Identifier of the Customer associated with the card | uuid | Yes |
| > > customer_external_ref | External ID of the customer associated with the card, if held | string | No |
| 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 | No |
| > > credential_on_file | Indicates if the transaction was a credential on file transaction, either: “y” "n" | string | Yes |
| > > transaction_type | Used to identify the type of service used | 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 if present/applicable | string | Yes |
| > > retrieval_reference_number | The Retrieval Reference Number for the network message if present/applicable | 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: we only accept integers format | string | Yes |
| > > 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) | 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 is required | string | Yes |
| > > 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) | 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 | No |
| > > transaction_fee_program | Name of the fee configuration that was used to calculate transaction_fee_amount | string | No |
| > > from_account | The source account type of the transaction request: “default”, “savings”, “checking”, or “credit” | string | Yes |
| > > to_account | The destination account type of the transaction request: “default”, “savings”, “checking”, or “credit” | string | Yes |
| > > 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, either “y”, or “n” | string | Yes |
| > > chip_indicator | Indicates if the Integrated Chip Card was used: “n”, “contact”, or “contactless” | string | Yes |
| > > pin_indicator | Indicates whether the PIN for the transaction was checked, its nature and the result: “n”, “offline_passed”, “offline_failed”, “online_passed”, or “online_failed” | string | Yes |
| > > 3ds_indicator | Indicates whether 3D-Secure Authentication took place for this transaction, either “y”, or “n” | string | Yes |
| > > avs_outcome | Provides the outcome of the Address Verification Service performed by CLOWD9: "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, either “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 | Yes |
| > > > > authorization_code | A six digit code generated by CLOWD9, associated with the authorization request | string | Yes |
| >>status | |||
| > > > > response_code | Response code numeric value used by CLOWD9 and you for the final outcome of the request. | string | Yes |
| > > > > response_source | Indicates the source of the response_code value. Possible values: “scheme” “clowd9” | string | Yes |
| > > > > response_reason | The alpha description associated to the response_code. | string | Yes |
| acquirer | Information about the Merchant and their Acquiring Institution at point of transaction capture | ||
| > > acquiring_institution_id_code | The identification code of the Merchants Acquiring Institution | string | Yes |
| > > acquiring_institution_country_code | The ISO country code of the Merchants Acquiring Institution | string | Yes |
| > > merchant_category_code | The Merchant Category Code, numeric (4) | string | Yes |
| > > card_acceptor_terminal_id | The identifier of the Merchant terminal | string | Yes |
| > > card_acceptor_id | The identifier of the Merchant | string | Yes |
| > > card_acceptor_name | The name of the Merchant | string | Yes |
| > > card_acceptor_city | The city where the Merchant is registered | string | Yes |
| > > card_acceptor_country_code | The country the Merchant is registered in alpha (3) | string | Yes |
| > > card_acceptor_post_code | The Post code of the card acceptor entity | string | Yes |
Updated 12 days ago