DYNAMIC EVENT NOTIFICATION

CCAvenue Dynamic Event Notification enables you to register URLs for various events that occurs in your
account.

When the event occurs, for example when a successful payment is made in your account, CCAvenue
creates an event object. This object contains all the relevant information, including the type of event
and the data associated with that event.
CCAvenue then sends an HTTP POST request with the event object to URL in your account's webhook
settings.

CONFIGURE URLS FOR EVENTS

1. Order Status: If the merchant does not post a returnURL, and stores a URL in this section, the
customer would be redirected to the page specified here. For eg in invoice payments the
CCAvenue page loads with status of transaction, merchant may choose to display his page.

2. Order status echo URL: an asynchronous server to server push of the response parameters is
done in real time to this alternate URL.

3. Order Reconciliation Status: In case the status of any transaction is not known in real-time,
CCAvenue periodically does an authStatusQuery to the banks (who provide this facility) and if
 the status is updated we push the response to the merchant . For the rest of the banks status is
posted once the offline recon is done.

4. Order Risk Status : Whenever any transaction is flagged as High risk or Low risk we notify the
merchant vide this call.

5. Payment Type Status : CCAvenue does the health check up of the banks. If we notice any
fluctuations /downtime the status is pushed to your server.
P.S: In case your server has not received this notification due to any issues, the payment option
may be down for longer than it actually. Hence we recommend you use the JSON call regularly
to re-check. CCAvenue also sends email notification for the same. Please share your email ids in
case you wish to receive gateway monitoring notifications.

RESPONSE HANDLING :
CCavenue will post the response parameter "encResp" through URL-connection (server to server) on
the URL provided by the merchant, which contains encrypted value, which is encrypted using
merchant's primary url's working key mentioned in MARS panel.

Decryption of the "encResp" can be done at the merchant’s end using the Utility provided.

On decryption the parameter string would be "&" separated Key-value pair

For eg : "order_id","tracking_id","bank_ref_no","order_status","payment_mode","currency","amount"
etc.

Ex:
order_id=1324&tracking_id=20158563255&order_status=Successful&currency=INR&amount=100.00

1. RESPONSE PARAMETERS FOR ORDER STATUS

Name Description Type (length)

Unique ID sent by the merchant at the
order_id time of initiating the transaction. Alphanumeric (30)
Unique payment reference number
tracking_id generated by CCAvenue for each order. Numeric (12)
Reference number generated by the bank for
bank_ref_no the transaction. Alphanumeric
order_status Status of the transaction. Alphabets (15)
Success
Failure
Aborted
Invalid
failure_message Reason for failure. Alphanumeric
payment_mode Mode of payment used by the customer Alphabets
 Credit Card
Net banking
Debit Card
Cash Card
Mobile Payment
Wallet
Credit Card EMI
The name of the card/bank used by the
customer to make the payment. Credit Card -
Visa, Mastercard, Amex Netbanking - ICICI,
card_name HDFC, SBI etc. Alphanumeric
status_code Authorization code received from the bank. Numeric (3)
Authorization status message received from
status_message the bank. Alphanumeric (150)
Currency code in which the transaction was
currency processed. Alphabets (3)
INR - Indian Rupee
USD - United States Dollar
SGD - Singapore Dollar
GBP - Pound Sterling
EUR - Euro, official currency of Eurozone
amount Order amount Numeric (12, 2)
billing_name Name of the customer Alphabets (60)
billing_address Customer's billing address Alphanumeric (150)
billing_city Customer's billing city Alphabets (30)
billing_state Customer's billing state Alphabets (30)
billing_zip Customer's billing zip code Alphanumeric (15)
billing_country Customer's billing country Alphabets (50)
billing_tel Customer's phone number Numeric (20)
billing_email Customer's email address Alphanumeric (70)
delivery_name Recipient's name Alphabets (60)
delivery_address Shipping address Alphanumeric (150)
delivery_city Shipping city Alphabets (30)
delivery_state Shipping state Alphabets (30)
delivery_zip Shipping zip code Alphanumeric (15)
delivery_country Shipping country Alphabets (50)
delivery_tel Shipping phone number Numeric (22)
Additional information about the transaction
merchant_param1 sent by the merchant. Alphanumeric (100)
Additional information about the transaction
merchant_param2 sent by the merchant. Alphanumeric (100)
Additional information about the transaction
merchant_param3 sent by the merchant. Alphanumeric (100)
 Additional information about the transaction
merchant_param4 sent by the merchant. Alphanumeric (100)
Additional information about the transaction
merchant_param5 sent by the merchant. Alphanumeric (100)
This parameter can be used if merchant
availing the vault option. On using vault
functionality if card details are saved at
CCAvenue end value returned will be Y. If
card details are not saved at CCAvenue end
the value returned for this parameter will be
vault N. Character (1)
This parameter can be used for sending
additional information if customer has used
any discount or promotion while completing
the transaction. If customer is using discount-
coupon, value of this parameter would be
discount. If customer is using promo-code,
offer_type value of this parameter would be promotion. Alphabets (9)
This parameter can be used for sending
additional information about the discount
coupon and Promo code used while
completing the transaction. If customer has
used Discount the value sent would be
Discount code. If customer has used
Promotion the value sent would be Promo
offer_code code. Alphanumeric (30)
This parameter can be used for sending
additional information about the discounted
discount_value amount. Numeric (12,2)

RESPONSE PARAMETERS FOR ORDER STATUS ECHO URL

Name Description Type (length)

order_id Unique ID sent by the merchant at the time of Alphanumeric (30)
initiating the transaction.
tracking_id Unique payment reference number generated Numeric (12)
by CCAvenue for each order.
bank_ref_no Reference number generated by the bank for Alphanumeric
the transaction.
order_status Status of the transaction. Alphabets (15)
Success
Failure
Aborted
Invalid
 initiated (please contact CCAvenue support, if
this status appears which will arise incase
particular card not supported.)
failure_message Reason for failure. Alphanumeric
payment_mode Mode of payment used by the customer Alphabets
Credit Card
Net banking
Debit Card
Cash Card
Mobile Payment
Wallet
Credit Card EMI
card_name The name of the card/bank used by the Alphanumeric
customer to make the payment. Credit Card -
Visa, Mastercard, Amex Netbanking - ICICI,
HDFC, SBI etc.
status_code Authorization code received from the bank. Numeric (3)
status_message Authorization status message received from the Alphanumeric (150)
bank.
currency Currency code in which the transaction was Alphabets (3)
processed.
INR - Indian Rupee
USD - United States Dollar
SGD - Singapore Dollar
GBP - Pound Sterling
EUR - Euro, official currency of Eurozone
amount Order amount Numeric (12, 2)
billing_name Name of the customer Alphabets (60)
billing_address Customer's billing address Alphanumeric (150)
billing_city Customer's billing city Alphabets (30)
billing_state Customer's billing state Alphabets (30)
billing_zip Customer's billing zip code Alphanumeric (15)
billing_country Customer's billing country Alphabets (50)
billing_tel Customer's phone number Numeric (20)
billing_email Customer's email address Alphanumeric (70)
delivery_name Recipient's name Alphabets (60)
delivery_address Shipping address Alphanumeric (150)
delivery_city Shipping city Alphabets (30)
delivery_state Shipping state Alphabets (30)
delivery_zip Shipping zip code Alphanumeric (15)
delivery_country Shipping country Alphabets (50)
delivery_tel Shipping phone number Numeric (22)
merchant_param1 Additional information about the transaction Alphanumeric (100)
sent by the merchant.
merchant_param2 Additional information about the transaction Alphanumeric (100)
sent by the merchant.
merchant_param3 Additional information about the transaction Alphanumeric (100)
sent by the merchant.
merchant_param4 Additional information about the transaction Alphanumeric (100)
sent by the merchant.
merchant_param5 Additional information about the transaction Alphanumeric (100)
sent by the merchant.
vault This parameter can be used if merchant availing Character (1)
the vault option. On using vault functionality if
card details are saved at CCAvenue end value
returned will be Y. If card details are not saved
at CCAvenue end the value returned for this
parameter will be N.
offer_type This parameter can be used for sending Alphabets (9)
additional information if customer has used any
discount or promotion while completing the
transaction. If customer is using discount-
coupon, value of this parameter would be
discount. If customer is using promo-code,
value of this parameter would be promotion.
offer_code This parameter can be used for sending Alphanumeric (30)
additional information about the discount
coupon and Promo code used while completing
the transaction. If customer has used Discount
the value sent would be Discount code. If
customer has used Promotion the value sent
would be Promo code.
discount_value This parameter can be used for sending Numeric (12,2)
additional information about the discounted
amount.

RESPONSE PARAMETERS FOR ORDER RECONCILIATION STATUS

Name Description Type (length)

order_id Unique ID sent by the merchant at the time of Alphanumeric (30)
initiating the transaction.
tracking_id Unique payment reference number generated Numeric (12)
by CCAvenue for each order.
bank_ref_no Reference number generated by the bank for Alphanumeric
the transaction.
order_status Status of the transaction. Alphabets (15)
Successful/Shipped
 Unsuccessful
Auto-Reversed
failure_message Reason for failure. Alphanumeric
payment_mode Mode of payment used by the customer Alphabets
Credit Card
Net banking
Debit Card
Cash Card
Mobile Payment
Wallet
Credit Card EMI
card_name The name of the card/bank used by the Alphanumeric
customer to make the payment. Credit Card -
Visa, Mastercard, Amex Netbanking - ICICI,
HDFC, SBI etc.
status_code Authorization code received from the bank. Numeric (3)
status_message Authorization status message received from the Alphanumeric (150)
bank.
currency Currency code in which the transaction was Alphabets (3)
processed.
INR - Indian Rupee
USD - United States Dollar
SGD - Singapore Dollar
GBP - Pound Sterling
EUR - Euro, official currency of Eurozone
amount Order amount Numeric (12, 2)
billing_name Name of the customer Alphabets (60)
billing_address Customer's billing address Alphanumeric (150)
billing_city Customer's billing city Alphabets (30)
billing_state Customer's billing state Alphabets (30)
billing_zip Customer's billing zip code Alphanumeric (15)
billing_country Customer's billing country Alphabets (50)
billing_tel Customer's phone number Numeric (20)
billing_email Customer's email address Alphanumeric (70)
delivery_name Recipient's name Alphabets (60)
delivery_address Shipping address Alphanumeric (150)
delivery_city Shipping city Alphabets (30)
delivery_state Shipping state Alphabets (30)
delivery_zip Shipping zip code Alphanumeric (15)
delivery_country Shipping country Alphabets (50)
delivery_tel Shipping phone number Numeric (22)
merchant_param1 Additional information about the transaction Alphanumeric (100)
sent by the merchant.
merchant_param2 Additional information about the transaction Alphanumeric (100)
sent by the merchant.
merchant_param3 Additional information about the transaction Alphanumeric (100)
sent by the merchant.
merchant_param4 Additional information about the transaction Alphanumeric (100)
sent by the merchant.
merchant_param5 Additional information about the transaction Alphanumeric (100)
sent by the merchant.

RESPONSE PARAMETERS FOR ORDER RISK STATUS

Name Description Type (length)

order_id Unique ID sent by the merchant at the time of Alphanumeric (30)

initiating the transaction.
tracking_id Unique payment reference number generated Numeric (12)
by CCAvenue for each order.
risk_status Alphanumeric
High - High Risk

Low - Low Risk

NR - No Risk

GA - Go Ahead

risk_reason Transaction originated from High Risk Alphanumer

Country List.
Billing Tel number is in our negative
database.
Shipping Tel Number is in our negative
database.
Customer country does not match Country
where Card was issued.

Customer IP is an open proxy IP.

Email Id is in our negative database.

Card is in our negative database.

Transaction did not originate from Country

where Card was issued.
 Customer is using a free email service
provider.

RESPONSE PARAMETERS FOR PAYMENT TYPE STATUS

Name Description Type (length)

card_name The name of the card/bank used by Alphanumeric

the customer to make the payment.
Credit Card - Visa, Mastercard, Amex
Netbanking - ICICI, HDFC, SBI etc.

payment_option Payment option used by the customer Alphanumeric

Credit Card

Net banking

Debit Card

Cash Card

Mobile Payment

Wallet

Credit Card EMI

current_status Current status of the gateway Alphabets

ACTI - Active

FLCT - Fluctuate

INAC - Inactive

DOWN - Down

NEW - Newly added Payment option.