The CLOWD9 Dynamic Data Stream (DDS) allows external authorization calls to your company as the source of truth for transaction authorization decisions.

This API is also used for real-time notification of all transactions if required.

This system also enables CLOWD9 to push administrative notifications such as card status changes that occur in the system, blocking of a card if the number of online PIN tries are exceeded, or as a result of CLOWD9 automatically changing a card to expired when the expiry date has passed.

Request body schema

The fields are added according to your requirements; most of them are not mandatory. Consult with your implementation manager to request the addition or removal of fields in the calls directed to your API endpoint.

Field	Description	Format	Mandatory
message_type	Used to identify the purpose of the message. Possible values: “authorization” “reversal” “administrative” "clearing"	string	Yes
message_qualifier	Used to identify the nature and urgency of a message. Possible values: “request” “notification”	string	Yes
source	Identifies the source of the message, such as the network.	string
card	Contains vital information about the card as held in the CLOWD9 database.
> > card_id	The ID of the card related to the transaction or message.	uuid
> > card_form_factor	Form factor of card. Possible values: “physical” “virtual”	string
> > 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"	string
> > card_prev_status	Previous status of the card. Only present when card status changes. Supported card status types: "inactive" “active” "administrative" “destroyed” "fraud" "freeze" "lost" “stolen” Status generated by CLOWD9: "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"	string
> > credential_on_file	Indicates if the transaction was a credential on file transaction. Possible values: “y” "n"	string
> > reversal_type	Used to identify the type of a reversal message. "full" "partial"	string
> > transaction_type	Used to identify the type of service used as follows: 00 Goods and Service 01 Cash Withdrawal (ATM) 02 Cash Withdrawal (Manual Disbursement) 09 Goods and Service with Cash Disbursement 10 Account Funding 11 Quasi Cash 20 Returns/Refunds 21 Envelope Deposit 22 Cheque Deposit 23 Cash Deposit 25 Credit Adjustment 26 Original Credit 28 Prepaid Load / Activation 30 Balance Inquiry 34 Mini Statement 39 Eligibility Inquiry 40 Cardholder Account Transfer 50 Bill Payment 53 Payment 70 PIN Change 71 PIN Unblock 72 PIN Check 92 Address Verification	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 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 checks. For a list of possible values, refer to the CLOWD9 Result Codes: 000 Approved 008 Approved Offline (EMV) 009 Approved Offline (Unable To Go Online) 010 Partial Approval 011 Approved for Purchase Amount Only, No Cashback 040 Reversal Accepted 080 Accepted 081 Duplicate 085 No Reason To Decline 091 Advice acknowledged 098 Approved By Network 099 Approved By CLOWD9 100 Do Not Honour 101 Expired Card 102 Suspected Fraud 103 Restricted Card 104 Allowable PIN Tries Exceeded 105 Virtual card used under invalid circumstances 106 Force Stand-In 107 Card Authentication Failure 108 Fallback Not Allowed 109 Unable To Go Online; Declined 110 Invalid Amount 111 Invalid Card Number 112 PIN Data Required 113 Unacceptable Fee 114 Account Does Not Exist 115 Card Not Effective 116 Insufficient Funds 117 Incorrect PIN 118 Card Record Not Found 119 Transaction Forbidden to Cardholder 121 Exceeds Withdrawal Amount Limit 122 Security Violation 123 Exceeds Withdrawal Frequency Limit 124 Violation Of Law 126 Invalid PIN Block 127 PIN Length Error 130 Decline Given By Issuer 131 Decline Given By Switch 132 Decline Given By Switch (Stand-In) 133 Decline Given By Network 134 Decline Given By Network (Stand-In) 150 Original Amount Incorrect 153 No Credit Account 154 No Loan Account 155 No Investment Account 156 No Checking Account 157 No Saving Account 160 No Customer Record 169 Refer To Issuer By Switch, Not On Positive File 170 Contact Card Issuer 171 Cardmember To Contact Issuer 172 Refer To Issuer Given By Issuer 173 Refer to Issuer By Processor, Exceed Stand-In Limit 174 Repeat/Reversal Msg Inconsistent With Original Msg 175 Invalid/Nonexistent Account Specified (General) 176 Invalid/Nonexistent ""To Account"" Specified 177 Invalid/Nonexistent ""From Account"" Specified 180 At PIN Retry Limit 181 Invalid Expiry Date 182 Invalid Currency Code 183 Invalid Card Data 184 Invalid CVV 185 Invalid CVC/CVV2 187 - Revocation of authorization orders - single merchant 188 - Revocation of authorization orders - all merchants 189 Card Validity Period Exceeded 190 New Card Not Properly Unblocked 191 Unable To Verify PIN 192 Invalid Service Code 193 Invalid ARQC 194 Local Use Only 195 No Action Taken (Unable To Backout Prior Transaction) 196 Invalid Authorization Life Cycle 199 Account Restricted 200 Pick up Card 201 Expired Card Pickup 202 Suspected Fraud Pickup 203 Card Acceptor Contact Acquirer Pickup 204 Restricted Card Pickup 205 Security Violation Pickup 206 Allowable PIN Tries Exceeded Pickup 207 Special Conditions Pickup 208 Lost Card Pickup 209 Stolen Card Pickup 210 Suspected Counterfeit Card Pickup 211 Lost Card Pickup, Temporary Status 212 Stolen Card Pickup, Temporary Status 480 Invalid Function Code 481 Invalid Reversal Account Number 482 Account Does Not Mod 10 483 Invalid Reversal Amount 680 Unacceptable PIN 681 PIN Change Failed 682 PIN Unlock Failed 683 PIN Change/Unblock Request Declined 901 Invalid Transaction 902 Re-enter Transaction 909 System Malfunction 910 Card Issuer Signed Off 911 Card Issuer Timed Out 912 Card Issuer Unavailable 913 Duplicate Transmission 914 Unable to Trace Back Orig Transaction 915 MAC incorrect 920 Security software/hardware error - try again 921 Security error: No Action 930 General Error 931 Surcharge Amount Not Permitted 935 Country is blocked 951 Invalid Biller Information 952 PIN Translation Failure 953 Cashback Request Exceeds Issuer Limit 999 Routing Error	string
> > > > response_source	Indicates the source of the response_code value. Possible values: “scheme” “clowd9”	string
> > > > response_reason	A description of the reason for the assigned response_code. For a list of possible values, refer to the CLOWD9 Result Reason Codes: 000 Approved 008 Approved Offline (EMV) 009 Approved Offline (Unable To Go Online) 010 Partial Approval 011 Approved for Purchase Amount Only, No Cashback 040 Reversal Accepted 080 Accepted 081 Duplicate 085 No Reason To Decline 091 Advice acknowledged 098 Approved By Network 099 Approved By CLOWD9 100 Do Not Honour 101 Expired Card 102 Suspected Fraud 103 Restricted Card 104 Allowable PIN Tries Exceeded 105 Virtual card used under invalid circumstances 106 Force Stand-In 107 Card Authentication Failure 108 Fallback Not Allowed 109 Unable To Go Online; Declined 110 Invalid Amount 111 Invalid Card Number 112 PIN Data Required 113 Unacceptable Fee 114 Account Does Not Exist 115 Card Not Effective 116 Insufficient Funds 117 Incorrect PIN 118 Card Record Not Found 119 Transaction Forbidden to Cardholder 121 Exceeds Withdrawal Amount Limit 122 Security Violation 123 Exceeds Withdrawal Frequency Limit 124 Violation Of Law 126 Invalid PIN Block 127 PIN Length Error 130 Decline Given By Issuer 131 Decline Given By Switch 132 Decline Given By Switch (Stand-In) 133 Decline Given By Network 134 Decline Given By Network (Stand-In) 150 Original Amount Incorrect 153 No Credit Account 154 No Loan Account 155 No Investment Account 156 No Checking Account 157 No Saving Account 160 No Customer Record 169 Refer To Issuer By Switch, Not On Positive File 170 Contact Card Issuer 171 Cardmember To Contact Issuer 172 Refer To Issuer Given By Issuer 173 Refer to Issuer By Processor, Exceed Stand-In Limit 174 Repeat/Reversal Msg Inconsistent With Original Msg 175 Invalid/Nonexistent Account Specified (General) 176 Invalid/Nonexistent ""To Account"" Specified 177 Invalid/Nonexistent ""From Account"" Specified 180 At PIN Retry Limit 181 Invalid Expiry Date 182 Invalid Currency Code 183 Invalid Card Data 184 Invalid CVV 185 Invalid CVC/CVV2 187 - Revocation of authorization orders - single merchant 188 - Revocation of authorization orders - all merchants 189 Card Validity Period Exceeded 190 New Card Not Properly Unblocked 191 Unable To Verify PIN 192 Invalid Service Code 193 Invalid ARQC 194 Local Use Only 195 No Action Taken (Unable To Backout Prior Transaction) 196 Invalid Authorization Life Cycle 199 Account Restricted 200 Pick up Card 201 Expired Card Pickup 202 Suspected Fraud Pickup 203 Card Acceptor Contact Acquirer Pickup 204 Restricted Card Pickup 205 Security Violation Pickup 206 Allowable PIN Tries Exceeded Pickup 207 Special Conditions Pickup 208 Lost Card Pickup 209 Stolen Card Pickup 210 Suspected Counterfeit Card Pickup 211 Lost Card Pickup, Temporary Status 212 Stolen Card Pickup, Temporary Status 480 Invalid Function Code 481 Invalid Reversal Account Number 482 Account Does Not Mod 10 483 Invalid Reversal Amount 680 Unacceptable PIN 681 PIN Change Failed 682 PIN Unlock Failed 683 PIN Change/Unblock Request Declined 901 Invalid Transaction 902 Re-enter Transaction 909 System Malfunction 910 Card Issuer Signed Off 911 Card Issuer Timed Out 912 Card Issuer Unavailable 913 Duplicate Transmission 914 Unable to Trace Back Orig Transaction 915 MAC incorrect 920 Security software/hardware error - try again 921 Security error: No Action 930 General Error 931 Surcharge Amount Not Permitted 935 Country is blocked 951 Invalid Biller Information 952 PIN Translation Failure 953 Cashback Request Exceeds Issuer Limit 999 Routing Error	string
> > > > authorization_code	A six digit code generated by CLOWD9, associated with the authorization request.	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
clearing	Information about clearing transactions.
> > clearing_category	Identifies the category of a clearing transaction. Possible values: “sales_debit" "cash_debit" "credit" “reversal_of_sales_debit" "reversal_of_cash_debit" "reversal_of_credit" “sales_debit_dispute" "cash_debit_dispute" "credit_dispute" “reversal_of_duplicate_sales_debit" "reversal_of_duplicate_cash_debit" "reversal_of_duplicate_credit"	string
> > transaction_type	The clearing transaction type. Possible values: “1” - First presentment of clearing transaction “9” - Dispute	string
> > reason_code	Typically used in dispute transactions to identify the reason of dispute.	string
> > reference_number	Reference number of the clearing record, such as ARN in Visa BASE II.	string
> > sequence_number	The sequence number of the clearing record. Used to identify multiple clearing transactions associated to the same authorization.	string
> > date	Date of transaction as per clearing record.	string(MMDD)
> > authorization_code	A six digit code generated by CLOWD9, associated with the approved authorization.	string(6)
> > authorizations	Carries information about the authorization(s) related to the clearing message. Note: This is a repeating field and may contain reference to more than one authorization transaction.
> > > > transaction_id	The ID of the authorization identified matching the clearing record.	uuid
> > > > system_trace_audit_number	System Trace Audit Number of authorization.	string
> > > > retrieval_reference_number	Retrieval Reference Number of authorization.	string
> > cardholder_billing_amount	The cardholder billing transaction amount, represented in cardholder_billing_currency_code.	string
> > cardholder_billing_currency_code	The cardholder billing currency code.	string(3)
> > transaction_amount	The transaction amount, represented in transaction_currency_code.	string
> > cashback_amount	The amount of cashback included in the transaction, represented in transaction_currency_code.	string
> > transaction_currency_code	The transaction currency code.	string(3)
> > interchange_fee	Represents the interchange fee amount, beginning with “C” for Credit and “D” for Debit. This is represented in the issuer’s base currency, with 6 decimal places.	string
> > transaction_to_base_currency_rate	The rate applied to the transaction amount.	string
> > base_to_billing_currency_rate	The rate applied to calculate billing amount.	string
> > cardholder_billing_conversion_rate	The cardholder billing conversion rate.	string
> > card_acceptor_name	The name of the merchant as received in the clearing record.	string
> > clearing_outcome	Identifies the outcome of matching the clearing to the original authorization. Possible values: “0” - Matching auth found, amounts match “1” - Matching auth found, amounts mismatch within network rules “8” - Matching auth found, amounts mismatch not within network rules “9” - Matching auth not found	string
> > card_id	The ID of the card related to the clearing record.	uuid
> > record_id_clearing	The unique identifier of the clearing record in the CLOWD9 database.	uuid

Response body schema

CLOWD9 will send you an authorization request. You will be required to provide CLOWD9 with a response using the mandatory fields in order to successfully complete the request.

For certain scenarios, you are required to provide the necessary information in the additional_Amounts field. For example:

Partial authorizations: The additional_Amounts field should carry the amount authorized for the transaction in the amount_authorized subfield, while transaction_amount, as always, should carry the original amount requested.

Balance enquiries: The additional_Amounts field should carry the available balances of all accounts associated with the card in the provided subfields.

Field	Description	Format	Mandatory
message_type	Used to identify the purpose of the message. Possible values: “authorization” “reversal” “administrative”	string	Yes
message_qualifier	Used to identify the nature and urgency of a message. Possible values: “response” “notification acknowledged”	string	Yes
card	Contains vital information about the card as stored in the CLOWD9 database.
> > card_id	The ID of the card related to the transaction or message.	uuid	Echo as received.
account	Contains vital information about the account as stored in the CLOWD9 database.
> > account_id	The ID of the account related to the transaction or message.	uuid	Echo as received.
transaction	Details of the transaction.
> > transaction_id	The unique identifier of the transaction log entry in the CLOWD9 database.	uuid	Echo are received.
> > transaction_amount	The amount to be authorized with the transaction. Can be “0” for non-financial messages.	string	Echo as received.
> > 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)	Echo as received.
> > cardholder_billing_amount	The amount to be billed against the cardholder’s account, if the transaction currency is different to card settlement currency.	string	Echo as received.
> > 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)	Echo as received.
>>outcome
> > > > response_code	Response code of the transaction, the outcome of your authorization process. For a list of possible values, refer to the CLOWD9 Result Codes: 000 Approved 008 Approved Offline (EMV) 009 Approved Offline (Unable To Go Online) 010 Partial Approval 011 Approved for Purchase Amount Only, No Cashback 040 Reversal Accepted 080 Accepted 081 Duplicate 085 No Reason To Decline 091 Advice acknowledged 098 Approved By Network 099 Approved By CLOWD9 100 Do Not Honour 101 Expired Card 102 Suspected Fraud 103 Restricted Card 104 Allowable PIN Tries Exceeded 105 Virtual card used under invalid circumstances 106 Force Stand-In 107 Card Authentication Failure 108 Fallback Not Allowed 109 Unable To Go Online; Declined 110 Invalid Amount 111 Invalid Card Number 112 PIN Data Required 113 Unacceptable Fee 114 Account Does Not Exist 115 Card Not Effective 116 Insufficient Funds 117 Incorrect PIN 118 Card Record Not Found 119 Txn Forbidden to Cardholder 121 Exceeds Withdrawal Amount Limit 122 Security Violation 123 Exceeds Withdrawal Frequency Limit 124 Violation Of Law 126 Invalid PIN Block 127 PIN Length Error 130 Decline Given By Issuer 131 Decline Given By Switch 132 Decline Given By Switch (Stand-In) 133 Decline Given By Network 134 Decline Given By Network (Stand-In) 150 Original Amount Incorrect 153 No Credit Account 154 No Loan Account 155 No Investment Account 156 No Checking Account 157 No Saving Account 160 No Customer Record 169 Refer To Issuer By Switch, Not On Positive File 170 Contact Card Issuer 171 Cardmember To Contact Issuer 172 Refer To Issuer Given By Issuer 173 Refer to Issuer By Processor, Exceed Stand-In Limit 174 Repeat/Reversal Msg Inconsistent With Original Msg 175 Invalid/Nonexistent Account Specified (General) 176 Invalid/Nonexistent ""To Account"" Specified 177 Invalid/Nonexistent ""From Account"" Specified 180 At PIN Retry Limit 181 Invalid Expiry Date 182 Invalid Currency Code 183 Invalid Card Data 184 Invalid CVV 185 Invalid CVC/CVV2 189 Card Validity Period Exceeded 190 New Card Not Properly Unblocked 191 Unable To Verify PIN 192 Invalid Service Code 193 Invalid ARQC 194 Local Use Only 195 No Action Taken (Unable To Backout Prior Txn) 196 Invalid Authorization Life Cycle 199 Account Restricted 200 Pick up Card 201 Expired Card Pickup 202 Suspected Fraud Pickup 203 Card Acceptor Contact Acquirer Pickup 204 Restricted Card Pickup 205 Security Violation Pickup 206 Allowable PIN Tries Exceeded Pickup 207 Special Conditions Pickup 208 Lost Card Pickup 209 Stolen Card Pickup 210 Suspected Counterfeit Card Pickup 211 Lost Card Pickup, Temporary Status 212 Stolen Card Pickup, Temporary Status 480 Invalid Function Code 481 Invalid Reversal Account Number 482 Account Does Not Mod 10 483 Invalid Reversal Amount 680 Unacceptable PIN 681 PIN Change Failed 682 PIN Unlock Failed 683 PIN Change/Unblock Request Declined 901 Invalid Transaction 902 Re-enter Transaction 909 System Malfunction 910 Card Issuer Signed Off 911 Card Issuer Timed Out 912 Card Issuer Unavailable 913 Duplicate Transmission 914 Unable to Trace Back Orig Txn 915 MAC incorrect 920 Security software/hardware error - try again 921 Security error: No Action 930 General Error 931 Surcharge Amount Not Permitted 935 Country is blocked 951 Invalid Biller Information 952 PIN Translation Failure 953 Cashback Request Exceeds Issuer Limit 999 Routing Error	string	Yes
> > > > response_source	Indicates the source of the response_code value. Free-text field, typically the name of your organization.	string
> > > > response_reason	A description of the reason for the assigned response_code. For a list of possible values, refer to the CLOWD9 Result Reason Codes: 000 Approved 008 Approved Offline (EMV) 009 Approved Offline (Unable To Go Online) 010 Partial Approval 011 Approved for Purchase Amount Only, No Cashback 040 Reversal Accepted 080 Accepted 081 Duplicate 085 No Reason To Decline 091 Advice acknowledged 098 Approved By Network 099 Approved By CLOWD9 100 Do Not Honour 101 Expired Card 102 Suspected Fraud 103 Restricted Card 104 Allowable PIN Tries Exceeded 105 Virtual card used under invalid circumstances 106 Force Stand-In 107 Card Authentication Failure 108 Fallback Not Allowed 109 Unable To Go Online; Declined 110 Invalid Amount 111 Invalid Card Number 112 PIN Data Required 113 Unacceptable Fee 114 Account Does Not Exist 115 Card Not Effective 116 Insufficient Funds 117 Incorrect PIN 118 Card Record Not Found 119 Txn Forbidden to Cardholder 121 Exceeds Withdrawal Amount Limit 122 Security Violation 123 Exceeds Withdrawal Frequency Limit 124 Violation Of Law 126 Invalid PIN Block 127 PIN Length Error 130 Decline Given By Issuer 131 Decline Given By Switch 132 Decline Given By Switch (Stand-In) 133 Decline Given By Network 134 Decline Given By Network (Stand-In) 150 Original Amount Incorrect 153 No Credit Account 154 No Loan Account 155 No Investment Account 156 No Checking Account 157 No Saving Account 160 No Customer Record 169 Refer To Issuer By Switch, Not On Positive File 170 Contact Card Issuer 171 Cardmember To Contact Issuer 172 Refer To Issuer Given By Issuer 173 Refer to Issuer By Processor, Exceed Stand-In Limit 174 Repeat/Reversal Msg Inconsistent With Original Msg 175 Invalid/Nonexistent Account Specified (General) 176 Invalid/Nonexistent ""To Account"" Specified 177 Invalid/Nonexistent ""From Account"" Specified 180 At PIN Retry Limit 181 Invalid Expiry Date 182 Invalid Currency Code 183 Invalid Card Data 184 Invalid CVV 185 Invalid CVC/CVV2 189 Card Validity Period Exceeded 190 New Card Not Properly Unblocked 191 Unable To Verify PIN 192 Invalid Service Code 193 Invalid ARQC 194 Local Use Only 195 No Action Taken (Unable To Backout Prior Txn) 196 Invalid Authorization Life Cycle 199 Account Restricted 200 Pick up Card 201 Expired Card Pickup 202 Suspected Fraud Pickup 203 Card Acceptor Contact Acquirer Pickup 204 Restricted Card Pickup 205 Security Violation Pickup 206 Allowable PIN Tries Exceeded Pickup 207 Special Conditions Pickup 208 Lost Card Pickup 209 Stolen Card Pickup 210 Suspected Counterfeit Card Pickup 211 Lost Card Pickup, Temporary Status 212 Stolen Card Pickup, Temporary Status 480 Invalid Function Code 481 Invalid Reversal Account Number 482 Account Does Not Mod 10 483 Invalid Reversal Amount 680 Unacceptable PIN 681 PIN Change Failed 682 PIN Unlock Failed 683 PIN Change/Unblock Request Declined 901 Invalid Transaction 902 Re-enter Transaction 909 System Malfunction 910 Card Issuer Signed Off 911 Card Issuer Timed Out 912 Card Issuer Unavailable 913 Duplicate Transmission 914 Unable to Trace Back Orig Txn 915 MAC incorrect 920 Security software/hardware error - try again 921 Security error: No Action 930 General Error 931 Surcharge Amount Not Permitted 935 Country is blocked 951 Invalid Biller Information 952 PIN Translation Failure 953 Cashback Request Exceeds Issuer Limit 999 Routing Error	string
> > additional_amounts	Carries additional amount information in partial authorizations and where account balances are supplied.
> > > > amount_authorized	The amount the partial authorization is valid for, represented in transaction_currency_code.	string
>>>>balances	Balance information for accounts associated with the card used in the transaction. These subfields are repeating as a group to cater for multiple accounts. Note that these balances are not for balance synchronization purpose.
> > > > > > account_id	The ID of the account, if stored in the CLOWD9 database.	uuid
> > > > > > account_type	Balance 1 account type. Valid values: “default” “savings” “checking” “credit”	string
> > > > > > amount_type	Balance 1 amount type. Valid values: “ledger” “available”	string
> > > > > > currency_code	The ISO currency code of Balance 1 amount.	string
> > > > > > amount_sign	Amount sign identifying if the amount of Balance 1 is positive or negative. Valid values: “+” “-”	string
> > > > > > amount	Balance 1 amount, represented in currency_code.	string

Sample Request - Cash Withdrawal

{
  "message_type": "authorization",
  "message_qualifier": "request",
  "source": "visa",
  "card": {
    "card_id": "777a8c3f-34ea-11bd-dafc-617438bb9c61",
    "card_form_factor": "physical"
  },
  "customer": {
    "customer_id": "4117d1ae-a422-9a04-10a0-a04570f5ee91",
    "customer_external_ref": "1117d2ae-a422-9a04-10a0-a04570f5ee91"
  },
  "transaction": {
    "transaction_type": "01",
    "transaction_id": "20d5ccb4-2918-49cc-a458-507bd3c74e32",
    "system_trace_audit_number": "002289",
    "retrieval_reference_number": "134000001984",
		"network_transaction_id": "482272708068910",
    "transmission_date": "1206",
    "transmission_time": "182751",
    "transaction_local_date": "1206",
    "transaction_local_time": "192748",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "from_account": "default",
    "dcc_indicator": "n",
    "chip_indicator": "contact",
    "pin_indicator": "online_passed",
    "3ds_indicator": "n",
    "partial_approval_supported": "n"
  },
  "acquirer": {
    "acquiring_institution_id_code": "843759",
    "acquiring_institution_country_code": "826",
    "merchant_category_code": "6011",
    "card_acceptor_terminal_id": "ATM00001",
    "card_acceptor_id": "NEWBANKMERCHANT",
    "card_acceptor_name": "NEW BANK LIMITED",
    "card_acceptor_city": "Oxford",
    "card_acceptor_country_code": "826",
    "card_acceptor_post_code": "OX1 1HS"
  }
}

Sample Response - Cash Withdrawal - 200

{
  "message_type": "authorization",
  "message_qualifier": "response",
  "card": {
    "card_id": "777a8c3f-34ea-11bd-dafc-617438bb9c61"
  },
  "transaction": {
    "transaction_id": "48a36fb1-9080-da51-aaa7-20fa11bcafa3",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "outcome": {
      "response_code": "000",
      "response_source": "Your Company Ltd",
	  "response_reason": "Approved"
    }
  }
}

Sample Request - International Cash Withdrawal

{
  "message_type": "authorization",
  "message_qualifier": "request",
  "source": "visa",
  "card": {
    "card_id": "8afe298a-1b6b-41ec-ae1e-8aa63c5fa33f",
    "card_form_factor": "physical"
  },
  "customer": {
    "customer_id": "542773be-439d-49d7-bfc9-b287080e4b09",
    "customer_external_ref": "3bffe43a-625c-4918-8c8e-56ada5d67195"
  },
  "transaction": {
    "transaction_type": "01",
    "transaction_id": "fd4b9717-3138-4027-aaa8-e2828bb0361a",
    "system_trace_audit_number": "005700",
    "retrieval_reference_number": "134000005700",
		"network_transaction_id": "751937516853300",
    "transmission_date": "0615",
    "transmission_time": "100954",
    "transaction_local_date": "0615",
    "transaction_local_time": "100954",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "cardholder_billing_amount": "11263",
    "cardholder_billing_currency_code": "978",
    "cardholder_billing_conversion_rate": "411263",
    "from_account": "default",
    "dcc_indicator": "n",
    "chip_indicator": "contact",
    "pin_indicator": "online_passed",
    "3ds_indicator": "n",
    "partial_approval_supported": "n"
  },
  "acquirer": {
    "acquiring_institution_id_code": "843759",
    "acquiring_institution_country_code": "826",
    "merchant_category_code": "6011",
    "card_acceptor_terminal_id": "ATM00001",
    "card_acceptor_id": "NEWBANKMERCHANT",
    "card_acceptor_name": "NEW BANK LIMITED",
    "card_acceptor_city": "Oxford",
    "card_acceptor_country_code": "826",
    "card_acceptor_post_code": "OX1 1HS"
  }
}

Sample Response - International Cash Withdrawal - 200

{
  "message_type": "authorization",
  "message_qualifier": "response",
  "card": {
    "card_id": "8afe298a-1b6b-41ec-ae1e-8aa63c5fa33f"
  },
  "transaction": {
    "transaction_id": "fd4b9717-3138-4027-aaa8-e2828bb0361a",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "cardholder_billing_amount": "11263",
    "cardholder_billing_currency_code": "978",
    "outcome": {
      "response_code": "000",
      "response_source": "Your Company Ltd",
	  "response_reason": "Approved"
    }
  }
}

Sample Request - Cash Withdrawal Partial Reversal

{
  "message_type": "reversal",
  "message_qualifier": "request",,
  "source": "visa",
  "card": {
    "card_id": "777a8c3f-34ea-11bd-dafc-617438bb9c61",
    "card_form_factor": "physical"
  },
  "customer": {
    "customer_id": "4117d1ae-a422-9a04-10a0-a04570f5ee91",
    "customer_external_ref": "1117d2ae-a422-9a04-10a0-a04570f5ee91"
  },
  "transaction": {
    "reversal_type": "partial",
    "transaction_type": "01",
    "transaction_id": "48a36fb1-9080-da51-aaa7-20fa11bcafa3",
    "system_trace_audit_number": "002290",
    "retrieval_reference_number": "134000001984",
		"network_transaction_id": "482272708068910",
    "transmission_date": "1206",
    "transmission_time": "182815",
    "transaction_local_date": "1206",
    "transaction_local_time": "192812",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "from_account": "default",
    "update": {
      "original_message_type": "authorization",
      "original_message_qualifier": "request",
      "original_transaction_id": "20d5ccb4-2918-49cc-a458-507bd3c74e32",
      "original_system_trace_audit_number": "002289",
      "original_retrieval_reference_number": "134000001984",
      "original_transmission_date": "1206",
      "original_transmission_time": "182751",
      "original_transaction_amount": "10000",
      "actual_transaction_amount": "8000"
    },
    "status": {
      "response_code": "000",
      "response_source": "network",
      "response_reason": "Approved",
      "authorization_id_response": "824761"
    }
  },
  "acquirer": {
    "acquiring_institution_id_code": "843759",
    "acquiring_institution_country_code": "826",
    "merchant_category_code": "6011",
    "card_acceptor_terminal_id": "ATM00001",
    "card_acceptor_id": "NEWBANKMERCHANT",
    "card_acceptor_name": "NEW BANK LIMITED",
    "card_acceptor_city": "Oxford",
    "card_acceptor_country_code": "826",
    "card_acceptor_post_code": "OX1 1HS"
  }
}

Sample Response - Cash Withdrawal Partial Reversal - 200

{
  "message_type": "reversal",
  "message_qualifier": "response",
  "card": {
    "card_id": "777a8c3f-34ea-11bd-dafc-617438bb9c61"
  },
  "transaction": {
    "transaction_id": "48a36fb1-9080-da51-aaa7-20fa11bcafa3",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "outcome": {
      "response_code": "000",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Approved"
    }
  }
}

Sample Request - E-commerce purchase

{
  "message_type": "authorization",
  "message_qualifier": "request",
  "source": "visa",
  "card": {
    "card_id": "7ee4622f-7e19-43ed-9492-06184ab84529",
    "card_form_factor": "virtual"
  },
  "customer": {
    "customer_id": "c94b04f8-3272-4e02-b7eb-5a894d39bbf1",
    "customer_external_ref": "1ae4622f-7e19-43ed-9492-06184ab84582"
  },
  "transaction": {
    "transaction_type": "00",
    "transaction_id": "48a3fbb4-da9c-49ef-f1b8-5020fac711bc",
    "system_trace_audit_number": "005719",
    "retrieval_reference_number": "128300943815",
	"network_transaction_id": "632295486619379",
    "transmission_date": "1015",
    "transmission_time": "114821",
    "transaction_local_date": "1015",
    "transaction_local_time": "114810",
    "transaction_amount": "8759",
    "transaction_currency_code": "826",
    "from_account": "default",
		"ECI": "05",
    "dcc_indicator": "n",
    "chip_indicator": "n",
    "pin_indicator": "n",
    "3ds_indicator": "y",
    "avs_outcome": "m",
    "partial_approval_supported": "n",
    "3ds_additional_data": {
      "3ds_provider": "3DS 4 U",
      "3ds_authentication_method": "OTP",
      "3ds_otp_delivery_method": "Company API",
      "3ds_reference_number": "20211015adhu159"
    }
  },
  "acquirer": {
    "acquiring_institution_id_code": "447219",
    "acquiring_institution_country_code": "826",
    "merchant_category_code": "5942",
    "card_acceptor_terminal_id": "ECOMM001",
    "card_acceptor_id": "ECOMMERCEMRCHNT",
    "card_acceptor_name": "ONLINE SALES LTD",
    "card_acceptor_city": "Slough",
    "card_acceptor_country_code": "826"
  }
}

Sample Response - E-commerce purchase - 200

{
  "message_type": "authorization",
  "message_qualifier": "response",
  "card": {
    "card_id": "7ee4622f-7e19-43ed-9492-06184ab84529"
  },
  "transaction": {
    "transaction_id": "48a3fbb4-da9c-49ef-f1b8-5020fac711bc",
    "transaction_amount": "8759",
    "transaction_currency_code": "826",
    "outcome": {
      "response_code": "000",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Approved"
    }
  }
}

Sample Request - International E-commerce purchase

{
  "message_type": "authorization",
  "message_qualifier": "request",
  "source": "visa",
  "card": {
    "card_id": "388611f3-ecad-4477-b5a3-64190b9e7bb6",
    "card_form_factor": "virtual"
  },
  "customer": {
    "customer_id": "d881513d-b291-42ed-a4da-2cfae94795dc",
    "customer_external_ref": "2a87a5c9-6e98-4f55-ae1d-b34235012333"
  },
  "transaction": {
    "transaction_type": "00",
    "transaction_id": "c8153120-fc18-414a-8001-9f01ae315634",
    "system_trace_audit_number": "571893",
    "retrieval_reference_number": "128300571893",
		"network_transaction_id": "141467985320149",
    "transmission_date": "0301",
    "transmission_time": "171244",
    "transaction_local_date": "0301",
    "transaction_local_time": "121244",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "cardholder_billing_amount": "12000",
    "cardholder_billing_currency_code": "840",
    "cardholder_billing_conversion_rate": "2120",
    "from_account": "default",
		"ECI": "05",
    "dcc_indicator": "n",
    "chip_indicator": "n",
    "pin_indicator": "n",
    "3ds_indicator": "y",
    "avs_outcome": "m",
    "partial_approval_supported": "n",
    "3ds_additional_data": {
      "3ds_provider": "3DS 4 U",
      "3ds_authentication_method": "OTP",
      "3ds_otp_delivery_method": "Company API",
      "3ds_reference_number": "20211015adhu159"
    }
  },
  "acquirer": {
    "acquiring_institution_id_code": "447219",
    "acquiring_institution_country_code": "826",
    "merchant_category_code": "5942",
    "card_acceptor_terminal_id": "88447379",
    "card_acceptor_id": "97531684216781",
    "card_acceptor_name": "TIX.COM",
    "card_acceptor_city": "Austin",
    "card_acceptor_country_code": "840"
  }
}

Sample Response - International E-commerce purchase - 200

{
  "message_type": "authorization",
  "message_qualifier": "response",
  "card": {
    "card_id": "388611f3-ecad-4477-b5a3-64190b9e7bb6"
  },
  "transaction": {
    "transaction_id": "c8153120-fc18-414a-8001-9f01ae315634",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "cardholder_billing_amount": "12000",
    "cardholder_billing_currency_code": "840",
    "outcome": {
      "response_code": "000",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Approved"
    }
  }
}

Sample Request - Pre-Authorisation

{
	"message_type": "authorization",
	"message_qualifier": "request",
	"source": "mastercard",
	"card": {
		"card_id": "be6f7f28-f123-474e-a898-0543b272678f",
		"card_form_factor": "physical",
		"card_status": "active"
	},
	"customer": {
		"customer_id": "5fb71d49-8cb7-45eb-bdf3-cdad6d01f077"
	},
	"transaction": {
		"auth_type": "preauth",
		"credential_on_file": "n",
		"transaction_type": "00",
		"transaction_id": "1a20538c-0824-466c-bd24-7e05546e399b",
		"system_trace_audit_number": "603198",
		"retrieval_reference_number": "428291362847",
		"transmission_date": "1008",
		"transmission_time": "171653",
		"transaction_local_date": "1008",
		"transaction_local_time": "051653",
		"transaction_amount": "110",
		"transaction_currency_code": "826",
		"cardholder_billing_amount": "110",
		"cardholder_billing_currency_code": "826",
		"cardholder_billing_conversion_rate": "61000000",
		"from_account": "default",
		"to_account": "default",
		"dcc_indicator": "n",
		"chip_indicator": "contactless",
		"pin_indicator": "n",
		"3ds_indicator": "n",
		"avs_outcome": "n",
		"partial_approval_supported": "n",
		"authorization_code": "243363",
		"status": {
			"response_code": "000",
			"response_source": "clowd9",
			"response_reason": "Approved"
		}
	},
	"acquirer": {
		"acquiring_institution_id_code": "555555",
		"merchant_category_code": "5542",
		"card_acceptor_terminal_id": "CHIPEMV2",
		"card_acceptor_id": "MERCHANT 000005",
		"card_acceptor_name": "ASDA GROCERIES        ",
		"card_acceptor_city": "LONDON       ",
		"card_acceptor_country_code": "GBR"
	}
}

Sample Request - High Risk Merchant

{
  "message_type": "authorization",
  "message_qualifier": "request",
  "source": "visa",
  "card": {
    "card_id": "7ee4622f-7e19-43ed-9492-06184ab84529",
    "card_form_factor": "virtual"
  },
  "customer": {
    "customer_id": "c94b04f8-3272-4e02-b7eb-5a894d39bbf1",
    "customer_external_ref": "1ae4622f-7e19-43ed-9492-06184ab84582"
  },
  "transaction": {
    "transaction_type": "11",
    "transaction_id": "4b049492-894d-b04f-2f7e-6aef22ca8b15",
    "system_trace_audit_number": "001679",
    "retrieval_reference_number": "136500000271",
		"network_transaction_id": "482287561408801",
    "transmission_date": "1231",
    "transmission_time": "220541",
    "transaction_local_date": "1231",
    "transaction_local_time": "220535",
    "transaction_amount": "50000",
    "transaction_currency_code": "826",
    "from_account": "default",
    "dcc_indicator": "n",
    "chip_indicator": "n",
    "pin_indicator": "n",
    "3ds_indicator": "n",
    "avs_outcome": "m",
    "partial_approval_supported": "n",
    "status": {
      "response_code": "805",
      "response_source": "clowd9",
      "response_reason": "High Risk Merchant"
    }
  },
  "acquirer": {
    "acquiring_institution_id_code": "514666",
    "acquiring_institution_country_code": "826",
    "merchant_category_code": "7995",
    "card_acceptor_terminal_id": "GAMBLE07",
    "card_acceptor_id": "TYMCASINOMRCHNT",
    "card_acceptor_name": "TAKE YOUR MONEY CASINO",
    "card_acceptor_city": "Lynton",
    "card_acceptor_country_code": "833",
    "card_acceptor_post_code": "EX35 6HW"
  }
}

Sample Response - High Risk Merchant, Declined - 200

{
  "message_type": "authorization",
  "message_qualifier": "response",
  "card": {
    "card_id": "7ee4622f-7e19-43ed-9492-06184ab84529"
  },
  "transaction": {
    "transaction_id": "48a3fbb4-da9c-49ef-f1b8-5020fac711bc",
    "transaction_amount": "50000",
    "transaction_currency_code": "826",
    "outcome": {
      "response_code": "119",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Transaction Forbidden to Cardholder"
    }
  }
}

Sample Response - High Risk Merchant, Approved - 200

{
  "message_type": "authorization",
  "message_qualifier": "response",
  "card": {
    "card_id": "7ee4622f-7e19-43ed-9492-06184ab84529"
  },
  "transaction": {
    "transaction_id": "48a3fbb4-da9c-49ef-f1b8-5020fac711bc",
    "transaction_amount": "50000",
    "transaction_currency_code": "826",
    "outcome": {
      "response_code": "000",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Approved"
    }
  }
}

Sample Notification - Declined authorization

{
  "message_type": "authorization",
  "message_qualifier": "notification",
  "source": "visa",
  "card": {
    "card_id": "7ee4622f-7e19-43ed-9492-06184ab84529",
    "card_form_factor": "virtual"
  },
  "customer": {
    "customer_id": "4117d1ae-a422-9a04-10a0-a04570f5ee91",
    "customer_external_ref": "1117d2ae-a422-9a04-10a0-a04570f5ee91"
  },
  "transaction": {
    "transaction_type": "00",
    "transaction_id": "5a10dabf-1157-a38d-14f8-c0ac701b3391",
    "system_trace_audit_number": "215573",
    "retrieval_reference_number": "201509712549",
		"network_transaction_id": "302305699193421",
    "transmission_date": "0115",
    "transmission_time": "225301",
    "transaction_local_date": "0115",
    "transaction_local_time": "225255",
    "transaction_amount": "5499",
    "transaction_currency_code": "826",
    "from_account": "default",
		"ECI": "05",
    "dcc_indicator": "n",
    "chip_indicator": "n",
    "pin_indicator": "n",
    "3ds_indicator": "y",
    "avs_outcome": "m",
    "3ds_additional_data": {
      "3ds_provider": "3DS 4 U",
      "3ds_authentication_method": "OTP",
      "3ds_otp_delivery_method": "Company API",
      "3ds_reference_number": "20220115ffca719"
    },
    "status": {
      "response_code": "121",
      "response_source": "clowd9",
      "response_reason": "Limit exceeded. Limit group: [Daily Purchase cumulative amount]"
    }
  },
  "acquirer": {
    "acquiring_institution_id_code": "447219",
    "acquiring_institution_country_code": "826",
    "merchant_category_code": "5942",
    "card_acceptor_terminal_id": "ECOMM001",
    "card_acceptor_id": "ECOMMERCEMRCHNT",
    "card_acceptor_name": "ONLINE SALES LTD",
    "card_acceptor_city": "Slough",
    "card_acceptor_country_code": "826"
  }
}

Sample Notification Acknowledgment - Declined authorization - 200

{
  "message_type": "authorization",
  "message_qualifier": "notification acknowledged",
  "card": {
    "card_id": "7ee4622f-7e19-43ed-9492-06184ab84529"
  },
  "transaction": {
    "transaction_id": "5a10dabf-1157-a38d-14f8-c0ac701b3391",
    "transaction_amount": "5499",
    "transaction_currency_code": "826",
    "outcome": {
      "response_code": "091",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Advice acknowledged"
    }
  }
}

Sample Notification - Declined transaction with card status change

{
  "message_type": "authorization",
  "message_qualifier": "notification",
  "source": "visa",
  "card": {
    "card_id": "777a8c3f-34ea-11bd-dafc-617438bb9c61",
    "card_form_factor": "physical",
    "card_status": "blocked",
    "card_prev_status": "active",
    "card_status_change_reason": "PIN Tries Exceeded"
  },
  "customer": {
    "customer_id": "4117d1ae-a422-9a04-10a0-a04570f5ee91",
    "customer_external_ref": "1117d2ae-a422-9a04-10a0-a04570f5ee91"
  },
  "transaction": {
    "transaction_type": "01",
    "transaction_id": "7d41aeb4-15a0-9f27-00ab-f5eb81632a8f",
    "system_trace_audit_number": "007691",
    "retrieval_reference_number": "131500055187",
		"network_transaction_id": "632316477439445",
    "transmission_date": "1111",
    "transmission_time": "210522",
    "transaction_local_date": "1111",
    "transaction_local_time": "210519",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "from_account": "default",
    "dcc_indicator": "n",
    "chip_indicator": "contact",
    "pin_indicator": "online_failed",
    "3ds_indicator": "n",
    "avs_outcome": "m",
    "status": {
      "response_code": "104",
      "response_source": "clowd9",
      "response_reason": "Allowable PIN Tries Exceeded"
    }
  },
  "acquirer": {
    "acquiring_institution_id_code": "843759",
    "acquiring_institution_country_code": "826",
    "merchant_category_code": "6011",
    "card_acceptor_terminal_id": "ATM00001",
    "card_acceptor_id": "NEWBANKMERCHANT",
    "card_acceptor_name": "NEW BANK LIMITED",
    "card_acceptor_city": "Oxford",
    "card_acceptor_country_code": "826",
    "card_acceptor_post_code": "OX1 1HS"
  }
}

Sample Notification Acknowledgment - Declined transaction with card status change - 200

{
  "message_type": "authorization",
  "message_qualifier": "notification acknowledged",
  "card": {
    "card_id": "777a8c3f-34ea-11bd-dafc-617438bb9c61"
  },
  "transaction": {
    "transaction_id": "7d41aeb4-15a0-9f27-00ab-f5eb81632a8f",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "outcome": {
      "response_code": "091",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Advice acknowledged"
    }
  }
}

Sample Notification - Full Reversal

{
  "message_type": "reversal",
  "message_qualifier": "notification",
  "source": "visa",
  "card": {
    "card_id": "777a8c3f-34ea-11bd-dafc-617438bb9c61",
    "card_form_factor": "physical"
  },
  "customer": {
    "customer_id": "4117d1ae-a422-9a04-10a0-a04570f5ee91",
    "customer_external_ref": "1117d2ae-a422-9a04-10a0-a04570f5ee91"
  },
  "transaction": {
    "transaction_type": "01",
    "transaction_id": "48a36fb1-9080-da51-aaa7-20fa11bcafa3",
    "system_trace_audit_number": "002290",
    "retrieval_reference_number": "134000001984",
		"network_transaction_id": "482272708068910",
    "transmission_date": "1206",
    "transmission_time": "182815",
    "transaction_local_date": "1206",
    "transaction_local_time": "192812",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "from_account": "default",
    "update": {
      "original_message_type": "authorization",
      "original_message_qualifier": "request",
      "original_transaction_id": "20d5ccb4-2918-49cc-a458-507bd3c74e32",
      "original_system_trace_audit_number": "002289",
      "original_retrieval_reference_number": "134000001984",
      "original_transmission_date": "1206",
      "original_transmission_time": "182751",
      "original_transaction_amount": "10000"
    },
    "status": {
      "response_code": "000",
      "response_source": "network",
      "response_reason": "Approved",
      "authorization_id_response": "555379"
    }
  },
  "acquirer": {
    "acquiring_institution_id_code": "843759",
    "acquiring_institution_country_code": "826",
    "merchant_category_code": "6011",
    "card_acceptor_terminal_id": "ATM00001",
    "card_acceptor_id": "NEWBANKMERCHANT",
    "card_acceptor_name": "NEW BANK LIMITED",
    "card_acceptor_city": "Oxford",
    "card_acceptor_country_code": "826",
    "card_acceptor_post_code": "OX1 1HS"
  }
}

Sample Notification Acknowledgment - Full Reversal - 200

{
  "message_type": "reversal",
  "message_qualifier": "notification acknowledged",
  "card": {
    "card_id": "777a8c3f-34ea-11bd-dafc-617438bb9c61"
  },
  "transaction": {
    "transaction_id": "48a36fb1-9080-da51-aaa7-20fa11bcafa3",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "outcome": {
      "response_code": "091",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Advice acknowledged"
    }
  }
}

Sample card status update

{
  "message_type": "administrative",
  "message_qualifier": "notification",
  "card": {
    "card_id": "777a8c3f-34ea-11bd-dafc-617438bb9c61",
    "card_form_factor": "physical",
    "card_status": "expired",
    "card_prev_status": "active",
    "card_status_change_reason": "Card Expiration date passed"
  },
  "customer": {
    "customer_id": "4117d1ae-a422-9a04-10a0-a04570f5ee91",
    "customer_external_ref": "1117d2ae-a422-9a04-10a0-a04570f5ee91"
  }
}

Sample card status update - acknowledgment - 200

{
  "message_type": "administrative",
  "message_qualifier": "notification acknowledged",
  "card": {
    "card_id": "7ee4622f-7e19-43ed-9492-06184ab84529"
  },
  "transaction": {
    "outcome": {
      "response_code": "091",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Advice acknowledged"
    }
  }
}

Sample clearing notification

{
  "message_type": "clearing",
  "message_qualifier": "notification",
  "clearing": {
	"clearing_category": "sales debit",
    "transaction_type": "1",
    "reason_code": "00",
    "reference_number": "5942",
    "sequence_number": "1",
    "date": "1206",
    "authorization_code": "C90012",
    "authorizations":[{
    	"authTransactionId": "48a36fb1-9080-da51-aaa7-20fa11bcafa3",
      "system_trace_audit_number": "123456",
      "retrieval_reference_number": "123456789012"
    }],
    "cardholder_billing_amount": "10000",
    "cardholder_billing_currency_code": "826",
    "transaction_amount": "10000",
    "transaction_currency_code": "826",
    "interchange_fee": "C0000500",
    "clearing_outcome": "0",
    "cardholder_billing_conversion_rate": "0"
  }
}

Sample clearing notification - acknowledgment - 200

{
  "message_type": "clearing",
  "message_qualifier": "notification acknowledged",
  "transaction": {
    "outcome": {
      "response_code": "091",
      "response_source": "Your Company Ltd",
	  	"response_reason": "Advice acknowledged"
    }
  }
}

Error response - incorrect data provided - 400

{
  "code": 400,
  "message": "Provided data is incorrect",
  "details": []
}

Error response - unauthorized API call - 401

{
  "code": 401,
  "message": "Unauthorized",
  "details": []
}

Error response - insufficient access rights - 403

{
  "code": 403,
  "message": "You do not have correct access rights",
  "details": []
}

Dynamic Data Stream (DDS) Specifications Speak to GH before progressing