Network Confirmation Specifications

message_type

“authorization”
"reversal"

string

Yes

message_qualifier

“network confirmation”

string

Yes

source

Identifies the source of the message:

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

card_ending

The last four digits of the PAN.

string

Under Development

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

**Under Development ** 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

Identifies 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 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, provided by the network, the message was received.

string (MMDD)

Yes

transmission_time

The time, provided by the network, the message was received.
This is in UTC with all the data we have available.

string (hhmmss)

Yes

transaction_local_date

The local date at the point of transaction origination (provided by the network).

string (MMDD)

No

transaction_local_time

The local time at the point of transaction origination (provided by the network).

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.

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.

string (3)

Yes

cardholder_billing_conversion_rate

The conversion rate used to calculate cardholder_billing_amount from transaction_amount.

string

Yes

transaction_fee_amount

Represents the transaction fee charged by a Card Acceptor (Merchant), beginning with “C” for Credit and “D” for Debit. This is represented in the Product base currency, with 2 decimal places.

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

Conditional

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

sca_indicator

Identifies if one of the SCA limits has been exceeded, requiring further authentication.
"y", Limit has been exceeded and response_code will be 120
"n", Limit has not been exceeded or the transaction is exempt.

string

No

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” cardholder present, normal transaction
“01” cardholder not present
“02” cardholder present
“03” card present, suspicious activity
“05” cardholder present
“08” cardholder not present, mail or telephone order
“59” cardholder not present, electronic order (ecommerce)
“71” cardholder 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
fx_markup_fee

string

No

revised_cardholder_billing_conversion_rate

This rate will be used instead of the cardholder_billing_conversion_rate where a fx_markup_fee is applicable.

string

No. Only present for the fx_markup_fee

fees_amount

The total amount of fees to be charged. The revised_cardholder_billing_amount should be used.
This is independent of any Network fees.

string

No

revised_cardholder_billing_amount

The amount to be debited where there are fees included in the clearing.

string

No

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”

For Off Ledger, the value you provide in your Authorization response will be echoed.

string

Yes

response_reason

The alpha description associated to the response_code.

string

Yes

update

Under Development

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

No

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

** Under Development** The Actual Billing Amount to be applied in a partial reversal.

string

No

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

No

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

No

card_acceptor_country_code

The country the Merchant is registered in alpha (2).

string

Yes

card_acceptor_post_code

The Postcode of the card acceptor entity.

string

No

accounts

Account Information is only present as a result of Balance changing events.

account_id

The identifier of the Account associated with the card_id.

uuid

Yes for On Ledger Products

actual_balance

The actual balance following the Financial activity. A minus figure indicates a debit balance.

string

Yes for On Ledger Products

available_balance

The available balance following the Financial activity. A minus figure indicates a debit balance.

string

Yes for On Ledger Products

overdraft_value

The value of the agreed overdraft.

string

Optional

authorized

Under Development
The total amount of authorized spend to date.

string

Yes for On Ledger Products