Merchant’s API Implementation Guide

Statement of Confidentiality

This document contains information that is proprietary and confidential to Avenues India Private Limited which shall
not be disclosed,transmitted,or duplicated,used in whole or in part for any purpose other than its intended purpose.
Any use or disclosure in wholeorinpartofthis information without express written permission of Avenues India Private
Ltd is prohibited. Any other company and product names mention edareused for identification purposes only,and may
be trademarks of the irrespective owners.
CCAvenue API

The CCAvenue API is designed to enable you to interact securely with our API from your client-side web application.
You can get XML and JSON responses from the API including errors.

You need an active account to initiate an API call to the CCAvenue payment gateway.

API Authentication

Merchant needs an active account to initiate an API call to the CCAvenue payment gateway. Merchants will have to
log in to their CCAvenue M.A.R.S account and get the authentication credentials for initiating API calls.

Merchant must provide CCAvenue with the public IPaddress from where the API calls will be initiated. API calls will
work only after CCAvenue registers the IP address provided.

Login to your CCAvenue M.A.R.S account, under Settings tab -> API Keys page; copy the following
credentials:

1. Merchant ID

2. Access Code

3. Encryption Key
API Calls

CCAvenue API supports following API calls.

1. Confirm – The Confirm API call allows you to confirm a pending order. Only confirmed orders
are settled into the merchant’s account. An order older than 12 days is automatically
cancelled. Once an orderhasbeen auto-cancelled by thesystem, it cannot be confirmed.

2. Cancel – The Cancel API call allows you to cancel a pending order. Funds will be refunded to
the credit card or debitcard or netbanking account that was originally charged. Anorder older
than 12 days is automatically cancelled.

3. Refund – The Refund API call allows you to refund an order/transaction that has previously
been executed but not yet refunded. Funds will be refunded to the credit card or debit card
or net banking account that was originally charged.

4. Status(Kindly pass version as 1.2)– The Status API call can be used to ascertain the status of a
transaction/order. You can use this call if you have not received status/information for a
transaction request. It can also be used as an additional security measure to reconfirm the
parameters posted back.

5. Order Lookup(Kindly pass version as 1.2) – The Order Lookup API call can be used to find
transactions/orders based on given criteria.

6. Pending Orders – The Pending Orders API call can be used to list transactions which are yet
to be confirmed or cancelled. Pending orders need to be confirmed for them to be settled,
those older than 12 days are automatically cancelled.

7. Delete Customer - The Delete Customer API call is used to delete all saved payment options
for the customer.

8. Delete Customer Payment Option - The Delete Customer Payment Option API call is used to
delete a particular payment option saved for the customer.

9. Add Customer Payment Option(Kindly pass version as 1.2) – Add Customer payment option
API call is used to add another payment option for registered customerof the merchant.

10. GetCustomer PaymentOption(Kindly pass version as 1.2) – The Customer payment option
APIcall is used to list payment options saved for a customer. Payments options are saved for a
customer in thevaultforeasy and convenientpayment.

11. GenerateInvoice(Kindly pass version as 1.2) - The Invoice API call is used to generate
aninvoice for acustomer. Valuescan be passed as forgeneratinginvoice using the flexibility of
Invoice Settings.
12. Generate Recurring Invoice - Recurring invoice call is used to generate recurring invoice for
a customer of a merchant .

13. Generate Quick Invoice(Kindly pass version as 1.2) - This Quick Invoice API call is used to
generate a quick invoice for a customer. This is a flavour of regular invoice but with limited
options; hence an easy implementation.

14. Get Item List - The Item list API call is used to find the list of configured Items and task for
merchant.The items andtasksareusedto createaregularInvoiceorarecurringinvoice.

15. Invoice Lookup - Invoice Lookup API call is used to find list of invoice order lookup details of
orders.

16. Update Merchant Invoice Reference No- Update Invoicereference Number APIcall is usedto
update Invoicereferencenumberifthesamewasnotprovidedatthetimeofinvoicegeneration.

17. Update Merchant Param - Update Merchant params API is used to add some extra
parameter against Merchantparams if the same couldnot be doneatthe timeofthetransaction.

18. Update Billing Details - Update billing details API call is used to update customer billing
information against anorder.

19. PayId Details – (Kindly pass version as 1.4) - PayId Details API call is used to list
transactions for a given PayId.

20. Payouts Summary(Kindly pass version as 1.2) - Payouts Summary API call is used to list
payouts summary for a merchant for a given settlement date.

21. getRefundDetails – The getRefundDetails API call can be used to fetch refund information ofthe
particular transaction.

22. getSettlementDetails– The getSettlementDetails call is use to get the Settlement details such
payid ,UtrNo and settlement date.

23. ConsolidatePayout Summary - (Kindly pass version as DEF) ConsolidatePayout Summary API call is
used to list payouts summary for a merchant for a given settlement date.

24. ConsolidateSettlementDetails - (Kindly pass version as DEF) ConsolidateSettlementDetails API call

is used to list Settlement Details for a merchant for a given Order Number and Reference
Number.
 Production API URL:- https://api.ccavenue.com/apis/servlet/DoWebTrans

Staging API URL:- https://apitest.ccavenue.com/apis/servlet/DoWebTrans

Encryption of Request for API Calls

Requests sent to CCAvenue will hold the parameters mentioned in the table below.
enc_request, has to be encrypted using AES similar to the method usedfor real-time transaction. Encryption key is
mapped to Accesscode as mentioned in API Authentication section.

Name Description

enc_request(required) AES encrypted request data.

access_code(required) This is the accesscode foryour application.You must send this with each
request.

command(required) This is thecommandtoaccess the APICalls. You must send this with each
request.

request_type(required) API requests are accepted in XML and JSON. Specifytherequesttype.

response_type(optional) APIreturns XML and JSON responses. If left blank, the response will be in
the same format as request.

version(required) This is the version to access API based onversion calls and current possible
values is 1.1

Example:

enc_request=63957FB55DD6E7B968A7588763E08B240878046EF2F520C44BBC63FB9CCE726209A47348
77F5904445591304ABB2F5E598B951E39EAFB9A24584B00590ADB077ADE5E8C444EAC5A250B1EA96F6
8D22E44EA2515401C2CD753DBA91BD0E7DFE7341BE1E7B7550&access_code=8JXENNSSBEZCU8KQ&co
mmand=confirmOrder&request_type=XML&response_type=XML&version=1.1
Decryption of Response for API Calls

Response received from CCAvenue will hold the parameters mentioned in the table below.
enc_response, when encrypted will have to be decrypted using AES similar to the method used for real-
timetransactions.

Encryption key is mapped to Access code as mentioned in API Authentication section.

Name Description

enc_response AES encrypted response containing format as per response_type.

enc_error_code enc_error_code contains valueifstatus is “1”please refer to below table

for the error code.

status This states whether the call was successful or not. If value of this
parameter is“1”then you need not decrypt the enc_responseas it
willcontain plain error message.

Note: - Possible refer below table for enc_response value when status value is “1” as follows.

Example:

Successful:

status=0&enc_response=63957FB55DD6E7B968A7588763E08B240878046EF2F520C44BBC63FB9CCE726
209A473457E6B13721EC6D05ED13A0483ACFDD6F11F284AE79755D47E79687478F93CFCD3CD97510B6
7B961CDB5279F209F5C451F3039696F13C990B963854C8CADF730&enc_error_code=

Error:

status=1&enc_response=Access_code: Invalid Parameter&enc_error_code=51407.

1. Confirm

Confirm API call allows youto confirm a pending order. Only confirmed orders are settled into the
merchant’s account. An order older than 5 days is automatically cancelled. Once an order has been
auto-cancelled by the system,it cannot be confirmed.You can optionally confirm only part of anorder.
Remember, you can doso only once. Remaining funds will be refunded to the credit card or debit card
or net banking account that was originally charged.

Request Parameters

Name Description Note

enc_request AES encrypted string containing request

(required) parameters.

access_code Unique CCAvenue access code which is

(required) generated when merchant registered
their IP address. You must send this with
each request.

request_type API requests are accepted in XML or JSON Possible value for request_type is
(required) format. Specify the request type. “XML” or “JSON”.

response_type API returns responses in XML or JSON Possible value for response_type
(optional) format. If leftblank,the response will be is“XML” or “JSON”.
in the same format as request.

Command Command value specifies the API Possible value for this API call is
(required) calls.Youmust send this with each “confirmOrder”.
request.
reference_no Unique CCAvenue reference number for Numeric(25)
(required) the transaction.

amount Transaction amount to be captured. Decimal(12,2)

(required) Amount can be full or partial of the
transaction amount.

Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Order_List>
<order reference_no="123456789" amount="1.00"/>
<order reference_no="123456789" amount="2.00" />
</Order_List>
Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it
to CCAvenue. Kindly refer to the encryption section.

Example JSON Request

{
"order_List": [
{ "reference_no":"203000099429", "amount": "1.00"},
{ "reference_no": "203000104640", "amount": "1.00"}
]
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before
sending it to CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status This states whether the call was successfulor Value“0”denotes that the API
not. call was successful.
If value ofthis parameter is“1”then you Value“1” denotes API call
need not decrypt the enc_response as it failure. On enc_response is
will contain plain errormessage. plain text represents
theerrormessage.
enc_response AES
encryptedresponsecontainingformat as
per response_type
success_count Merchant checks the successfully processed Numeric
records for confirmation of the
transactions. 0<=success_count<=
Numberof orders to be confirmed.

reference_no Unique CCAvenue reference numbers for Numeric(25)

the transaction.
reason Failurere as on if the given unique String
reference_no not going to confirm. Please refer below table for failure
message.

error_code Error code for Failure. String

Please refer below table for failure
message.

Example XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Order_Result error_code="">
<error_desc></error_desc>
<success_count>0</success_count>
<failed_List>
<failed_order error_code="51304 " reason=" Invalid order/tracking id " reference_no="123456788"/>
<failed_ordererror_code="51206"reason="OrderList:InvalidParameter"
reference_no="123456788"/>
</failed_List>
</Order_Result>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Example JSON Response

{
"failed_List":[
{"reference_no":"123456788","reason":" Invalid order/tracking id
","error_code":"51304 "},
{"reference_no":"123456788","reason":"Order List: Invalid
Parameter","error_code":"51206"}
],
"error_desc":"",
"success_count":0,
"error_code":""
}

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.
2. Cancel

Cancel API call allows you to cancel a pending order.An order older than 12 days is automatically
cancelled. Onceanorderhasbeencancelled/auto-cancelledbythesystem, it cannotbeconfirmed. Fundswillbe
refundedtothecreditcardordebitcardornetbankingaccount thatwas originally charged.

Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. Youmust send thiswitheach
request.

request_type APIrequests are accepted inXML or JSON. Possible value for request_type is
(required) Specify the request type. “XML” or “JSON”.

response_type API returns responses in XML or JSON Possiblevalueforresponse_typeis

(optional) format. Ifleftblank,the responsewill be “XML” or “JSON”.
in the same format as request.

Command Command value specifies the APIcalls.You Possible value for this API call is
(required) must send this with each request. “cancelOrder”

reference_no Unique CCAvenue reference number forthe Numeric(25)

(required) transaction.

amount Transaction amount to be captured. Amount Decimal(12,2)

(required) can be full or partial of the transaction
amount.
Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Order_List>
<order reference_no="123456788" amount="1.00" />
<order reference_no="123456789" amount="2.00" />
</Order_List>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Example JSON Request

{
"order_List": [
{"reference_no":"203000099429","amount": "1.00" },
{"reference_no":"203000099429","amount": "1.00" }
]
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status Thisstateswhetherthecallwassuccessfulor not. Value“0”denotes that API callis
Ifvalue ofthisparameter is“1”thenyou need successful.
notdecrypt the enc_response as it will Value “1” denotes API call failure. On
contain plain errormessage. enc_response is plaintextthat
represents the error message.
enc_response AESencryptedresponsecontainingformatas
per response_type
success_count Merchant checks the successfully processed Numeric
records for cancellation of the transactions.
0<=success_count<=
Numberofordersforthecancel
request.

reference_no Unique CCAvenuereference number for the Numeric(25)

transaction.

reason Failure reasonifgivenreference_no arenot String

going to cancel successfully. Please refer below table for failure
message.

error_code Error code for Failure reason. String

Please refer below table for failure
message.

Example XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Order_Result error_code="">
<error_desc></error_desc>
<success_count>0</success_count>
<failed_List>
<failed_order error_code="51304 " reason=" Invalid order/tracking id " reference_no="123456788"/>
<failed_ordererror_code="51206"reason="OrderList:InvalidParameter"
reference_no="123456788"/>
</failed_List>
</Order_Result>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Example JSON Response

{
"failed_List":[
{"reference_no":"123456788","reason":" Invalid order/tracking id
","error_code":"51304 "},
{"reference_no":"123456788","reason":"Order List: Invalid
Parameter","error_code":"51206"}
],
"error_desc":"",
"success_count":0,
"error_code":""
}
 Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

3. Refund

The Refund API call allows you to refund an order/transaction that has previously been executed but not yet
refunded.Fundswillberefundedtothe creditcardordebitcardornetbankingaccountthatwas originally
charged.

Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. Youmust send thiswitheach
request.

request_type APIrequests are accepted inXML or JSON. Possible value for request_type is
(required) Specify the request type. “XML” or “JSON”.

response_type API returns XML or JSON responses. If left Possiblevalueforresponse_typeis

(optional) blank,the responsewill be inthe same “XML” or “JSON”.
format as request.

command (required) Uniquenamewhichspecifies the APICall. You Possible value for command to this
must send this with each request. API call is “refundOrder”.
reference_no Unique CCAvenuereference number for the Numeric(25)
(required) transaction.

refund_amount Transaction amount to be refund. Amount can Decimal(12,2).

(required) be full or partial of the transaction amount.

refund_ref_no Unique reference numbershared by merchant AlphaNumeric(30)

(required) to refund the captured transaction amount.

Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Refund_Order_Query reference_no="1236547" refund_amount="1.0" refund_ref_no="API1234">
</Refund_Order_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Example JSON Request

{
"reference_no":"1236547",
"refund_amount":"1.0",
"refund_ref_no":"API1234"
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly refer to the encryption section.
Response Parameters

Name Description Note

status Thisstateswhetherthecallwassuccessfulor not. Value“0” denotes the APIcall was
Ifvalue ofthisparameter is“1”thenyou need successful.
notdecrypt the enc_response asitwill Value“1” denotes API call failure.
contain plain errormessage. On enc_response is plain text
representstheerrormessage.

enc_response AESencryptedresponsecontainingformat as
per response_type

refund_status Refundstatusspecifies whethergivenrefund Numeric

request isgoing to succeed or fail. Value “0” denotes refund was
successful
Value “1” denotes refund was
failure.

reason Failure reasonifthere fund request is goingto String

fail for thetransactions. Please refer below table for failure
message.

error_code Error code for Failure reason. String

Please refer below table for failure
message.

Example XML Response

Success Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Refund_Order_Result reason="" refund_status="0" reason=”” error_code=””/>

Failure Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Refund_Order_Result reason="Reference number: Invalid Parameter" refund_status="1" error_code=”51310”/>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Example JSON Response

Success Response:

{
"reason":"",
"error_code":"",
"refund_status":0
}

Failure Response:
{
"reason":"Referencenumber:InvalidParameter",
"error_code":"51310",
"refund_status":1
}

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.
 4. Status

The Status APIcall can be used to ascertainthestatus of a transaction/order. You can usethis call if you havenot
receivedstatus/informationforatransactionrequest.Itcanalsobeusedasanadditional security measure to
reconfirm the parameters posted back.
Request Parameters

Name Description Note

Parameters Datatype (Parameters
max length)
enc_request AES encrypted request data
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. You must send this with each
request.

request_type API requests areaccepted inXML or JSON. Possiblevalueforrequest_type is

(required) Specify the request type. “XML” or “JSON”.

response_type API returns responses in XML or JSON format. Possible value for response_type is
(optional) Ifleftblank,the responsewill be inthe “XML” or “JSON”.
same format as request.

command (required) Command value specifies the API calls.You Value is “orderStatusTracker”.
must send this with each request.

reference_no CCAvenuereferenceno. allocated tothe Numeric(25).

(conditional) transaction.

Reference number is required if you do not

share order_no.

order_no (conditional) This is the merchant reference number for the AlphaNumeric with special
transaction. characters (hyphen and
underscore)(30).
Order number isrequired if youdonot share
reference_no.

Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Order_Status_Query order_no="33231644" reference_no="225013271813"/>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Example JSON Request

{
"reference_no": "225013271813",
"order_no": "33231644"
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly refer to the encryption section.

Response Parameters
Name Description Note
status Thisstateswhetherthecallwassuccessfulor not. Value “0” denotes thatthe API
Ifvalue ofthisparameter is“1”thenyou need call wassuccessful.
not decrypt the enc_response as it will Value“1” denotes APIcallfailure. On
contain plain errormessage. enc_response is plain text
representstheerrormessage.

enc_response AESencryptedresponsecontainingformat as
per response_type

order_amt Amount for the transaction. Decimal(12,2).

order_bill_address Order billing address details for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circular brackets and dot)(315).

order_bill_city Order billing City name for the order. Possible value for city is
Alphanumeric with special
characters (space, comma,
hyphen and dot)(30).

order_bill_country Order billing Country for the Order. Possible value for country is
Alphanumeric with special
characters (space)(30).

order_bill_email EmailAddress ofthe Order for notifications. Possible value for email ID is
 Alphanumeric with special
characters (hyphen, underscore,
dot, @)(70).

order_bill_name Order billing name for the order. Possible value for name is
Alphanumeric with special
characters (space, hyphen,
apostrophe,underscore, dot)(60).

order_bill_state Order billing state for the order. Alphanumeric with special
characters (hyphen, dot and
space)(30).

order_bill_tel Order billing telephone no. for the order. Numeric(10)

order_bill_zip Order billing address’s pincode for the order. Possible value for zip is
Alphanumeric with special
characters (hyphen and space)
(15).

order_capt_amt Captured amount for the transaction. Decimal(12,2).

Capturedamountcanbefullorpartialofthe
transaction amount.

order_curr Possibleorder Currencyinwhichmerchant String Examples:

processed thetransaction. INR – Indian Rupee USD–
United StatesDollar SGD –
Singapore DollarGBP–
PoundSterling
EUR – Euro, official currency of
Eurozone

order_date_time Order Generated Date &Time. DateTime in IST( yyyy-MM-dd

HH:mm:ss.SSS) format.

order_device_type This is the type of device using which the Possiblevaluefordevicetypeis

transaction was processed. IVRS/MOB/PC.

order_discount This is Discount Value for the Order No. Decimal(12,2).

order_fee_flat Flat Fee for the Order No. Decimal(12,2).

order_fee_perc Provides the percentage fee for the same Decimal(12,2).

order No.
order_fee_perc_value This attribute provides the percentage fee Decimal(12,2).
Value for the same order No.

order_fraud_status Specify whether orders are valid or not. String

Possible Values are:
1) Value“High” denotes“High
Risk”
2) Value“Low” denotes“Low
Risk”
3) Value“NR” denotes“NoRisk”
Value “GA” denotes“Go
Ahead”
5)Value“NA”denotes“Not
Applicable”

order_gross_amt Total transaction amount. Decimal(12,2).

order_ip Customer IP Address (i.e. from where IP V-4 Supported.

transaction is being initiated)

order_no Order No. for the transaction. Alphanumeric with special

characters (hyphen and
underscore)(30).

order_notes Order information you wish to provide. Alphanumeric with special

characters (space, comma, dot,
hyphen and underscore)(60).

order_ship_address Shipping Address for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circular brackets and dot)(315)

order_ship_city Shipping city name for the orders. Possible value for city is
Alphanumeric with special
characters (space, comma,
hyphen and dot)(30).

order_ship_country Shipping country name for the orders. Possiblevalueforcountryis

Alphanumeric withspecial
characters (space)(30).

order_ship_email Shipping email ID for the notifications of Possible value for email id is
the transaction. Alphanumeric with special
characters (hyphen, underscore,
dot, @)(70).
order_ship_name Shipping Name ofthe Customer for theorder. Possible value for name is
Alphanumeric with special
characters (space, hyphen,
apostrophe,underscore, dot)(60).

order_ship_state Shipping state for the order. Alphanumeric with special

characters (hyphen, dot and
space)(30).

order_ship_tel Telephone no. for notifications of the Numeric(10).

transaction.

order_ship_zip Order shippingaddress's pincodeforthe Possible value for zip is

order. Alphanumeric with special
characters(hyphen and space)
(15).

order_status Status of the order.Itcan be single ormultiple. String

Possible values are:

Aborted(transactioniscancelled
by the User)
Auto-Cancelled (transaction has not
confirmed within 12 days hence
autocancelledbysystem) Auto-
Reversed (two identical
transactions for same order
number,bothweresuccessfulat
bank'sendbutwegotresponse for
only one of them, then next day
during reconciliation we mark one
of the transaction as auto
reversed )
Awaited (transaction is processed
 frombillingshippingpagebutno
response isreceived)

Cancelled (transaction is
cancelled by merchant )
Chargeback()

Invalid(Transaction sent to
CCAvenue with Invalid
parameters, hence could not be
processed further)
Fraud (we update this during
recon,theamountisdifferentat
bank’sendandatCCAvenuedue to
tampering)

Initiated (transaction just arrived

onbillingshippingpageandnot
processed further)

Refunded (Transaction is refunded.)

Shipped (transaction is confirmed)
Successful
Systemrefund(Refundedby
CCAvenueforvariousfindingsof
reversals by CCAvenue)
Unsuccessful (transaction is not
successful)
Timeout (The CCAvenue payment
page has a Timeout set at 15
minutes per session)
order_status_date_time This is the latestdate and time when order DateTime in IST( yyyy-MM-dd
status ismodified. HH:mm:ss.SSS) format.

order_TDS AmountofTDS(taxdeductedatsource)for Decimal (13,4)

the Transaction.

order_tax Tax Amount for the Transaction. Decimal (13,4)

reference_no CCAvenue reference no. allocated to the Numeric(25).

transaction.

order_bank_ref_no Unique reference number shared by Bank Numeric(25).

after successful transaction.
order_bank_response Descriptionaboutthetransactionsharedby String
the bank after transaction.

order_gtw_id Unique payment option Bank name. Alphabet(6)

order_card_name Specify the card name for the transaction. Possible value for card name is
VISA","MASTERCARD","AMEX","J
CB","DINERS CLUB".

order_option_type Specifythepayment option type for the order. String

Possiblevalue for payment option
type is:
OPTCASHC-Cash card
OPTCRDC -Credit Card
OPTDBCRD-Debit Card
OPTEMI-EMI
OPTIVRS-IVRS
OPTMOBP-MobilePayments
OPTNBK-Net Banking
Merchant_param1 Tempparameters value update by merchant String
at transaction time for further use.

Merchant_param2 Tempparameters value update by merchant String

at transaction time for further use.

Merchant_param3 Tempparameters value update by merchant String

at transaction time for further use.

Merchant_param4 Tempparameters value update by merchant String

at transaction time for further use.

Merchant_param5 Tempparameters value update by merchant String

at transaction time for further use.

page_count Totalpagesavailablebasedonno_of_records Example: no_of_records sent in

in the request. request was 100
total_records Totalno.ofordersmatchingthelookup total_records matching the
criteria. lookup criteria were 1000
page_count will be 10
(total_records / no_of_records)
rounded to the ceiling.

error_desc Reason ifsearch criteria didnotfind the orders String.

for thetransactions. Please refer below table for
failure message.
error_code Error code for Failure reason. String.
Please refer below table for
failure message.

Example XML Response

Success Response:

<?xml version='1.0' encoding='UTF-8'?>

<Order_Status_Result error_code="">
<error_desc></error_desc>
<order_TDS>0.0</order_TDS>
<order_amt>1.0</order_amt>
<order_bank_ref_no>035944</order_bank_ref_no>
<order_bank_response>Transaction Successful</order_bank_response>
<order_bill_address>Room no1101,nearRailwaystation Ambad</order_bill_address>
<order_bill_city>Indore</order_bill_city>
<order_bill_country>India</order_bill_country>
<order_bill_email>[email protected]</order_bill_email>
<order_bill_name>Shashi</order_bill_name>
<order_bill_state>MP</order_bill_state>
<order_bill_tel>9595226054</order_bill_tel>
<order_bill_zip>425001</order_bill_zip>
<order_capt_amt>0.0</order_capt_amt>
<order_card_name>MasterCard</order_card_name>
<order_currncy>INR</order_currncy>
<order_date_time>2015-09-16 15:05:55.573</order_date_time>
<order_delivery_details></order_delivery_details>
<order_device_type>PC</order_device_type>
<order_discount>0.0</order_discount>
<order_fee_flat>0.0</order_fee_flat>
<order_fee_perc>2.3</order_fee_perc>
<order_fee_perc_value>0.02</order_fee_perc_value>
<order_fraud_status>NA</order_fraud_status>
<order_gross_amt>1.0</order_gross_amt>
<order_gtw_id>ICICI</order_gtw_id>
<order_ip>192.168.2.182</order_ip>
<order_no>66068092</order_no>
<order_notes>order will be shipped</order_notes>
<order_option_type>OPTCRDC</order_option_type>
<order_ship_address>Room no1101,nearRailwaystation Ambad</order_ship_address>
<order_ship_city>Indore</order_ship_city>
<order_ship_country>India</order_ship_country>
<order_ship_email></order_ship_email>
 <order_ship_name>Shashi</order_ship_name>
<order_ship_state>MP</order_ship_state>
<order_ship_tel>9595226054</order_ship_tel>
<order_ship_zip>425001</order_ship_zip>
<order_status>Successful</order_status>
<order_status_date_time>2015-09-16 15:06:13.243</order_status_date_time>
<order_tax>0.0028</order_tax>
< Merchant_param1>Mobile No9595226054</ Merchant_param1>
< Merchant_param2>Flight from Dehli</ Merchant_param2>
< Merchant_param3>ToMumbai</ Merchant_param3>
< Merchant_param4>Mobile No9595226054</ Merchant_param4>
< Merchant_param5>Mobile No9595226054</ Merchant_param5>
<reference_no>204000163469</reference_no>
<status>0</status>
</Order_Status_Result>

Failure Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Order_Status_Result error_code=”51313”>
<error_desc>Order List: Invalid Parameter</error_desc>
<status>1</status>
</Order_Status_Result>
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Example JSON Response

Success Response:
{
"reference_no":"204000163469",
"order_no":"66068092",
"order_currncy":"INR",
"order_amt":1.0,
"order_date_time":"2015-09-16 15:05:55.573",
"order_bill_name":"Shashi",
"order_bill_address":"Room no 1101, near Railwaystation Ambad",
"order_bill_zip":"425001",
"order_bill_tel":"9595226054",
"order_bill_email":"[email protected]",
"order_bill_country":"India",
"order_ship_name":"Shashi",
"order_ship_address":"Room no1101, near RailwaystationAmbad",
"order_ship_country":"India",
"order_ship_tel":"9595226054",
"order_bill_city":"Indore",
"order_bill_state":"MP",
"order_ship_city":"Indore",
"order_ship_state":"MP",
"order_ship_zip":"425001",
"order_ship_email":"",
"order_notes":"order will be shipped",
"order_ip":"192.168.2.182",
"order_status":"Successful",
"order_fraud_status":"NA",
"order_status_date_time":"2015-09-1615:06:13.243",
"order_capt_amt":0.0,
"order_card_name":"MasterCard",
"order_delivery_details":"",
"order_fee_perc":2.3,
"order_fee_perc_value":0.02,
"order_fee_flat":0.0,
"order_gross_amt":1.0,
"order_discount":0.0,
"order_tax":0.0028,
"order_bank_ref_no":"035944",
"order_gtw_id":"ICICI",
"order_bank_response":"Transaction Successful",
"order_option_type":"OPTCRDC", "order_TDS":0.0,
"order_device_type":"PC", "
Merchant_param1":"Mobile No9595226054", "
Merchant_param2":"Flight from Dehli", "
Merchant_param3":"ToMumbai", "
Merchant_param4":"Mobile No9595226054", "
Merchant_param5":"Mobile No9595226054",
"error_desc":"",
"status":0,
"error_code":""
}

Failure Response:

{
"error_desc":"Order List: Invalid Parameter",
"error_code":"51313",
"status":1
}
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.
5. Order Lookup

The Lookup APIcall canbe used toextracttransaction details for a certainsetoftransactions. The functionality
works similar to a search feature.
Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. Youmust send thiswitheach
request.

request_type API requests are accepted inXML or JSON. Possible valuefor request_type is
(required) Specify the request type. “XML” or “JSON”.

response_type API returns responses in XML or JSON format. Possiblevalueforresponse_typeis

(optional) Ifleftblank, the response will be “XML” or “JSON”.
inthe same format as request.

Command Command valuespecifies the API calls.You Possible value for this API call is
(required) must send this with each request. “orderLookup”.

reference_no Unique CCAvenue reference number forthe Numeric(25).

(optional) transaction.

from_date Providethe StartDate to find theorderslist. Datemust be inIST(dd-mm-yyyy

(required) )format.

to_date Providetheend date to searchthe orders Date must be in IST(dd-mm-yyyy)

(optional) betweenfromdateand to date.Itshouldbe format.
greater than or equal to from date.

order_currency Currency in whichyou processed the String

(optional) transaction. You cansendthe multiple
currencies format. Example:
INR – Indian Rupee
USD–United StatesDollar
SGD – Singapore Dollar GBP
– PoundSterling
EUR – Euro, official currency
of Eurozone
order_email Email address used to purchase the order. Alphanumeric with special
(optional) characters (hyphen, underscore, dot,
@)(70).
order_fraud_status Specify whether orders are valid or not. String
(optional) Possible Values are:
1) Value“High” denotes “High Risk”
2) Value“Low”denotes“LowRisk”
3) Value “NR” denotes“NoRisk”
4) Value“GA” denotes“GoAhead”
5) Value “NA” denotes“Not
Applicable”
6)
order_min_amount Minimum amount limitforsearch criteriafor Decimal(12,2).
(optional) the transaction.

order_max_amount Maximum amountlimitforsearchcriteriafor Decimal(12,2).

(optional) the transaction.

order_name Customer name for the transaction. Alphanumericwithspecialcharacter

(optional) (space, hyphen, apostrophe,
underscore, dot)(60).

order_no Unique merchant order no for the transaction. AlphaNumeric with special
(optional) characters(hyphen and
underscore)(60).

order_payment_type Payment Mode for the transaction.It canbe String

(optional) single ormultiple.
Below are the Possible Values:
1) CASHC (Cash Card Payment Type)
2) CRDC (Credit CardPayment Type)
3) DBCRD (Debit CardPayment
Type)
4) MOBP(MobilePaymentType)
5) NBK (Net Banking )
order_status Status ofthe order.It can be single or String
(optional) multiple. Possible values are:
Aborted (transaction is cancelled by the
User)
Auto-Cancelled (transaction has not
confirmed within 12 days hence auto
cancelled by system)
Auto-Reversed (two identical
transactions for same order number,
bothweresuccessfulat bank'sendbut
wegotresponsefor
only one of them, then next day
duringreconciliationwemarkone of
the transaction as auto reversed )
Awaited (transaction is processed from
billing shipping page but no response
isreceived)
Cancelled (transaction is cancelled by
merchant )
Chargeback()
Invalid(Transaction sent to
CCAvenue with Invalid parameters,
hence could not be processed
further)
 Fraud (weupdatethis duringrecon,
the amount is different at bank’s
end and at CCAvenue due to
tampering)
Initiated (transaction just arrived on
billing shipping page and not
processed further)
Refunded (Transaction is refunded.)
Shipped (transaction is confirmed)
Successful
System refund (Refunded by
CCAvenue for various find of
reversals by CCAvenue)
Unsuccessful (transaction is not
successful due to )

order_type Type of the order. String

(optional)
Different types of Orders:

1) OT-INV denotes“Invoice”
2) OT-ORD denotes“Orders”
3) OT-ORDSCdenotes“Shopping
Cart Orders”
4) OT-PPAY denotes” Phone Pay”
5) OT-SNIP denotes“SNIPorders”

order_bill_tel Customer mobilenumber for the transaction. Numeric(10).

(optional)
page_number A limited number of records are shared as part of Numeric(4).
(required) theresponse.Thetotalrecords&number of
pages areshared aspartof the response to
enable subsequent calls.

Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Order_Lookup_Query>
<order_no>xxxxxxx</order_no>
<reference_no>xxxxxxxxx</reference_no>
<order_email>[email protected]</order_email>
 <order_bill_tel>xxxxxxxxxxx</order_bill_tel>
<order_country>xxxxx</order_country>
<from_date>xx-xx-xxxx</from_date>
<to_date>xx-xx-xxxx</to_date>
<order_max_amount>xx.xx</order_max_amount>
<order_min_amount>xx.xx</order_min_amount>
<order_status>xxxxxxx</order_status>
<order_fraud_status>xxxx</order_fraud_status>
<order_currency>xxx</order_currency>
<order_type>xx-xxx</order_type>
<order_payment_type>xxxxxx</order_payment_type>
<page_number>1</page_number>
</Order_Lookup_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly referto the encryption section.

Example JSON Request

{
"order_no": "xxx",
"reference_no":"xxxxx",
"order_email": "[email protected]",
"order_bill_tel": "xxxxxxxxx",
"order_country": "xxxxxxx",
"from_date": "xx-xx-xxxx",
"to_date": "xx-xx-xxxx",
"order_max_amount": "xx.xx",
"order_min_amount": "xx.xx",
"order_status": "xxxxx",
"order_fraud_status": "xxxx",
"order_currency": "xxx",
"order_type": "xxxxxx",
"order_payment_type": "xxxxx",
"page_number":1
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly referto the encryption section.
Response Parameters

Name Description Note

status Thisstateswhetherthecallwassuccessfulor not. Value“0”denotes that the API
Ifvalue ofthisparameter is“1”thenyou need call was successful.
notdecrypt the enc_response as it will Value “1” denotes API call
contain plain errormessage. failure.Onenc_responseisplain
text represents the error
message.

enc_response AESencryptedresponsecontainingformat as
per response_type

order_amt Amount for the transaction. Decimal(12,2).

order_bill_address Order billing address details for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circularbracketsanddot)(315)

order_bill_city Order billing City name for the order. Possible value for city is
Alphanumeric with special
characters (space, comma,
hyphen and dot)(30).

order_bill_country Order billing country for the Order. Possiblevalueforcountryis

Alphanumeric withspecial
characters (space)(30).
order_bill_email EmailAddress of the Order fornotifications. Possible value for email id is
Alphanumeric with special
characters (hyphen, underscore,
dot,@)(70).

order_bill_name Order billing name for the order. Possible value for name is
Alphanumeric with special
characters (space, hyphen,
apostrophe, underscore,
dot)(60).

order_bill_state Order billing state for the order. Alphanumeric with special
characters (hyphen, dot and
space)(30).

order_bill_tel Order billing telephone no for the order. Numeric(10)

order_bill_zip Orderbilling address’s pincodefor theorder. Possible value for zip is

AlphaNumeric with special
characters(hyphen and space)
(15).

order_capt_amt Captured amount for the transaction. Decimal(12,2).

Capturedamountcanbefullorpartialofthe
transaction amount.

order_curr Possibleorder Currencyinwhichmerchant String

processed thetransaction. Examples:
INR – Indian Rupee USD–
United StatesDollar SGD –
Singapore DollarGBP–
PoundSterling EUR–
Euro,officialcurrencyof
Eurozone
order_date_time Order Generated Date &Time. DateTime in IST( yyyy-MM-dd
HH:mm:ss.SSS) format.

order_device_type This is the type of device using which the Possiblevalue fordevicetypeis
transaction was processed. IVRS/MOB/PC.

order_discount This is Discount Value for the Order No. Decimal(12,2).

order_fee_flat Flat Fee for the Order No. Decimal(12,2).

order_fee_perc Provides the percentage fee for the same Decimal(12,2).

order No.
order_fee_perc_value This attribute provides the percentage fee Decimal(12,2).
Value for the same order No.

order_fraud_status Specify whether orders are valid or not. String

Possible Values are:
1) Value“High” denotes“High
Risk”
2) Value“Low” denotes“Low
Risk”
3) Value“NR”denotes“No
Risk”
4) Value “GA” denotes “Go
Ahead”
5) Value “NA” denotes“Not
Applicable”

order_gross_amt Total transaction amount. Decimal(12,2).

order_ip Customer IP Address (i.e. from where IP V-4 Supported.

transaction is being initiated)

order_no Order No for the transaction. AlphaNumeric with special

characters(hyphen and
underscore)(30).

order_notes Order information you wish to provide. AlphaNumeric with special

characters(space, comma, dot,
hyphen and underscore)(60).

order_ship_address Shipping Address for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circularbracketsanddot)(315)

order_ship_city Shipping city name for the orders. Possible value for city is
Alphanumeric with special
characters (space, comma,
hyphen and dot)(30).

order_ship_country Shipping country name for the orders. Possible value for country is
Alphanumeric with special
characters (space)(30).
order_ship_email ShippingemailID for the notifications of the Possible value for email id is
transaction. Alphanumeric with special
characters (hyphen, underscore,
dot,@)(70).

order_ship_name Shipping Name ofthe Customer for theorder. Possible value for name is
Alphanumeric with special
characters (space, hyphen,
apostrophe, underscore,
dot)(60).

order_ship_state Shipping state for the order. Alphanumeric with special

characters (hyphen, dot and
space)(30).

order_ship_tel Telephone no for notifications of the Numeric(10).

transaction.

order_ship_zip Order shippingaddress's pincodeforthe Possible value for zip is

order. AlphaNumeric with special
characters(hyphen and space)
(15).
order_status Status of theorder.Itcan be single ormultiple. String
Possible values are:
Aborted (transaction is
cancelled by the User)
Auto-Cancelled (transactionhas not
confirmed within 12 days hence
autocancelledbysystem) Auto-
Reversed (two identical
transactionsfor same order
number, both weresuccessful at
bank's end but we got response
foronly one of them, thennext
day during reconciliation we
markoneofthe transactionas
auto reversed)
Awaited (transaction is
processedfrombillingshipping
page but no response is
received)
Cancelled (transaction is
cancelled by merchant )
Chargeback()
Invalid(Transaction sent to
CCAvenue with Invalid
parameters, hence could not be
processed further)
Fraud (we update this during
recon,theamountisdifferentat
bank’sendandatCCAvenuedue to
tampering)
Initiated (transaction just
arrived onbilling shippingpage
and not processed further )
Refunded (Transaction is
refunded.)
Shipped (transaction is confirmed)
Successful
System refund (Refunded by
CCAvenue for various find of
reversals by CCAvenue)
Unsuccessful (transaction is not
successful due to )

order_status_date_time This is the latest date and time when order DateTime in IST( yyyy-MM-dd
status is modified. HH:mm:ss.SSS) format.
order_TDS AmountofTDS(taxdeductedatsource)for Decimal(13,4).
the Transaction.

order_tax Tax Amount for the Transaction. Decimal (13,4)

reference_no CCAvenue reference no allocated to the Numeric(25).

transaction.

order_bank_ref_no Unique reference number share by Bank after Numeric(25).

successful transaction.

order_bank_response Descriptionaboutthetransactionsharedby String

the bank after transaction.

order_gtw_id Unique payment option Bank name. Alphabet(6)

order_card_name Specify the card name for the transaction. Possiblevalueforcardnameis

VISA","MASTERCARD","AMEX",
"JCB","ECRD","DINERS
CLUB","DSNV","CTBL","CVMS".

order_option_type Specify thepaymentoptiontypefor the order. String

Possiblevalueforpayment
option typeis
OPTCASHC-Cash card
OPTCRDC -Credit Card
OPTDBCRD-Debit Card
OPTEMI-EMI
OPTIVRS-IVRS
OPTMOBP-MobilePayments
OPTNBK-Net Banking

Merchant_param1 Temp parameters value update by merchant String

at transaction time for further use.

Merchant_param2 Temp parameters value update by merchant String

at transaction time for further use.

Merchant_param3 Temp parameters value update by merchant String

at transaction time for further use.
Merchant_param4 Temp parameters value update by merchant String
at transaction time for further use.

Merchant_param5 Temp parameters value update by merchant String

at transaction time for further use.
error_desc Reason ifsearch criteriadid not find the orders String
for thetransactions. Please refer below table for
failure message.

error_code Error code for Failure reason. String

Please refer below table for
failure message.

page_count Totalpagesavailablebasedonno_of_records Example:no_of_recordssentin

in the request request was100
total_records Total no.of orders matching the lookup criteria total_records matching the
lookup criteria were 1000
page_count will be 10
(total_records / no_of_records)
rounded to the ceiling

Example XML Response

Success Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Order_Lookup_Result error_code=””>
<error_desc></error_desc>
<order_Status_List>
<order order_TDS="0.0"
order_amt="1.0"
order_bank_response="Invalid Credentials"
order_bill_address="Room no1101,nearRailwaystationAmbad"
order_bill_city="Indore"
order_bill_country="India"
order_bill_email="[email protected]"
order_bill_name="Shashi" order_bill_state="MP"
order_bill_tel="1234567890"
order_bill_zip="425001"
order_capt_amt="0.0"
order_card_name="MasterCard"
order_currncy="INR" order_date_time="2015-
03-31 11:20:44.47" order_device_type="PC"
order_discount="0.0"
order_fee_flat="0.0"
order_fee_perc="12.0"
order_fee_perc_value="0.12"
order_fraud_status="NA"
order_gross_amt="1.0"
order_gtw_id="SBI"
order_ip="192.168.2.182"
 order_no="45289752"
order_notes="order will be shipped"
order_option_type="OPTCRDC"
order_ship_address="Roomno1101,nearRailwaystationAmbad"
order_ship_city="Indore"
order_ship_country="India"
order_ship_name="Shashi"
order_ship_state="MP"
order_ship_tel="1234567890"
order_ship_zip="425001"
order_status="Unsuccessful"
order_status_date_time="2015-03-31 11:21:09.99"
order_tax="0.0148"
reference_no="204000134595"/>
</order_Status_List>
<page_count>1</page_count>
<total_records>1</total_records>
</Order_Lookup_Result>

Failure Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Order_Lookup_Result error_code=”51313”>
<error_desc>Order List: Invalid Parameter</error_desc>
<page_count>0</page_count>
<total_records>0</total_records>
</Order_Lookup_Result>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Example JSON Response

Success Response:
{

"order_Status_List":[{
"reference_no":204000134595,
"order_no":"45289752",
"order_currncy":"INR",
"order_amt":1.0,
"order_date_time":"2015-03-31 11:20:44.47",
"order_bill_name":"Shashi",
"order_bill_address":"Room no 1101, near Railwaystation Ambad",
"order_bill_zip":"425001",
"order_bill_tel":"1234567890",
"order_bill_email":"[email protected]",
 "order_bill_country":"India",
"order_ship_name":"Shashi",
"order_ship_address":"Room no1101, near RailwaystationAmbad",
"order_ship_country":"India",
"order_ship_tel":"1234567890",
"order_bill_city":"Indore",
"order_bill_state":"MP",
"order_ship_city":"Indore",
"order_ship_state":"MP",
"order_ship_zip":"425001",
"order_notes":"order will be shipped",
"order_ip":"192.168.2.182",
"order_status":"Unsuccessful",
"order_fraud_status":"NA",
"order_status_date_time":"2015-03-31 11:21:09.99",
"order_capt_amt":0.0,
"order_card_name":"MasterCard",
"order_fee_perc_value":0.12, "order_fee_perc":12.0,
"order_fee_flat":0.0,
"order_gross_amt":1.0,
"order_discount":0.0,
"order_tax":0.0148,
"order_TDS":0.0,
"order_gtw_id":"SBI",
"order_bank_response":"Invalid Credentials",
"order_option_type":"OPTCRDC",
"order_device_type":"PC"
Merchant_param1":"Mobile No9595226054", "
Merchant_param2":"Flight from Dehli", "
Merchant_param3":"ToMumbai", "
Merchant_param4":"Mobile No9595226054", "
Merchant_param5":"Mobile No9595226054",
}],
"page_count":1,
"total_records":1,
"error_desc":"",
"error_code":""
}
Failure Response:
{
"page_count":0,
"total_records":0,
"error_desc":"Order List: Invalid Parameter",
"error_code":"51313"
}
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.
 6. Pending Orders
PendingAPI callallows you to find the listofpending orders.Only confirmed orders aresettled into the
merchant’saccount. An orderolderthan12days isautomaticallycanceled. Once an orderhas been auto-
canceled by the system, it cannot be confirmed.
You can optionally confirm only part of an order. Remember, you cando so only once. Remaining funds willbe
refundedtothecreditcardordebitcardornetbankingaccountthatwasoriginallycharged.

Request Parameters
Name Description Note
enc_request AES encrypted request data
(required)
access_code Unique CCAvenue access code which is
(required) generated when merchant registered their IP
address. You must send thiswitheach
request.

request_type API requests are accepted in XML, JSON. Possible valuefor request_type is
(required) Specify the request type. “XML” or “JSON”.

response_type API returns responses in XML or JSON format. Possiblevalueforresponse_typeis is

(optional) Ifleftblank,the responsewill be inthe “XML” or “JSON”.
same format as request.

Command Command value specifies the API calls.You Possible value for this API call is
(required) must send this with each request. “getPendingOrders”.

reference_no Unique CCAvenue reference number for the Numeric(25)

(optional) transaction.

order_no Unique Merchant order number for the AlphaNumeric with special
(optional) pendingorderofthe transaction. characters(hyphen and
underscore)(30).

order_bill_name Name of the customer to find invoicedetails Alphanumericwithspecialcharacter

(optional) after placingorders. (space, hyphen, apostrophe,
underscore, dot)(60).

order_email Emailidofcustomer to sendmailforthe Alphanumeric with special characters

(optional) generate invoice. (hyphen, underscore,
dot, @)(70).

order_bill_tel Mobile number of the customer to send the Numeric(10)

(optional) generate invoice.
order_fraud_status Type of fraud status. String
(optional) Possible Values are:
1) Value“High” denotes“High Risk”
2) Value“Low” denotes“Low Risk”
3) Value “NR” denotes“NoRisk”
4) Value“GA” denotes“GoAhead”
5) Value “NA” denotes “Not
Applicable

order_currency Currency in which you processed the String

(optional) transaction. You cansend themultiple
currencies format. Example:
INR – Indian Rupee USD–
United StatesDollar SGD –
Singapore DollarGBP–
PoundSterling
EUR – Euro, official currencyof
Eurozone

order_type Type of the order. String

(optional)
Different types of Orders:

1) OT-INV denotes“Invoice”
2) OT-ORD denotes“Orders”
3) OT-ORDSCdenotes“Shopping
Cart Orders”
4) OT-PPAY denotes” Phone Pay”
5) OT-SNIP denotes“SNIPorders”

page_number Alimitednumberofrecords are shared as part of Numeric(4)

(required) the response. The total records & number of
pagesaresharedaspartoftheresponseto
enable subsequent calls.
Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Pending_Orders_Query>
<order_no>XXXXXX</order_no>
<reference_no>XXXXXXX</reference_no>
<order_bill_name>XXXXX</order_bill_name>
<order_email>[email protected]</order_email>
<order_bill_tel>XXXXXXX</order_bill_tel>
<order_fraud_status>XX|XXXX|XXX</order_fraud_status>
<order_currency>XXX|XXX|XXX|XXX</order_currency>
<order_type>XX-XXX|XX-XXX</order_type>
<page_number>1</page_number>
</Pending_Orders_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly referto the encryption section.

Example JSON Request

{
"order_no": "XXXXXXX", "reference_no":
"XXXXXXX", "order_bill_name": "XXXXX",
"order_email": "[email protected]",
"order_bill_tel": "XXXXXXXXXXX",
"order_fraud_status": "XX|XXXX|XXX",
"order_currency": "XXX|XXX|XXX|XXX",
"order_type": "XX|XX-XX",
"page_number": "1"
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly referto the encryption section.
Response Parameters

Name Description Note

status Thisstateswhetherthecallwassuccessfulor not. Value“0”denotes that the
Ifvalue ofthisparameter is“1”thenyou need API call wassuccessful.
notdecrypt the enc_response asitwill Value “1” denotes API call
contain plain errormessage. failure.Onenc_responseisplain
text represents the error
message.

enc_response AESencryptedresponsecontainingformat as
per response_type

order_amt Amount for the transaction. Decimal(12,2).

order_bill_address Order billing address details for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circularbracketsanddot)(315
)
order_bill_city Order billing City name for the order. Possible value for city is
Alphanumeric with special
characters (space, comma,
hyphen and dot)(30).

order_bill_country Order billing country for the Order. Possiblevalueforcountryis

Alphanumeric withspecial
characters (space)(30).

order_bill_email EmailAddressoftheOrderfornotifications. Possible value for email id is

Alphanumeric with special
characters (hyphen, underscore,
dot, @)(70).

order_bill_name Order billing name for the order. Possiblevaluefornameis

Alphanumeric with
special characters (space,
hyphen, apostrophe,
underscore,
dot)(60).

order_bill_state Order billing state for the order. Alphanumeric with special
characters (hyphen, dot
and
space)(30).

order_bill_tel Order billing telephone no for the order. Numeric(10)

order_bill_zip Orderbillingaddress’pincodefortheorder. Possible value for zip is
AlphaNumeric with special
characters(hyphen and space)
(15).

order_capt_amt Captured amount for the transaction. Decimal(12,2).

Capturedamountcanbefullorpartialofthe
transaction amount.

order_curr Possibleorder Currencyinwhichmerchant String

processed thetransaction. Examples
:
INR – Indian Rupee USD–
United StatesDollar SGD –
Singapore DollarGBP–
PoundSterling EUR–
Euro,officialcurrencyof
Eurozone

order_date_time Order Generated Date &Time. DateTime in IST( yyyy-MM-dd

HH:mm:ss.SSS) format.

order_device_type This is the type of device using which the Possiblevalue fordevicetypeis
transaction was processed. IVRS/MOB/PC.

days_left Number of days left to pay order amount. Numeric(3)

order_discount This is Discount Value for the Order No. Decimal(12,2).

order_fee_flat Flat Fee for the Order No. Decimal(12,2).

order_fee_perc Provides the percentage fee for the same Decimal(12,2).

order No.

order_fee_perc_value This attribute provides the percentage fee Decimal(12,2).

Value for the same order No.
order_fraud_status Specify whether orders are valid or not. String
Possible Values are:
1) Value“High” denotes
“High Risk”
2) Value“Low” denotes
“Low Risk”
3) Value“NR”denotes
“No Risk”
4) Value “GA” denotes
“Go Ahead”
5) Value “NA” denotes“Not
Applicable”

order_gross_amt Total transaction amount. Decimal(12,2).

order_ip Customer IP Address (i.e. from where IP V-4 Supported.

transaction is being initiated)

order_no Order No for the transaction. AlphaNumeric with

special
characters(hyphen and
underscore)(30).

order_notes Order information you wish to provide. AlphaNumeric with special

characters(space, comma, dot,
hyphen and underscore)(60).

days_left Number of days left to pay order amount. Numeric (4).

order_bank_mid Unique merchant id provided by issuer bank to Numeric(16).

merchant for the transaction.

order_bank_ref_no Unique reference number shared by Bank Numeric(25).

after successful transaction.

order_bank_response Descriptionaboutthetransactionsharedby String

the bank after transaction.

order_gtw_id Unique payment option Bank name. Alphabet(6)

order_card_name Specify the card name for the transaction. Possiblevalueforcardnameis

VISA","MASTERCARD","AMEX",
"JCB","ECRD","DINERS
CLUB","DSNV","CTBL","CVMS".
order_option_type Specify the payment option typefor the order. String
Possiblevaluefor
payment option typeis
OPTCASHC-Cash card
OPTCRDC -Credit Card
OPTDBCRD-Debit Card
OPTEMI-EMI
OPTIVRS-IVRS
OPTMOBP-MobilePayments
OPTNBK-Net Banking

order_card_type Specify the card type used to pay order String

amount. Possible value for card type is
Cash
card
Credit
Card
Debit
Card EMI
IVRS
Mobile Payments
Net Banking

order_risk_mitigation Specify whether the current order on risk String(1)

mitigation or not. Possible value is “Y” or ”N”.

order_tax Tax Amount for the Transaction. Decimal (13,4)

order_tran_status Transaction status for the order coming from String
bank's end. Possible value is
TS-AUTA- Authorization
Awaited
TS-AUTC- Authorization confirm
TS-AUTCR- Authorization
confirmed on reconciliation
TS-AUTD-
Authorization
Declined
TS-AUTDR- Authorization
Declined on reconciliation
TS-AUTFR- Authorization Fraud
TS-AUTFRR-AuthorizationFraud
on reconciliation
TS-AUTFRAM- Amt mismatch
TS-AUTFRCM - Currency
mismatch
TS-AUTFRUT- Authorization
fraud
TS-ABRTBNK- Aborted at bank's
end.

order_type Type of the order. String

Different types of Orders:
1) OT-INVdenotes “Invoice”
2) OT-ORDdenotes“Orders”
3) OT-ORDSCdenotes“Shopping
Cart Orders”
4) OT-PPAY denotes”Phone
Pay”
5) OT-SNIPdenotes“SNIP
orders”

order_ship_address Shipping Address for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circularbracketsanddot)(315
)

order_ship_city Shipping city name for the orders. Possible value for city is
Alphanumeric with special
characters (space, comma,
hyphen and dot)(30).
order_ship_country Shipping country name for the orders. Possible value for country is
Alphanumeric with
special characters
(space)(30).

order_ship_email Shipping email IDfor the notifications of the Possible value for email id is
transaction. Alphanumeric with special
characters (hyphen, underscore,
dot, @)(70).

order_ship_name ShippingName ofthe Customer for the order. Possiblevaluefornameis

Alphanumeric with
special characters (space,
hyphen, apostrophe,
underscore,
dot)(60).

order_ship_state Shipping state for the order. Alphanumeric with special

characters (hyphen, dot
and space)(30).

order_ship_tel Telephone no for notifications of the Numeric(10).

transaction.

order_ship_zip Order shipping address' pin code for the order. Possible value for zip is
AlphaNumeric with special
characters(hyphen and space)
(15).
order_status Status of the order. It canbesingle or String
multiple. Possible values are:
Aborted (transaction is
cancelled by the User)
Auto-Cancelled (transaction has
not confirmed within 12 days
henceautocancelled bysystem)
Auto-Reversed (two identical
transactions for same order
number, both weresuccessful
at bank'sendbutwegot
response foronlyoneofthem,
thennext day during
reconciliation we markoneof
thetransactionas auto
reversed)
Awaited (transaction is
processedfrombilling
shipping page but no
response is received)
Cancelled (transaction is
cancelled by merchant )
Chargeback()
Invalid(Transaction sent to
CCAvenue with Invalid
parameters, hence could not be
processed further)
Fraud (we update this during
recon,theamountisdifferent
at bank’sendandatCCAvenue
due to tampering)
Initiated (transaction just
arrived onbilling shippingpage
and not processed further )
Refunded (Transaction is
refunded.)
Shipped (transaction is
confirmed)

Successful
Systemrefund(Refundedby
CCAvenueforvariousfindingsof
reversals by CCAvenue)
Unsuccessful (transaction is not
successful due to )
order_status_date_time This is the latest date and time when order DateTime in IST( yyyy-MM-dd
status is modified. HH:mm:ss.SSS) format.
order_TDS AmountofTDS(taxdeductedatsource)for Decimal(13,4).
the Transaction.

reference_no Unique CCAvenue reference no allocated to Numeric(25).

the transaction.

error_desc Reason ifsearchcriteriadidnot findthe String

orders forthe transactions. Please refer below table for
failure message.

error_code Error code for Failure reason. String

Please refer below table for
failure message.

page_count Totalpagesavailablebasedonno_of_records Example:no_of_recordssentin

in the request request was100
total_records Total no.of orders matching the lookup criteria total_records matching the
lookup criteria were 1000
page_count will be 10
(total_records / no_of_records)
rounded to the ceiling

Example XML Response

Success Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Pending_Orders_Result error_code=””>
<error_desc></error_desc>
<page_count>1</page_count>
<pending_Orders_List>
<pending_Orders
days_left="3"
order_TDS="0.0"
order_amt="1.0"
order_bank_mid="1234567890" order_bank_ref_no="289049"
order_bank_response="Approved"
order_bill_address="Room no1101,nearRailwaystationAmbad"
order_bill_city="Indore"
order_bill_country="India"
order_bill_email="[email protected]"
order_bill_name="Shashi"
order_bill_state="MP"
order_bill_tel="1234567890"
order_bill_zip="425001"
order_capt_amt="0.0"
 order_card_name="Amex"
order_card_type="Credit Card"
order_curr="INR" order_date_time="2015-
04-13 10:59:05.517"order_discount="0.0"
order_fee_flat="0.0"
order_fee_perc="4.0"
order_fee_perc_value="0.04"
order_fraud_status="NA"
order_gross_amt="1.0"
order_gtw_id="PGT"
order_ip="192.168.2.182"
order_no="66885810"
order_notes="order will beshipped"
order_risk_mitigation="Y"
order_ship_address="room no.701nearbusstand"
order_ship_city="Hyderabad"
order_ship_country="India"
order_ship_name="Chaplin"
order_ship_state="Andhra"
order_ship_tel="1234567890"
order_ship_zip="425001"
order_status="Successful"
order_status_date_time="2015-04-13 10:59:53.217"
order_tax="0.0049"
order_tran_status="TS-AUTC"
order_type="OT-ORD"
reference_no="204000136232"/>
</pending_Orders_List>
<total_records>1</total_records>
</Pending_Orders_Result>

Failure Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Pending_Orders_Result error_code=”51313”>
<error_desc>Order List: Invalid Parameter</error_desc>
<page_count>1</page_count>
<total_records>1</total_records>
</Pending_Orders_Result>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Example JSON Response

Success Response:
{
"pending_Orders":[{
"reference_no":"204000136232",
"order_no":"66885810",
"order_type":"OT-ORD",
"order_curr":"INR",
"order_amt":1.0,
"order_date_time":"2015-04-13 10:59:05.517",
"order_bill_name":"Shashi",
"order_bill_address":"Room no 1101, near Railwaystation Ambad",
"order_bill_zip":"425001",
"order_bill_city":"Indore",
"order_bill_state":"MP",
"order_bill_tel":"12345687890",
"order_bill_email":"[email protected]",
"order_bill_country":"India",
"order_ship_name":"Chaplin",
"order_ship_address":"room no.701nearbusstand",
"order_ship_country":"India",
"order_ship_tel":"1234567890",
"order_ship_city":"Hyderabad",
"order_ship_state":"Andhra",
"order_ship_zip":"425001",
"order_notes":"order will be shipped",
"order_ip":"192.168.2.182",
"order_status":"Successful",
"order_fraud_status":"NA",
"order_status_date_time":"2015-04-13 10:59:53.217",
"order_capt_amt":0.0,
"order_card_type":"Credit Card",
"order_card_name":"Amex",
"order_bank_mid":"xxxxxxxxx",
"order_fee_perc":4.0,
"order_fee_perc_value":0.04,
"order_fee_flat":0.0,
"order_gross_amt":1.0,
"order_discount":0.0,
"order_tax":0.0049,
"order_bank_ref_no":"xxxxxxxx",
"order_gtw_id":"PGT",
"order_bank_response":"Approved",
"order_risk_mitigation":"Y",
"days_left":"3",
"order_tran_status":"TS-AUTC",
"order_TDS":0.0,
 }],
"page_count":1,
"total_records":1,
"error_desc":"",
"error_code":""
}
Failure Response:
{
"page_count":1,
"total_records":1,
"error_desc":"Order List: Invalid Parameter",
"error_code":"51313"
}

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.
7. Delete Customer

The Delete Customer API call is used to delete the customer and all saved payment options for the customer.

Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. Youmust send thiswitheach
request.

request_type API requests are accepted in XML or Possible value for request_type is
(required) JSON. Specify the request type. “XML” or “JSON”.

response_type API returns responses in XML or JSON Possiblevalueforresponse_typeis is

(optional) format. Ifleftblank,the responsewill be in “XML” or “JSON”.
the same format as request.

Command Command valuespecifies the APIcalls.You Possible value for this API call is
(required) must send this with each request. “deleteCustomer”.

customer_id Unique Customer ID provided by merchant to Alphanumeric with special

(required) the customer. characters (hyphen, underscore,
dot,@)(70)

Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Delete_Customer_Query customer_id="123"/>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Example JSON Request

{
"customer_id": "1234"
}
Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.
Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status This states whether the call was successful or not.Value“0”denotes that the APIcall
If value of this parameter is “1” then you needwas successful.
not decrypt the enc_response as it will containValue“1” denotes API call failure.
plain errormessage. On enc_response is plain text
representstheerrormessage.

enc_response AES encrypted response containing format as

per response_type

deletion_status Delete status - specify whether customeris Numeric(1)

goingto be deletedsuccessfully ornot. Possiblevaluesforthisis 0-
Deletion successful.
1 - Could not be deleted.

customer_id Unique Customer ID for the deleted customer. Numeric(25).

error_desc Reason if customeris not going to be deleted String

successfully. Please refer below table for failure
message.

error_code Error code for Failure reason. String

Please refer below table for failure
message.

Example XML Response

Success:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Delete_Customer_Result deletion_status="0" error_code=”” error_desc=””>
<customer_id>1234</customer_id>
</Delete_Customer_Result>
 Failure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Delete_Customer_Result error_desc="Customer id: Invalid parameter"deletion_status="1" error_code=”51325”>

<customer_id>1234</customer_id>
</Delete_Customer_Result>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.
Example JSON Response

Success:
{
"deletion_status":0,
"error_desc":"",
"error_code":"",
"customer_id":"1234"
}

Failure:
{
"error_desc":"Customer id: Invalid parameter",
"deletion_status":1,
"customer_id":"1234",
"error_code":"51325"
}

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.
8. Delete Customer Payment Option

The Delete Customer Payment Option API call is used to delete a particular payment option saved for the customer.

Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. Youmust send thiswitheach
request.

request_type API requests are accepted in XML or Possiblevalueforrequest_typeis

(required) JSON. Specify the request type. “XML” or “JSON”.

response_type API returns responses in XML or JSON format. Possible value for response_type is
(optional) Ifleftblank,the responsewill be inthe “XML” or “JSON”.
same format as request.

Command Command value specifies the API calls. You must Possible value for this APIcall is
(required) send this with each request. “deleteCustomerPaymentOption
”.
customer_id (required) Unique Customer ID for the transaction. Numeric(25).

customer_card_id Unique Customercard ID againstthe payment Numeric (25).

(required) option for the transaction.

Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Delete_Customer_Payment_Query
customer_id="123" customer_card_id="22"/>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Example JSON Request

{
"customer_id": "1234",
"customer_card_id": "14"
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status This states whether the call was successful or not.Value“0”denotes that the API call
If value of this parameter is “1” then you needwas successful.
not decrypt the enc_response as it will containValue“1” denotes API call failure.
plain errormessage. On enc_response is plain text
representingtheerror message.

enc_response AES encrypted response containing format as

per response_type

customer_id Unique Customer ID for the transaction. Numeric(25).

customer_card_id Unique Customercard ID againstthe payment Numeric (25).

option for the transaction.

deletion_status Delete Status value specifies whether Possiblevaluesforthisis 0-

customer payment option is going to delete Deletionsuccessful.
successfully or not. 1 - Could not be deleted.

error_desc Reason if customer payment option is not String

going to delete successfully. Please refer below table for failure
message.

error_code Error code for Failure reason. String

Please refer below table for failure
message.
Example XML Response

Success:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Delete_Customer_Payment_Option_Result
deletion_status="0"
customer_id="24"
customer_card_id="1234" error_code=”” error_desc=””/>

Failure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Delete_Customer_Payment_Option_Result
customer_card_id="22" customer_id="123"
error_desc="CustomerCardId:InvalidParameter"
error_code=”51336”
deletion_status="1"/>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Example JSON Response

Success:
{
"customer_card_id":22,
"deletion_status":0,
"customer_id":123,
"error_desc":"",
"error_code":""
}
Failure:
{
"customer_card_id":22,
"deletion_status":1,
"customer_id":123,
"error_desc":"Customer CardId:InvalidParameter",
"error_code":"51336"
}
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.
9. Add Customer Payment Option

The Add Customer Payment Option API call is used to add another payment option for the customer of the
merchant.

Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)

access_code UniqueCCAvenueaccesscode
(required) which is generated when
merchant registered their IP
address. Youmustsendthiswith
each request.

request_type API requests are accepted in Possiblevalueforrequest_typeis

(required) XML or JSON. Specify the “XML” or “JSON”.
request type.

response_type API returns responses in XML Possible value for response_type is

(optional) or JSON format. If left “XML” or “JSON”.
blank,the responsewill bein the
same format as request.

Command Command value specifies the API Possiblevalueforthis APIcall is

(required) calls. You must send this with “addCustomerPaymentOption”.
each request.

customer_id (required) Unique Customer ID for the Numeric(25).

transaction.

customer_name_on_card Customer name on card. Alphanumeric with special

(optional) characters (space,
underscore)(30).

customer_phone_no Customer mobile number. Numeric(10).

(optional)
customer_email Customer email id. Alphanumeric with special
(optional) characters (hyphen, underscore,
dot,@)(70).

customer_card_issuer_bank Customercardissuerbank Alphanumeric with special

(optional) name. characters (space, underscore
)(70).

customer_card_expiry Customer Card expiry date. Date format in MM/yyyy.

(required)
customer_card_no Customer Card number. Numeric(25)
(required)
customer_card_name Customer Card name. String
VISA MASTERCARD
(required) AMEX
JCB
ECRD
DINERS CLUB
DSNV
CTBL
CVMS
AMEX EZE CLICK
customer_card_type Customer card type to payment String.
(required) option for the transaction. CRDC-creditcard
DBRD-debit card

Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Add_Customer_Payment_Option_Query>
<customer_id>14</customer_id>
<customer_email>[email protected]</customer_email>
<customer_phone_no>8698319931</customer_phone_no>
<customer_name_on_card>subash yadav</customer_name_on_card>
<customer_card_name>mastercard</customer_card_name>
<customer_card_no>421578965236545</customer_card_no>
<customer_card_expiry>11/2015</customer_card_expiry>
<customer_card_issuer_bank>HDFC</customer_card_issuer_bank>
<customer_card_type>CRDC</customer_card_type>
</Add_Customer_Payment_Option_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.
Example JSON Request

{
"customer_id":14, "customer_email":"[email protected]",
"customer_phone_no":8698319931,
"customer_name_on_card":"subash yadav",
"customer_card_no":421578965236545,
"customer_card_name":"mastercard",

"customer_card_expiry":"11/2015",
"customer_card_issuer_bank":"Kotak mahindra",
"customer_card_type":"CRDC"
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status This states whether the call was successful or not. Value “0” denotes thatthe APIcall
If value of this parameter is “1” then you need was successful.
not decrypt the enc_response as it will contain Value“1” denotes APIcallfailure. On
plain errormessage. enc_response is plain text
representingtheerrormessage.

enc_response AES encrypted response containing format as

per response_type

customer_id Unique Customer ID for the transaction. Numeric(25).

customer_card_id Unique Customercard ID againstthe payment Numeric (25).

option for the transaction.

Status Delete Status value specifies whether Possible values for this is
customer payment option is going to be 0 - Deletionsuccessful.
deleted successfully or not. 1 - Could not be deleted.
customer_card_no_last Last four digitofcardno for thetransaction. Numeric(4)
4digits
Will contain values only for Credit
Card and Debit card.

customer_pay_opt_type Customer payment option for given details. String

OPTCRD-credit card
OPTDBCRD-debit card

customer_card_expry Customer card expiry date. Date format in MM/yyyy.

customer_card_issuer_b Customer Card issuer bank. Alphanumericwithspecialcharacters

ank (space, underscore )(70).

customer_card_name Customer Card name. String

VISA MASTERCARD
AMEX
JCB
ECRD
DINERS CLUB
DSNV
CTBL
CVMS
AMEX EZE CLICK

error_desc Reason if customer payment option is not String.

goingto be deleted successfully. Please refer below table for failure
message.

error_code Error code for Failure reason. String.

Please refer below table for failure
message.

Example XML Response

Success:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Add_Customer_Payment_Option_Result>
<customer_card_expiry>11/2015</customer_card_expiry>
<customer_card_id>240</customer_card_id>
 <customer_card_issuer_bank>HDFC</customer_card_issuer_bank>
<customer_card_name>Visa</customer_card_name>
<customer_card_no_last4digits>2346</customer_card_no_last4digits>
<customer_id>14</customer_id>
<customer_pay_opt_type>OPTCRDC</customer_pay_opt_type>
<error_code></error_code>
<error_desc></error_desc>
<status>0</status>
</Add_Customer_Payment_Option_Result>

Failure:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Add_Customer_Payment_Option_Result>
<customer_card_expiry>11/2015</customer_card_expiry>
<customer_card_id></customer_card_id>
<customer_card_issuer_bank>HDFC</customer_card_issuer_bank>

<customer_card_name>Visa</customer_card_name>
<customer_card_no_last4digits>2346</customer_card_no_last4digits>
<customer_id>14</customer_id>
<customer_pay_opt_type></customer_pay_opt_type>
<error_code>51336</error_code>
<error_desc>Customer Card Id: Invalid Parameter</error_desc>
<status>1</status>
</Add_Customer_Payment_Option_Result>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

Example JSON Response

Success:
{
"customer_id":"14",
"customer_card_id":"36",
"customer_card_no_last4digits":"6545",
"customer_card_expiry":"11/2015",
"customer_pay_opt_type":"OPTCRDC",
"customer_name_on_card":"subash yadav",
"customer_card_name":"Visa",
"customer_card_issuer_bank":"HDFC",
"error_desc":"",
"error_code":"","status":0
}
 Failure:
{
"customer_id":"14",
"customer_card_id":"",
"customer_card_no_last4digits":"2346",
"customer_card_expiry":"11/2015",
"customer_pay_opt_type":"",
"customer_name_on_card":"subash yadav",
"customer_card_name":"Visa",
"customer_card_issuer_bank":"HDFC",
"error_desc":"Customer CardId:InvalidParameter",
"error_code":"51337",
"status":1
}

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

10. Get Customer Payment Options

The Customer payment option APIcall is usedtolist paymentoptionsaved for acustomer. Payments options are
saved for acustomer invault for easy and convenientpayment.

Request Parameters
Name Description Note
enc_request AES encrypted request data.
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. Youmustsendthiswitheachrequest.
 request_type API requests are accepted in XML or JSON Possible value for request_type is
(required) . Please specify the request type. “XML” or “JSON”.

response_type APIreturnsresponsesin XML or JSON Possiblevalueforresponse_typeisis

(optional) format.Ifleftblank,the response willbe inthe “XML” or “JSON”.
same format as request.

Command Command value specifies the APIcalls.You Possible value for this API call is
(required) must send this with each request. “getCustomerPaymentOptions”

customer_id Unique Customer ID for the transaction. Numeric(25).

(required)

Example XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Customer_Payment_Options
customer_id="123"/>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Example JSON Request

{
"customer_id": "1234"
}
Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.
Response Parameters

Name Description Note

status This states whether the call was Value “0” denotes thatthe APIcall
successful or not. If value of this was successful.
parameteris“1”thenyouneednot Value “1” denotes API call failure. On
decrypttheenc_responseasitwill enc_response is plain text represents
containplainerrormessage. the errormessage.

enc_response AES encrypted response containing

format as per response_type.

customer_id Unique Customer ID for the transaction. Numeric(25).

customer_card_no Last four digitofcardnofor the Numeric(4)

transaction.
Will contain values only for Credit
Card and Debit Card.

customer_payopt_type Number of Paymentoptionsassign String.

against to thiscustomer id.
Values :
OPTNBK-net banking
OPTCRD-credit card
OPTDBCRD-debit card
OPTMOBP-mobile payment
OPTIVRS- IVRS
OPTWLT- Wallet
OPTCASHC-Cash Card
OPTEMI- EMI

customer_card_name Customer card name for the Alphanumericwithspecialcharacters

transaction. (space, hyphen,apostrophe,
underscore, dot)(60).

customer_email Customeremailid forthe transaction. Alphanumericwithspecialcharacters

(hyphen, underscore, dot,@)(70).

customer_card_label Customer card label name for the Alphanumericwithspecialcharacters

transaction. (space, hyphen, apostrophe, underscore,
dot)(60).

customer_card_id Unique Customer Card IDis the Numeric(25).

identifierforthe payment options
against the Customer ID.

customer_phone_number Unique Customer phone number for the Numeric(10).

transaction.
customer_card_expiry Customer card expiry month and year. Numeric with special characters.

customer_card_issuing_bank Customer card issuing bank name. String.

error_desc ReasonifAPIcalldoesnotfindthe String.

recordbasedongivensearchcriteria. Please refer below table for failure
message.

error_code Error code for Failure reason. String.

Please refer below table for failure
message.

Example XML Response

Success:

<?xml version="1.0"

encoding="UTF-8"

standalone="yes"?>

<Customer_Payment_Option_Result customer_id=”1234” error_desc=”” error_code=””>

<pay_Opt_List>
<customer>
<customer_card_id>26</customer_card_id>
<customer_card_no>4567</customer_card_id>
<customer_card_name>Development Credit
Bank</customer_card_name>
<customer_card_type>NBK</customer_card_type>
<customer_email>[email protected]</customer_email>
<customer_payopt_type>OPTNBK</customer_payment_type>
<customer_card_label>xxxxxxx</customer_card_label>
<customer_card_expiry>10/2020</customer_card_expiry>
<customer_card_issuing_bank>xxxxxxx</customer_card_issuing_bank>
</customer>
<customer>
<customer_card_id>27</customer_card_id>
<customer_card_no>1234</customer_card_no>
<customer_card_name>Development Credit Bank</customer_card_name>
<customer_card_type>NBK</customer_card_type>
<customer_email>[email protected]</customer_email>
<customer_payopt_type>OPTNBK</customer_payopt_type>
<customer_card_label>xxxxxxx</customer_card_label>
<customer_card_expiry>10/2020</customer_card_expiry>
<customer_card_issuing_bank>xxxxxxx</customer_card_issuing_bank>
 </customer>
</pay_Opt_List>
</Customer_Payment_Option_Result>

Failure:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Customer_Payment_Option_Result
error_desc="Customer id: Invalid Parameter" customer_id=”1234” error_code=”51327”/> Note:
You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

Example JSON Response

Success:
{
"pay_Opt_List":[{
"customer_card_name":"Development Credit Bank",
"customer_card_type":"NBK", "customer_card_id":26,
"customer_email":"[email protected]",
"customer_payopt_type":"OPTNBK"
"customer_card_label":"xxxxx"
"customer_card_no":"1234"
"customer_card_expiry":"10/2020"
"customer_card_issuing_bank":"xxxxxxxx"
},
{
"customer_card_name":"MasterCard",
"customer_card_type":"CRDC",
"customer_card_id":27,
"customer_email":"[email protected]",
"customer_payopt_type":"OPTCRDC",
"customer_card_label":"xxxxx"
"customer_card_no":"4567"
"customer_card_expiry":"10/2020"
"customer_card_issuing_bank":"xxxxxxxx"
}],
“customer_id”:”1234”,
"error_desc":"",
"error_code":""
}
Failure:

{
"error_desc":"Customer id: Invalid Parameter",
"error_code":"51327",
“customer_id”:”1234”
}

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.
 11. Generate Invoice

The Invoice APIcall is usedtogenerate aninvoiceforacustomer. Valuescan be passed as forgenerating invoice

using the flexibility of Invoice settings.

Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)

access_code Uniqueaccesscodewhichis generated

(required) whenmerchantregistered theirIP
address.Youmustsendthis
with each request.

request_type APIrequestsareacceptedinXML or Possiblevalueforrequest_typeis

(required) JSON. Specify the requesttype. “XML” or “JSON”.

response_type API returns responses in XML or JSON Possible value for response_type is
(optional) format. If left blank, the “XML” or “JSON”.
responsewillbeinthesameformat
as request.

command Command value specifies the API calls. Possible value for this API call is
(required) Youmustsendthiswitheachrequest. “generateInvoice”.

customer_name (required) Name of the customer receiving the Alphanumeric with special characters
Invoice. (space, hyphen,
apostrophe, underscore, dot)(60).

customer_email_id Email ID on which the Invoice will be Alphanumeric with special

(required) sent characters (hyphen, underscore, dot,
@)(70).

customer_email_subject Subject of the email containing the Alphanumeric with special

(required) Invoice characters (hyphens, dot, space
and underscores)(100).

valid_for DurationforwhichtheInvoiceisvalid Numeric(4).

(required)
valid_type The unit of duration represented by Possible values for valid type is
(required) valid_for minutes/hours/days
Currency Currency for which theInvoiceistobe String
(required) generated
Example:
INR – Indian Rupee
USD – UnitedStatesDollar
SGD – Singapore Dollar
GBP– PoundSterling
EUR – Euro, official currency of
Eurozone

merchant_reference_no Merchant identifier for the Invoice Alphanumeric with special

(optional) characters (hyphen and
underscore)(25).

merchant_reference_no1 Merchant identifier for the Invoice Alphanumeric with special

(optional) characters(hyphenandunderscore
and hash)(100).
merchant_reference_no2 Merchant identifier for the Invoice Alphanumeric with special
(Optional) (Will not be visible in invoice just for characters(hyphenandunderscore
reference) and hash)(100).

merchant_reference_no3 Merchant identifier for the Invoice Alphanumeric with special

(Optional) (Will not be visible in invoice just for characters(hyphenandunderscore
reference) and hash)(100).

merchant_reference_no4 Merchant identifier for the Invoice Alphanumeric with special

(Optional) (Will not be visible in invoice just for characters(hyphenandunderscore
reference) and hash)(100).

sub_acc_id Unique Sub Account ID. String

(optional)
Amount Invoice Amount Decimal(12,2).
(required
terms_and_conditions Terms and conditions to be presentin AlphaNumeric with special
(optional) the Invoice characters(hyphen, dot, circular
brackets and ampersand)(500)

customer_mobile_no Mobile number of the customer Numeric(10).

(required) receiving the Invoice

due_date Invoice Due date Numeric(3)

(required)
late_payment_fees Feesto be chargedincase of late Decimal(12,2).
(conditional) payment.

Late_payment_feesisrequiredif
merchant provide
late_payment_fees_type.

late_payment_fees_type Unit representation of Possiblevalueforlatepayment

(conditional) late_payment_fees. fees type is Perc/Flat.

Late_payment_fees typeisrequiredif
merchantprovidelate_payment_fees.

discount_if_paid_within_due_date Number of days prior to due date Numeric(3)

(conditional) when an additional discount is eligible. Ex: due_date is 15th Jan 2014
discount_if_paid_within_due_date is
Discount_if_paid_within_due_date is 4
required if merchant provide discount i.e. Discount is applicable up to
value or discount type. 11th Jan 2014.

discount_value (conditional) Discountto be applied if the above Decimal(12,2).

condition istrue.

Discount valueis requiredif merchant

provide discounttype.
discount_type Unitrepresentation of discount_value. Possiblevalueforlatepayment
(conditional) fees type is Perc/Flat.
Discount type is required if merchant
provide discountvalue.
item_List Items associated with the Invoice. Itemtypearray.RefertoItem_list
(conditional) ProvideatleastoneItemifmerchant section for structure.
does not provide any task.
 task_List Tasks associated with the Invoice Task typearray. Refer to Task_list
(conditional) Provide atleast one Taskifmerchant section for structure.
does notprovide any Item.

Item_List:

Name Description Note

name Item Name Alphanumericwithspecialcharacters
(space, underscore, hyphen)(30).

description Item description Alphanumericwithspecialcharacters

(hyphen, dot, circular brackets, space,
comma,underscore,hash(#)
and symbol &)(60)

unit_cost Cost per Item Decimal (12,2) .

quantity Quantity of item Numeric(3).

tax_List Tax associated with the Item Tax type array. Refer to Tax_list
section for structure.

Task_List:

Name Description Note

name Task Name Alphanumericwithspecialcharacters
(space, underscore and hyphen)(30).

notes Notes for the task Alphanumericwithspecialcharacters

(hyphen, dot, circular brackets, space,
comma,underscore, hash(#)
and symbol &)(60)

rate Rate per hour Decimal (12,2) .

hours Number of hours to be charged Numeric(3).

tax_List Tax associated with the task. Tax type array. Refer to Tax_list
section for structure.
Tax_List:

Name Description Note

name Tax list name Alphanumeric with special characters
(space, underscore and
hyphen)(30).

amount Amount of tax applicable Decimal (13,4).

Note: Generate invoice without advance setting

XML Request:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Generate_Invoice_Query>
<customer_name>abc</customer_name>
<customer_email_id>[email protected]</customer_email_id>
<customer_email_subject>Test</customer_email_subject>
<customer_mobile_no>1234567898</customer_mobile_no>
<currency>INR</currency>
<valid_for>2</valid_for>
<valid_type>days</valid_type>
<item_List>
<item>
<name>ITEM</name>
<description>FIRST</description>
<unit_cost>1.00</unit_cost>
<quantity>3</quantity>
<tax_List>
<tax name="Pint Tax" amount="2.5"/>
<tax name="Rent Tax" amount="8.0"/>
</tax_List>
</item>
</item_List>
<task_List>
<task>
<name>TASK</name>
<notes>NEW</notes>
<rate>1.00</rate>
<hours>2</hours>
<tax_List>
<tax name="Pint Tax" amount="2.5"/>
<tax name="Rent Tax" amount="8.0"/>
</tax_List>
</task>
</task_List>
<merchant_reference_no>123456987</merchant_reference_no>
<merchant_reference_no1>123456987</merchant_reference_no1>
<merchant_reference_no2>123456987</merchant_reference_no2>
<merchant_reference_no3>123456987</merchant_reference_no3>
<merchant_reference_no4>123456987</merchant_reference_no4>
<sub_acc_id>sub1</sub_acc_id>
 <terms_and_conditions>terms and condition</terms_and_conditions>
<sms_content>Pls payyour LegalEntity_Namebill# Invoice_ID for Invoice_Amountonlineat
Pay_Link.</sms_content>
</Generate_Invoice_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Json request:

{
"customer_name": "abc",
"customer_email_id": "[email protected]",
"customer_email_subject": "Test",
"customer_mobile_no": "9874561236",
"currency": "INR",
"valid_for": "2",
"valid_type": "days",
"item_List": [{
"name": "ITEM",
"description": "FIRST",
"quantity": "3",
"unit_cost": "1.00",
"tax_List": [
{"name": "Edu Tax","amount": "5.0"},
{"name": "Pint Tax","amount": "2.5"}
]
}],
"task_List": [{
"name": "TASK",
"notes": "NEW",
"hours": "2",
"rate": "1.00",
"tax_List":[
{"name": "STG Tax","amount": "7.0"},
{"name": "Rent Tax","amount": "8.0"}
]
}],
"merchant_reference_no": "123456987",
"merchant_reference_no1":123456987,
"merchant_reference_no2":123456987,
"merchant_reference_no3": "123456987",
"merchant_reference_no4": "123456987",
"sub_acc_id":"sub1",
"terms_and_conditions": "terms and condition",
"sms_content":"Pls payyourLegalEntity_Namebill#Invoice_IDfor Invoice_Currency
Invoice_Amount online at Pay_Link."
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.
Note: Generate Invoice with advance setting

XML Request:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Generate_Invoice_Query>
<customer_name>abc</customer_name>
<customer_email_id>[email protected]</customer_email_id>
<customer_email_subject>Test</customer_email_subject>
<customer_mobile_no>1234567898</customer_mobile_no>
<currency>INR</currency>
<valid_for>2</valid_for>
<valid_type>days</valid_type>
<item_List>
<item>
<name>ITEM</name>
<description>FIRST</description>
<unit_cost>1.00</unit_cost>
<quantity>3</quantity>
<tax_List>
<tax name="Pint Tax" amount="2.5"/>
<tax name="Rent Tax" amount="8.0"/>
</tax_List>
</item>
</item_List>
<task_List>
<task>
<name>TASK</name>
<notes>NEW</notes>
<rate>1.00</rate>
<hours>2</hours>
<tax_List>
<tax name="Pint Tax" amount="2.5"/>
<tax name="Rent Tax" amount="8.0"/>
</tax_List>
</task>
</task_List>
 <merchant_reference_no>123456987</merchant_reference_no>
<merchant_reference_no1>1234f56987</merchant_reference_no1>
<merchant_reference_no2>12345s6987</merchant_reference_no2>
<sub_acc_id>sub1</sub_acc_id>
<terms_and_conditions>terms and condition</terms_and_conditions>
<due_date>1</due_date>
<late_payment_fees>2.5</late_payment_fees>
<late_payment_fees_type>Perc</late_payment_fees_type>
<discount_if_paid_within_due_date>4</discount_if_paid_within_due_date>
<discount_value>1.50</discount_value>
<discount_type>Perc</discount_type>
<sms_content>Pls pay your LegalEntity_Name bill # Invoice_ID for Invoice_Currency Invoice_Amount online
at Pay_Link.</sms_content>
</Generate_Invoice_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

XML Response:

1. Success

<?xml version='1.0' encoding='UTF-8'?>

<Generate_Invoice_Result error_code=""
error_desc=""invoice_status="0">
<invoice_id>5122841</invoice_id>
<qr_code>
iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAYAAACPgGwlAAAB7klEQVR42u3cUYrDMAwFQN 0t0
TFLrET4qtedCfQkPqMThS4qyPjMsyBNAFukAX6AJdoAt0gS7QBbpAF-
gCXaALdIEu0KELdIEu0AW6QJfp6Gut7Z8nx 221_Ov_J_QYcOHfpB6F3HeTLgTyZM5fhAhw4d-
kvQu9bf9PVA4n9Bhw4d-nD0X44PHTp06NCvRP_vtQF06NChQ2_vyFUOrI4cdOjQoZfdT-
 _63v106NChD0TvmlSJTt0V4wUdOnTodSjp—
m7OntKNujQoUPfMshdXbj0hovO6wTo0KFDb5oMiY0JiU5a5TlDhw4d-
qEduV03QbrKzF0TDDp06NCHlGy7BrmyTNORgw4d-
kD09H6xxG93TdpOaOjQoUNvKn92lW9d62xiKzR06NChH1qyVb6iM3HM9GYK6NChQ9eR2wLX9bbq6
0s26NChT3sw8m0dv8QLjsZ25KBDh_5xw6V8g0BlCTb2aVjo0KFPQ08fp_Il_-
kSFTp06NAPRe9aW7s6e68pcaFDhw79PPR0idR1ztChQ4c-
EP3Jup8oFSuf2oUOHTr0izty6S3MifUdOnTo0C9D73rKNN2F23U9AB06dOgHocu7Ah26QBfoAl2gC3SBL
tAFukAX6AJdoAt0gS7QBTp0gS7QBbpAF-jy5vwB_TaQ25UAXPwAAAAASUVORK5CYII
</qr_code>
<tiny_url>http://payit.cc/I5122841</tiny_url>
</Generate_Invoice_Result>

2. Failure

<?xml version='1.0' encoding='UTF-8'?>

<Generate_Invoice_Result error_code="51072"
error_desc="Merchantreferencenumber:InvalidParameter"
invoice_status="1">
<invoice_id></invoice_id>
<qr_code></qr_code>
<tiny_url></tiny_url>
</Generate_Invoice_Result>

Json Response: 1.Success

"error_desc":"",

"invoice_id":"5122799",

"tiny_url":"http://payit.cc/I5122799",

"qr_code":"iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAYAAACPgGwlAAAB-
klEQVR42u3dUY7CMAwFwNz_0rsnQFo2frWTzpP4Q6V0IiV2U1g_8roslwC6QBfoAl2gC3SBLtAFukAX6AJdoAt0
gS7QBTp0gS7QBbpAF-jydvS1Vvlr57M-vf8vx-z6XtChQ4c-HL3rODsDYGfAPHl9oEOHDn0Ienr- rVoPTPhe0KFDh_5C9G-
Pv1N2QYcOHTr0Uehd5wMdOnToOnIlx0ncyNCRgw4dOvR_d8nSpVPXGsD9dOjQoV- M_mSevFFy7DWCDh069OycXrUe-
Paz0qDTBwx06NChP1iy7cAlOl1V5zxxnQAdOnToTWVU17aonXk5cc7QoUOHflBHLrF9KHFh04Ohau0BHTp06A
PREyXPtO5f1ZoHOnTo0A_qyFXNlV0POyTWIdChQ4d-",

"invoice_status":0,
"error_code":"",
"merchant_reference_no":"123456987"

}
2.Failure

{
"error_desc":"Emailid:Invalid Parameter",
"invoice_id":"",
"tiny_url":"",
"qr_code":"",
"invoice_status":1,
"error_code":"51012",
"merchant_reference_no":""
}
12. Generate Recurring Invoice
Recurring invoice call is used to generate recurring invoice for a customer of a merchant.

Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)

access_code This Is the accesscode for your application.

(required) You must send this with each request.

request_type API requests are accepted inXML or JSON Possible value for request_type is
(required) . Specify the request type. “XML” or “JSON”.

response_type APIreturnsresponseinXML or JSON Possiblevalueforresponse_typeis is

(optional) format. Ifleftblank,the responsewill bein “XML” or “JSON”.
the same format as request.

Command Command valuespecifies the API calls.You Possible value for this API call is
(required) must send this with each request. “generateRecurringInvoice”

customer_name (required) NameofthecustomerreceivingtheInvoice Alphanumericwithspecialcharacter

(space, hyphen, apostrophe,
underscore, dot)(60).

customer_email_id Email ID on which the Invoice will be sent Alphanumeric with special characters
(required) (hyphen, underscore,
dot,@)(70).

customer_email_subject Subject of the email containing the Invoice Alphanumeric with special
(required) characters(hyphens,dot,spaceand
underscores)(100).

valid_for Duration for which the Invoice is valid Numeric(4).

(required)
valid_type Theunitofdurationrepresentedbyvalid_for Possible values for valid type is
(required) minutes/hours/days/month/year
Currency Currency forwhich the Invoice is to be String
(required) generated
Example:
INR – Indian Rupee USD–
United StatesDollar SGD –
Singapore DollarGBP–
PoundSterling
EUR – Euro, official currency of
Eurozone

merchant_reference_no Merchant identifier for the Invoice Alphanumeric with special

(optional) characters(hyphen and
underscore)(25).

Amount Invoice Amount Decimal(12,2).

(required
terms_and_conditions Terms andconditions to be present inthe AlphaNumeric with special
(optional) Invoice characters(hyphen, dot, circular
brackets and ampersand)(500)

customer_mobile_no Mobilenumberofthecustomerreceivingthe Numeric(10).

(required) Invoice

due_date Invoice Due date Numeric(3)

(required)

late_payment_fees Feestobe chargedincaseoflatepayment. Decimal(12,2).

(conditional)
Late_payment_fees is requiredifmerchant
providelate_payment_fees_type.

late_payment_fees_typ e Unit representation of late_payment_fees. Possiblevalueforlatepaymentfees

(conditional) type is Perc/Flat.
Late_payment_fees type is required if
merchant provide late_payment_fees.

discount_if_paid_within Number ofdays prior toduedatewhenan Numeric(3)

_due_date additional discount is eligible. Ex: due_date is 15th Jan 2014
(conditional) discount_if_paid_within_due_date is
Discount_if_paid_within_due_date is required if 4
merchant provide discount value or discount i.e.Discountisapplicableupto 11th
type. Jan 2014.
discount_value Discount to be appliedifthe abovecondition Decimal(12,2).
(conditional) is true.

Discount value is required if merchant provide

discount type.

discount_type Unit representation of discount_value. Possiblevalueforlatepaymentfees

(conditional) type is Perc/Flat.
Discount type is required if merchant provide
discount value.

Occurences Number of occurrences for Invoice Numeric(3).

(conditional)
Occurrences is requiredifmerchantprovide
Frequency.

Frequency Frequency for generating the occurrences Possible values for frequency are
(conditional) Daily/Monthly/Quarterly/ Yearly.
Frequency is required if merchant provide
Start_date.

start_date Start date specifies 1st occurrence. Date format in

(conditional) dd-mm-yyyy.
Start_date is required if merchant provide
Occurrences.

item_List Items associated with the Invoice. Itemtype array. RefertoItem_list

(conditional) section for structure.
Provide at leastone Item ifmerchant does not
provide any Task.

task_List Tasks associated with the Invoice Task type array.Refer toTask_list
(conditional) section for structure.
Provide at least one Taskif merchant does not
provide any Item.

Note: Recurring Invoice without advance setting

XML Request:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Generate_Invoice_Query>
<customer_name>xxxxx</customer_name>
<customer_email_id>[email protected]</customer_email_id>
<customer_email_subject>Test</customer_email_subject>
<customer_mobile_no>9874561236</customer_mobile_no>
<currency>INR</currency>
<valid_for>2</valid_for>
<valid_type>days</valid_type>
<start_date>15-08-2014</start_date>
<frequency>Monthly</frequency>
<occurences>5</occurences>
<item_List>
<item>
<name>ITEM</name>
<description>FIRST</description>
<unit_cost>1.00</unit_cost>
<quantity>3</quantity>
<tax_List>
<tax name="Pint Tax" amount="2.5"/>
<tax name="Rent Tax" amount="8.0" />
</tax_List>
</item>
</item_List> <name>TASK</name>
<task_List> <notes>NEW</notes>
<task> <rate>1.00</rate>
<hours>2</hours>
<tax_List>
<tax name="Pint Tax" amount="2.5"/>
<tax name="Rent Tax" amount="8.0" />
</task> </tax_List>
 </task_List>
<merchant_reference_no>123456987</merchant_reference_no>
<terms_and_conditions>terms and condition</terms_and_conditions>
<sms_content>Pls pay your LegalEntity_Name bill # Invoice_ID for Invoice_Currency Invoice_Amount
online at Pay_Link.</sms_content>
</Generate_Invoice_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Json request:

{
"customer_name": "xxxxxx", "customer_email_id":
"[email protected]", "customer_email_subject":
"Test", "customer_mobile_no": "9874561236",
"currency": "INR",
"valid_for": "2",
"valid_type": "days",
"start_date": "15-08-2014",
"frequency": "Monthly",
"occurences": "5",
"item_List": [{
"name": "ITEM",
"description": "FIRST",
"quantity": "3",
"unit_cost": "1.00",
"tax_List": [
{"name": "Edu Tax","amount":"5.0"},
{"name": "Pint Tax","amount": "2.5"}
]
}],
"task_List": [{
"name": "TASK",
"notes": "NEW",
"hours": "2",
"rate": "1.00",
"tax_List":[
{"name":"STGTax","amount":"7.0"},
{"name": "Rent Tax","amount": "8.0"}
]
}],
 "merchant_reference_no": "123456987",
"terms_and_conditions": "terms and condition",
"sms_content":"PlspayyourLegalEntity_Namebill#Invoice_IDforInvoice_Currency
Invoice_Amount online atPay_Link."
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Note: Recurring invoice with advance setting

XML Request:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Generate_Invoice_Query>
<customer_name>abc</customer_name>
<customer_email_id>[email protected]</customer_email_id>
<customer_email_subject>Test</customer_email_subject>
<customer_mobile_no>1234567890</customer_mobile_no>
<currency>INR</currency>
<valid_for>2</valid_for>
<valid_type>days</valid_type>
<start_date>15-08-2014</start_date>
<frequency>Monthly</frequency>
<occurences>5</occurences>
<item_List>
<item>
<name>ITEM</name>
<description>FIRST</description>

<unit_cost>1.00</unit_cost>
<quantity>3</quantity>
<tax_List>
<tax name="Pint Tax" amount="2.5"/>
<tax name="Rent Tax" amount="8.0" />
</tax_List>
</item>
</item_List>
<task_List>
<task>
<name>TASK</name>
<notes>NEW</notes>
<rate>1.00</rate>
<hours>2</hours>
<tax_List>
<tax name="Pint Tax" amount="2.5"/>
<tax name="Rent Tax" amount="8.0" />
</tax_List>
</task>
</task_List>
 <merchant_reference_no>123456987</merchant_reference_no>
<terms_and_conditions>terms and condition</terms_and_conditions>
<due_date>1</due_date>
<late_payment_fees>2.5</late_payment_fees>
<late_payment_fees_type>Perc</late_payment_fees_type>
<discount_if_paid_within_due_date>4</discount_if_paid_within_due_date>
<discount_value>1.50</discount_value>
<discount_type>Perc</discount_type>
<sms_content>Pls pay your LegalEntity_Name bill # Invoice_ID for Invoice_Currency Invoice_Amount
online at Pay_Link.</sms_content>
</Generate_Invoice_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

JSON Request:
{
"customer_name": "abc", "customer_email_id": "[email protected]", "customer_email_subject": "Test",
"customer_mobile_no": "9874561236", "currency": "INR",
"valid_for": "2",
"valid_type": "days",
"start_date": "15-08-2014",
"frequency": "Monthly",
"occurences": "5",
"item_List": [{
"name": "ITEM",
"description": "FIRST",
"quantity": "3",
"unit_cost": "1.00",
"tax_List": [
{"name": "Edu Tax","amount":"5.0"},
{"name": "Pint Tax","amount": "2.5"}
]
}],
"task_List": [{
"name": "TASK",
"notes": "NEW",
"hours": "2",
"rate": "1.00",
"tax_List":[
{"name":"STGTax","amount":"7.0"},
{"name": "Rent Tax","amount": "8.0"}
],
}],
"merchant_reference_no": "123456987",
"terms_and_conditions": "terms and condition",
"due_date": "1",
"late_payment_fees": "2.5",
"late_payment_fees_type": "Perc",
"discount_if_paid_within_due_date": "4",
"discount_value": "1.50",
 "discount_type": "Perc",
"sms_content":"Pls payyourLegalEntity_Namebill#Invoice_IDfor Invoice_Currency
Invoice_Amount online at Pay_Link."
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before
sending it to CCAvenue. Kindly refer to the encryption section.

13. Generate Quick Invoice

This Quick invoice API call is used to generate a quick invoice for a customer.
This is a flavour of regular invoice but with limited options hence an easy implementation.

Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)

access_code This is the access code for your

(required) application. Youmustsendthiswith
each request.

request_type API requests are accepted in XML or Value is “XML” or “JSON”.

(required) JSON. Specify the request
type.
response_type API returns XML or JSON Value is “XML” or “JSON”
(optional) responses. If left blank, the response
will be in the same format as
request.

command (required) This is the command to access the API“generateQuickInvoice” for generate
Calls. You must send this with eachQuick invoice.
request.

customer_name (required) Name ofthe customer receivingthe Alphanumericwithspecialcharacters

Invoice (space, hyphen,apostrophe,
underscore, dot)(60).

customer_email_id EmailID onwhichtheInvoicewillbe Alphanumericwithspecialcharacters

(required) sent (hyphen, underscore, dot, @)(70).

customer_email_subject Subject of the email containingthe Alphanumericwithspecialcharacters

(required Invoice (hyphens, dot, space and
underscores)(100).

valid_for Duration for which the Invoice is Numeric(4)

(required) Valid

valid_type The unit of duration represented by Possible values for valid type is
(required) valid_for minutes/hours/days/month/year

Currency Currency for which the Invoice is to be String

(required) generated
Example:
INR – Indian Rupee
USD – UnitedStatesDollar
SGD – Singapore Dollar
GBP– PoundSterling
EUR – Euro, official currency of
Eurozone

amount(required) Invoice Amount for the generate Decimal(12,2)

invoice.

invoice_description Invoice Description to be sent in String (500)

Email

merchant_reference_no Merchant identifier for the Invoice Alphanumeric with special

(Optional) characters(hyphen and
underscore)(50).

merchant_reference_no1 Merchant identifier for the Invoice Alphanumeric with special

(Optional) characters(hyphen and underscore and
hash)(100).
merchant_reference_no2 Merchant identifier for the Invoice Alphanumeric with special
(Optional) (Will not be visible in invoice just for characters(hyphen and underscore
reference) and hash)(100).

merchant_reference_no3 Merchant identifier for the Invoice Alphanumeric with special

(Optional) (Will not be visible in invoice just for characters(hyphen and underscore
reference) and hash)(100).

merchant_reference_no4 Merchant identifier for the Invoice Alphanumeric with special

(Optional) (Will not be visible in invoice just for characters(hyphen and underscore
reference) and hash)(100).

terms_and_conditions Termsandconditions to be present in AlphaNumeric with special

(optional) the Invoice characters(hyphen, dot, circular
brackets and ampersand)(500)

sms_content Sms content to be sent if delivery Alphanumericwithspecialcharacters

(optional) type is SMS or BOTH (space, hyphen, uhash, ampersand, dot,
round brackets)(60).

sub_acc_id Unique Sub Account ID. String

(optional)
customer_mobile_no Mobile number of the customer Numeric(10)
(required) receiving the Invoice.
bill_delivery_type Invoice delivery mechanism. Possiblevalueforbilldeliverytypeis
(required) EMAIL/SMS/BOTH.

Files Attachments to be sent with the File type array describedin below
(optional) quick invoice. Applicable only ifbill table.
delivery type is EMAIL/BOTH.

Files:-

Name Description Note

Name Attachmentfile name whichispassingat String

(required) generate invoicetime. File extension must be (.jpg
.jpeg .doc .pdf .docx .png
)format

Content Attachment file content must be in byte array String(Attachment file size up to
(required) format decoded with decodeBase64 MOB)
algorithm.
 XML Request:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Generate_Invoice_Query>
<customer_name>abc</customer_name>
<bill_delivery_type>BOTH</bill_delivery_type>
<customer_mobile_no>7894561230</customer_mobile_no>
<customer_email_id>[email protected]
</customer_email_id>
<customer_email_subject>Test</customer_email_subject>
<invoice_description>Test</invoice_description>
<currency>INR</currency>
<valid_for>2</valid_for>
<valid_type>days</valid_type>
<amount>1.0</amount>
<merchant_reference_no>123456987</merchant_reference_no>
<merchant_reference_no1>123456987</merchant_reference_no1>
<merchant_reference_no2>123456987</merchant_reference_no2>
<merchant_reference_no3>123456987</merchant_reference_no3>
<merchant_reference_no4>123456987</merchant_reference_no4>
<sub_acc_id></sub_acc_id>
<terms_and_conditions>terms and condition</terms_and_conditions>
<sms_content>Pls pay your LegalEntity_Name bill # Invoice_ID for
Invoice_Currency Invoice_Amountonline at
Pay_Link.</sms_content>
<files>

</files>
<name>Test.doc</name>
<content>77u/SGVsbG8gaW5kaWEK</content>
</Generate_Invoice_Query>

Json Request:
{
"customer_name": "Akshay",
"bill_delivery_type": "both",
"customer_mobile_no":1234567890,
"customer_email_id": "[email protected]",
"customer_email_subject": "Test",
"invoice_description": "Test",
"currency": "INR",
"valid_for": 2,
"valid_type": "days",
"amount": 10.0,
"merchant_reference_no":123456987,
"merchant_reference_no1":123456987,
 "merchant_reference_no2":123456987,
"merchant_reference_no3":123456987,
"merchant_reference_no4":123456987,
"sub_acc_id":"",
"terms_and_conditions": "terms and condition",
"sms_content":"Pls call 022-2121212121topayyour LegalEntity_Namebill# Invoice_ID for
Invoice_CurrencyInvoice_AmountorpayonlineatPay_Link.",
"files": [{
"name": "Test.doc",
"content": "77u/SGVsbG8gaW5kaWEK"
}]
}

XML Response:

1. Success

<?xml version='1.0' encoding='UTF-8'?>

<Generate_Invoice_Result error_code=""
error_desc=""invoice_status="0">
<invoice_id>5122841</invoice_id>
<qr_code>
iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAYAAACPgGwlAAAB7klEQVR42u3cUYrDMAwFQN 0t0
TFLrET4qtedCfQkPqMThS4qyPjMsyBNAFukAX6AJdoAt0gS7QBbpAF-
gCXaALdIEu0KELdIEu0AW6QJfp6Gut7Z8nx 221_Ov_J_QYcOHfpB6F3HeTLgTyZM5fhAhw4d-
kvQu9bf9PVA4n9Bhw4d-nD0X44PHTp06NCvRP_vtQF06NChQ2_vyFUOrI4cdOjQoZfdT-
_63v106NChD0TvmlSJTt0V4wUdOnTodSjp—
m7OntKNujQoUPfMshdXbj0hovO6wTo0KFDb5oMiY0JiU5a5TlDhw4d-
qEduV03QbrKzF0TDDp06NCHlGy7BrmyTNORgw4d-
kD09H6xxG93TdpOaOjQoUNvKn92lW9d62xiKzR06NChH1qyVb6iM3HM9GYK6NChQ9eR2wLX9bbq6
0s26NChT3sw8m0dv8QLjsZ25KBDh_5xw6V8g0BlCTb2aVjo0KFPQ08fp_Il_-
kSFTp06NAPRe9aW7s6e68pcaFDhw79PPR0idR1ztChQ4c-
EP3Jup8oFSuf2oUOHTr0izty6S3MifUdOnTo0C9D73rKNN2F23U9AB06dOgHocu7Ah26QBfoAl2gC3SBL
tAFukAX6AJdoAt0gS7QBTp0gS7QBbpAF-jy5vwB_TaQ25UAXPwAAAAASUVORK5CYII
</qr_code>
<tiny_url>http://payit.cc/I5122841</tiny_url>
</Generate_Invoice_Result>

2. Failure

<?xml version='1.0' encoding='UTF-8'?>

<Generate_Invoice_Result error_code="51072"
error_desc="Merchantreferencenumber:InvalidParameter"
invoice_status="1">
<invoice_id></invoice_id>
<qr_code></qr_code>
<tiny_url></tiny_url>
</Generate_Invoice_Result>

Json Response: 1.Success

"error_desc":"",

"invoice_id":"5122799",

"tiny_url":"http://payit.cc/I5122799",

"qr_code":"iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAYAAACPgGwlAAAB-
klEQVR42u3dUY7CMAwFwNz_0rsnQFo2frWTzpP4Q6V0IiV2U1g_8roslwC6QBfoAl2gC3SBLtAFukAX6AJdoAt0
gS7QBTp0gS7QBbpAF-jydvS1Vvlr57M-vf8vx-z6XtChQ4c-HL3rODsDYGfAPHl9oEOHDn0Ienr- rVoPTPhe0KFDh_5C9G-
Pv1N2QYcOHTr0Uehd5wMdOnToOnIlx0ncyNCRgw4dOvR_d8nSpVPXGsD9dOjQoV- M_mSevFFy7DWCDh069OycXrUe-
Paz0qDTBwx06NChP1iy7cAlOl1V5zxxnQAdOnToTWVU17aonXk5cc7QoUOHflBHLrF9KHFh04Ohau0BHTp06A
PREyXPtO5f1ZoHOnTo0A_qyFXNlV0POyTWIdChQ4d-",

"invoice_status":0,
"error_code":"",
"merchant_reference_no":"123456987"

2.Failure

{
"error_desc":"Emailid:Invalid Parameter",
"invoice_id":"",
"tiny_url":"",
"qr_code":"",
"invoice_status":1,
"error_code":"51012",
 "merchant_reference_no":""
}

14. Get ItemList

Item list API call allows you to find all task and item list which is configured for the merchant.

Request Parameters
ForInvoiceItems,endrequestdataisnotrequired.Merchanthastosendthecommand,Accesscode,
request_type and response_type parameters only.

Name Description value

enc_request AES encrypted request data
(required)
access_code Unique CCAvenue access code which is
(required) generated when merchant registered their IP
address. Youmustsendthiswitheachrequest.

request_type API requests are accepted in XML or JSON. Possiblevalueforrequest_typeis

(required) Specify the request type. “XML” or “JSON”.

response_type API returns XML, JSON or String responses. If left Possiblevalueforresponse_typeis

(optional) blank,the responsewill be inthesame “XML” or “JSON”.
format as request.

Command Command value specifies the API calls.You Possible value for this API call is
(required) must send this with each request. “getInvoiceItems”.
Request example: access_code=xxxxxxxxxxxxx&command=getInvoiceItems&request_type=xml&response_type=xml

Response Parameters

Name Description Note

status This stateswhetherthe callwassuccessfulor Value“0”denotes that theAPI
not. If value of this parameter is “1” then you callwas not successful.
need not decrypt the enc_response as it will Value “1” denotes API call
contain plain errormessage. failure. On enc_response is
plaintextrepresenting the error
message.

enc_response AES encrypted response containing format as

per response_type

error_desc ThisAttributecontainsthedescriptionofthe Please refer below table for

failurerequest processing.When status is1 the failure message.
thenthis attributewillgeneratethereasonfor
failure.
error_code Error code for Failure reason. String
Please refer below table for
failure message.

item_List List ofall item/taskwhichisconfigured for Item List type array. Refer to
the merchant Item_Listsectionforstructure

Item List:

Name Description Note

description Descriptive informationaboutthe Item/task. Alphanumeric with special
characters(hyphen, dot, circular
brackets, space, comma ,
underscore,hash(#)andsymbol
&)(60).

name Unique name of the Item/task for the Alphanumeric with special
generateinvoicewhichisassignedagainstthe characters (space, hyphen,
merchant id. apostrophe, underscore, dot)(60).

type Specify the item type provided. Possible values for item type are
ITEM/TASK.

104
Example XML Response

Success:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Invoice_Item_Result status="0" error_code=”” error_desc=””>
<item_List>
<item name="First Task" type="TASK" description="sgsdfgsfgsdfg" />
<item name="test" type="TASK" description="test" />
<item name="test" type="ITEM" description="test" />
<item name="TestITEM" type="ITEM" description="TEST"/>
</item_List>
</Invoice_Item_Result>

Failure:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Invoice_Item_Result status="1" error_desc=”Enc_request: Norecordfoundforgivencriteria.” error_code=”51419”/>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

Example JSON Response

Success:
{
"item_List":[
{"name":"HP","description":"QC","type":"ITEM"},
{"name":"asdasd","description":"asdasd","type":"TASK"},
{"name":"STG","description":"test","type":"ITEM"},
{"name":"ITEM","description":"FIRST","type":"ITEM"},
{"name":"TASK","description":"NEW","type":"TASK"},
{"name":"TASK2","description":"NEW","type":"TASK"}
],
"status":0,
“error_desc”:””,
“error_code”:””
}

Failure:
{
"status":1,
“error_desc”:”Enc_request: No record found for given criteria.”,
“error_code”:”51419”
}
105
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

15. Invoice Lookup

Invoice lookup API call is used to find the list of all invoices.

Request Parameters

Name Description value

enc_request AES encrypted request data
(required)

access_code Unique CCAvenue access code which is

(required) generatedwhenmerchants registeredtheir IP
address. Youmustsendthiswitheachrequest.

request_type API requests are accepted in XML or JSON. Possiblevalueforrequest_typeis

(required) Specify the request type. “XML” or “JSON”.

response_type API returns response in XML or JSON format.If Possiblevalueforresponse_typeis

(optional) leftblank,the responsewill be inthesame “XML” or “JSON”.
format as request.

Command Command valuespecifies theAPI calls.You Possible value for this API call is
(required) must send this with each request. “invoiceList”.

106
from_date Mandatory along with to_date if no other Datemustbedd-mm-yyyyformat.
(conditional) criteria mentioned

to_date Mandatory along with from_date if no other Datemustbedd-mm-yyyyformat.

(conditional) criteria mentioned

max_amount Max amount of the invoice to be searched Decimal(12,2)

(optional)
min_amount Min amount of the invoice to be searched Decimal(12,2)
(optional)
created_by Uniqueidentificationofthe merchantfor the String(Unique id of Merchant)
(optional) generate invoice.

mobile_no Customer mobile number for the generate Numbers(10)

(optional) invoice.

email_id Customer email id for the generate invoice. Alphanumeric with special characters
(optional) (hyphen, underscore,
dot, @)(70).

invoice_no Reference number generated from the Numeric(25)

merchant end.

reference_no Unique CCAvenue reference number for the Numeric(25)

(optional) transaction.

invoice_id Unique CCAvenue bill id for the generate Numeric value(25)

(optional) invoice.

invoice_type Provide only possible value of the invoice type. Thepossiblevalues for invoice type
(optional) is quick/invoice/recurring

page_no The default value of page no is 1. Number(1)

(required)

Request:

XML Format:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Invoice_List_Query>
<from_date>10-09-2014</from_date>
<to_date>11-09-2014</to_date>
<max_amt>12.00</max_amt>
<min_amt>1.00</min_amt>
<created_by>xxx</created_by>
<invoice_email>[email protected]</invoice_email>
107
 <invoice_mobile_no>1234567890</invoice_mobile_no>
<reference_no>1234</reference_no>
<reference_no>1234</reference_no>
<invoice_id>321</invoice_id>
<invoice_no>345678</invoice_no>
<invoice_type>TASK/ITEM</invoice_type>
<invoice_type_name>Task</invoice_type_name>
<page_count>1</page_count>
</Invoice_List_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

JSON Format:

{
"from_date":"10-10-2014",
"to_date":"11-10-2014",
"max_amt":"10.00",
"min_amt":"1.00",
"created_by":"xxx",
"invoice_email":"[email protected]",
"invoice_mobile_no":"1234569871",
"reference_no":"123654",
"invoice_id":"123",
"invoice_no":"147852",
"invoice_type":"item/task",
"invoice_type_name":"task",
"page_count":"1"
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before
sending it to CCAvenue. Kindly refer to the encryption section.

108
Response Parameters

Name Description Note

status Thisstateswhetherthecallwassuccessfulor not. Value“0”denotes that the API
Ifvalue ofthisparameter is“1”thenyou need call was successful.
notdecrypt the enc_response as itwill Value “1” denotes API call
contain plain errormessage. failure. On enc_response is
plaintextrepresenting the error
message.

enc_response AESencryptedresponsecontainingformat as
per response_type

Invoice_ID Unique CCAvenue bill id for the generate Numeric(25).

invoice.

Invoice_ref_no Merchant identifier for the Invoice Alphanumeric with special

characters(hyphen and
underscore)(25).

Invoice_created_by Unique merchant ID for the generate invoice. String(70).

order_no Order No for the transaction. AlphaNumeric with special

characters(hyphen and
underscore)(30).

order_amt Amount for the transaction. Decimal(12,2).

order_bill_address Order billing address details for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circularbracketsanddot)(315)

order_bill_city Order billing City name for the order. Possible value for city is
Alphanumeric with special
characters (space, comma,
hyphen and dot)(30).

order_bill_country Order billing country for the Order. Possible value for country is
Alphanumeric with special
characters (space)(30).

order_bill_email EmailAddressoftheOrderfor notifications. Possible value for email id is

Alphanumeric with special
characters (hyphen, underscore,
dot,@)(70).
order_bill_name Order billing name for the order. Possible value for name is
Alphanumeric with special
characters (space, hyphen,
apostrophe, underscore,
dot)(60).

order_bill_state Order billing state for the order. Alphanumeric with special
characters (hyphen, dot and
space)(30).

order_bill_tel Order billing telephone no for the order. Numeric(10)

order_bill_zip Orderbillingaddress’pincodeforthe order. Possible value for zip is

AlphaNumeric with special
characters(hyphen and space)
(15).

order_capt_amt Captured amount for the transaction. Decimal (12,2)

Capturedamountcanbefullorpartialofthe
transaction amount.

order_curr Possibleorder Currencyinwhichmerchant String Examples:

processed thetransaction. INR – Indian Rupee USD–
United StatesDollar SGD –
Singapore DollarGBP–
PoundSterling EUR–
Euro,officialcurrencyof
Eurozone

order_date_time Order Generated Date &Time. DateTime in IST( yyyy-MM-dd

HH:mm:ss.SSS) format.

order_device_type This is the type of device using which the Possiblevaluefor devicetypeis
transaction was processed. IVRS/MOB/PC.

order_discount This is Discount Value for the Order No. Decimal(12,2).

order_fee_flat Flat Fee for the Order No. Decimal(12,2).

order_fee_perc Provides the percentage fee for the same Decimal(12,2).

order No.

order_fee_perc_value This attribute provides the percentage fee Decimal(12,2).

Value for the same order No.
order_fraud_status Specify whether orders are valid or not. String
Possible Values are:
1) Value“High” denotes“High
Risk”
2) Value“Low” denotes“Low
Risk”
3) Value“NR”denotes“No
Risk”
4) Value “GA” denotes “Go
Ahead”
5) Value “NA” denotes“Not
Applicable”

order_gross_amt Total transaction amount. Decimal(12,2).

order_ip Customer IP Address (i.e. from where IP V-4 Supported.

transaction is being initiated)

order_no Order No for the transaction. AlphaNumeric with special

characters(hyphen and
underscore)(30).

order_notes Order information you wish to provide. AlphaNumeric with special

characters(space, comma, dot,
hyphen and underscore)(60).

order_ship_address Shipping Address for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circularbracketsanddot)(315)

order_ship_city Shipping city name for the orders. Possible value for city is
Alphanumeric with special
characters (space, comma,
hyphen and dot)(30).

order_ship_country Shipping country name for the orders. Possible value for country is
Alphanumeric with special
characters (space)(30).

order_ship_email ShippingemailIDfor the notifications ofthe Possible value for email id is

transaction. Alphanumeric with special
characters (hyphen, underscore,
dot, @)(70).
order_ship_name ShippingName of the Customer for the order. Possible value for name is
Alphanumeric with special
characters (space, hyphen,
apostrophe, underscore,
dot)(60).

order_ship_state Shipping state for the order. Alphanumeric with special

characters (hyphen, dot and
space)(30).

order_ship_tel Telephone no for notifications of the Numeric(10).

transaction.

order_ship_zip Order shipping address' pin code for the order. Possible value for zip is
AlphaNumeric with special
characters(hyphen and space)
(15).
order_status Status ofthe order. Itcan besingle ormultiple. String
Possible values are:
Aborted (transaction is
cancelled by the User)
Auto-Cancelled (transactionhas
not confirmed within 12 days
hence auto cancelled by
system)
Auto-Reversed (two identical
transactions for same order
number, both were successful at
bank's end but we got
responseforonly oneofthem,
then next day during
reconciliation we mark one of
thetransaction as autoreversed
)
Awaited (transaction is
processedfrombillingshipping
page but no response is
received)
Cancelled (transaction is
cancelled by merchant )
Chargeback()
Invalid(Transaction sent to
CCAvenue with Invalid
parameters, hence could not be
processed further)
Fraud(weupdatethisduring
recon,theamountisdifferent at
bank’sendandatCCAvenue due
totampering)
Initiated (transaction just
arrived onbilling shippingpage
and not processed further )
Refunded (Transaction is
refunded.)
Shipped (transaction is confirmed)
Successful
System refund (Refunded by
CCAvenue for various find of
reversals by CCAvenue)
Unsuccessful (transaction is not
successful)
order_status_date_time This is the latest date and time when order DateTime in IST( yyyy-MM-dd
status is modified. HH:mm:ss.SSS) format.

order_TDS AmountofTDS(taxdeductedatsource)for Decimal(13,4).

the Transaction.

reference_no Unique CCAvenue reference no for the Numeric(25).

transaction.

error_desc ThisAttributecontainsthedescriptionofthe Please refer below table for

failure requestprocessing.When status is1 the failure message.
then this attributewill generate thereasonfor
failure.
error_code Error code for Failure reason. String
Please refer below table for
failure message.

page_count Totalpagesavailablebasedonno_of_records Numeric(25).

in the request
total_records Total no.of orders matching the lookup
criteria.

Example XML Response

Success:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Invoice_List_Result error_desc="" error_code=”” error_desc=””>
<invoice_List>
<invoice
invoice_Created_By="API"
invoice_Id="xxxxxxxxx"
invoice_ref_no="xxxxxxxx"
order_Amt="xx.xx"
order_Bank_Mid="xxxxxxxx"
order_Bank_Ref_No="xxxxxxxx"
order_Bank_Response="xxxx xxxxx"
order_Bill_Address="xxxxx"
order_Bill_City="xxxxxx"
order_Bill_Country="xxxxxx"
order_Bill_Email="[email protected]"
order_Bill_Name="xxxxxx"
order_Bill_State="xxxxxx"
order_Bill_Tel="xxxxxxxxxx"
order_Bill_Zip="xxxxxx"
 order_Capt_Amt="xx.xx"
order_Card_Name="xyz"
order_Card_Type="abcd"
order_Currency="xxx"
order_Date_time="xxxx-xx-xx xx:xx:xx"
order_Discount="x.x"
order_Fee_Flat="x.x"
order_Fee_Perc="xx.xx"
order_Fraud_Status="xxx"
order_Gross_Amt="x.xx"
order_Gtw_Id="xxxxx"
order_Ip="xxx.xxx.xxx.xxx"
order_No="x"
order_Ship_Address="xxxxxx xxxx"
order_Ship_City="xxxxxxx"
order_Ship_Country="xxxxxx"
order_Ship_Name="xxxxx xxxx"
order_Ship_State="xxx"
order_Ship_Tel="xxxxxxxxxx"
order_Ship_Zip="xxxxxx"
order_Status="xxxxxxxx"
order_Status_Date_time="xxxx-xx-xx xx:xx:xx"
order_Tax="xx.xxxx"
order_Type="xx-xxx"/>
</invoice_List>
<page_count>1</page_count>
<total_records>1</total_records>
</Invoice_List_Result>

Failure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Invoice_List_Result error_desc="Order List: Invalid Parameter" error_code=”51308”/>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.
Example JSON Response Success:
{
"invoice_List":[{
"invoice_Id":5094273,
"invoice_ref_no":"123456987","
invoice_Created_By":"API",
"order_Currency":"INR",
"order_Amt":0.0,
"order_Gross_Amt":0.0,
"order_Discount":0.0,
 "order_Capt_Amt":0.0,
"order_Fee_Perc":0.0,
"order_Fee_Perc_Value":0.0,
"order_Fee_Flat":0.0,
"order_Tax":0.0
}],
"page_count":1,
"total_records":1,
"error_desc":"",
"error_code":""
}

Failure:
{
"error_desc":"Order List: Invalid Parameter",
"error_code":"51308",
"page_count":0,
"total_records":0
}
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

16. UpdateInvoice ReferenceNumber

Update Invoicereference Number API call is usedto update Invoice reference number ifthesame was not
provided at the time of invoice generation.

Request Parameters:

Name Description value

enc_request AES encrypted request data
(required)
access_code Unique CCAvenue access code which is
(required) generated when merchant registered their IP
address. Youmustsendthiswitheachrequest.

request_type API requests are accepted in XML or Possiblevalueforrequest_typeis

(required) JSON. Specify the request type. “XML” or “JSON”.

response_type API returns response in XML or JSON Possiblevalueforresponse_typeis is

(optional) format.Ifleftblank,the responsewill be inthe “XML” or “JSON”.
same format as request.

Command Command valuespecifies the API calls.You Possible value for this API call is
(required) must send this with each request. “updateBillMerchantReferenceNo”

bill_id Unique CCAvenue Bill id(invoice id) for the Numeric value(25)
(required) generated invoice.

merchant_ref_no Unique reference no shared by merchant to Alphanumeric with special

(required) updateagainst CCAvenuebillid(invoiceid). characters(hyphen and
underscore)(25).

Request format:

XML Format:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Update_Bill_Merchant_Reference_No_Query>
<bill_id>1234566</bill_id>
<mer_reference_no>12354</mer_reference_no>
</Update_Bill_Merchant_Reference_No_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.
JSON Format:

{
"bill_id":"123456",
"mer_reference_no":"123654"
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status Thisstateswhetherthecallwassuccessfulor not. Value“0”denotes that the API call
Ifvalue ofthisparameter is“1”thenyou need was successful.
notdecrypt theenc_response as itwill Value“1” denotes API call failure.
contain plain errormessage. On enc_response is plain text
representingtheerror message.

enc_response AESencryptedresponsecontainingformat as
per response_type

error_desc Failurere as on ifupdate merchant reference Please refer belowtablefor the

numberis notgoingto beupdatedsuccessfully for failure message.
the generatedinvoice.

error_code Error code for Failure reason. String

Please refer below tablefor failure
message.

update_status Merchant update status specifies the status of Numeric(1)

update merchantreferencenumber.
“0” means update merchant
reference number was successful. “1”
means merchant reference
number was not successfully
updated.
Response Format:

XML Format:

Success:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Update_Merch_Ref_No_Result update_status=”0” error_code=”” error_desc=””/>

Failure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Update_Merch_Ref_No_Result update_status=”1” error_desc=”Bill Merchant Reference No: Invalid Parameter”
error_code=”51320”/>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

JSON Format:

Success:
{
"update_status":0,
"error_desc":, "error_code":

Failure:

{ "error_desc":"bill_id: Invalid Parameter",

"update_status":1, "error_code":"51319"

}
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

17. Update MerchantParams

Update Merchantparams API is usedto addsome extraparameteragainst Reference noifthesame could not be
done at the time of the transaction.

Request Parameters:

Name Description value

enc_request AES encrypted request data
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. Youmust send thiswitheach
request.

request_type AP Irequests are accepted inXML or JSON. Possiblevalueforrequest_typeis

(required) Specify the request type. “XML” or “JSON”.

response_type API returns XML or JSON responses. If left Possiblevalueforresponse_typeis

(optional) blank,the responsewill be inthesame “XML” or “JSON”.
format as request.

command Command value specifies the API Calls. You Possible value for this API call is
(required) must send this with each request. “updateMerchantParams”

reference_no Unique CCAvenuereferencenumber for the Numeric(25)

(required) transaction.
param_value Merchantcan update oneparamvalue against Alphanumeric with special
(required) uniquereference no after placing order. characters(comma, hyphen,
backslash and dot)(100)

param_value1 Merchantcan update oneparamvalue against Alphanumeric with special

(optional) uniquereference no after placing order. characters(comma, hyphen,
backslash and dot)(100)

param_value2 Merchantcan update oneparamvalue against Alphanumeric with special

(optional) uniquereference no after placing order. characters(comma, hyphen, backslash
and dot)(100)

param_value3 Merchantcan updateoneparam value against Alphanumeric with special

(optional) uniquereference no after placing order. characters(comma, hyphen,
backslash and dot)(100).

param_value4 Merchantcan update oneparamvalue against Alphanumeric with special

(optional) uniquereference no after placing order. characters(comma, hyphen, backslash
and dot)(100)

Request format:

XML Format:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Update_Merchant_Params_Query>

<reference_no>203000093626</reference_no>
<param_value>10</param_value>
<param_value1>11</param_value1>
<param_value2>22</param_value2>
<param_value3>33</param_value3>
<param_value4>44</param_value4>
</Update_Merchant_Params_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

JSON Format:

{
"reference_no":"123654",
"param_value":"10",
 "param_value1":"11",
"param_value2":"22",
"param_value3":"33",
"param_value4":"44"
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status Thisstateswhetherthecallwassuccessfulor not. Value“0”denotes that the API call
Ifvalue ofthisparameter is“1”thenyou need was successful.
not decrypt the enc_response as itwill Value“1” denotes API call failure.
contain plain errormessage. On enc_response is plain text
representingthe error message.

enc_response AESencryptedresponsecontainingformat as
per response_type

error_desc Failure reasonif APIcalldoes not update/add Please refer below table for failure
param value. message.

error_code Error code for Failure reason. String

Please refer below table for failure
message.

update_status Update status contains merchant parameter if “0” means update merchant
add/update was successful or not. parameter value was successful. “1”
means update merchant param
value was not successful.
Response Format:

XML Format:

Success:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Update_Merchant_Param_Result update_status="0" error_code=”” error_desc=””/>

Failure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Update_Merchant_Param_Result error_desc="Reference number: Invalid Parameter" update_status="1"
error_code=”51322”/>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

JSON Format:

Success:
{
“update_status”:0,
"error_desc":"",
"error_code":""
}

Failure:

{
"error_desc":"Referencenumber:Invalid Parameter",
"error_code":"51322",
} "update_status":1
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

18. Update BillingDetails

Update billing details API call is used to update customer billing information against an order.

Request Parameters:

Name Description value

enc_request AES encrypted request data
(required)
access_code Unique CCAvenue access code which is
(required) generated when merchant registered their IP
address. Youmust send thiswitheach
request.

request_type API requests are accepted in XML or JSON. Possiblevalueforrequest_type is

(required) Specify the request type. “XML” or “JSON”.

response_type API returns XML or JSON responses. If left Possible value for
(optional) blank,the responsewill beinthesame response_type is “XML” or
format as request. “JSON”.

command Command value specifies the API Calls. You Possible valueforthisAPIcall
(required) must send this with each request. is “updateBillingDetails”

reference_no Unique CCAvenue reference no for the Numeric value(25).

(required) transaction.

bill_name Billing name for the order Alphanumeric with special

(required) characters (space, hyphen,
apostrophe, underscore,
dot)(60).

bill_email Billing email id for order Alphanumeric with special

(required) characters (hyphen,
underscore, dot, @)(70).

bill_address Billing address for order Alphanumeric with special

(required)421=Unsupport characters (space, hyphen,
ed version for the API comma, ampersand(&), hash(#),
call. circular brackets and
dot)(315)
bill_city Billing city for order Alphanumeric with special
(required) characters (space, comma,
hyphen and dot)(30).
bill_state Billing state for order Alphanumeric with special
(required) characters (hyphen, dot and
space)(30).

bill_country Billing country for order Alphanumeric with special

(required) characters (space)(30).

bill_zip Billing zip for order AlphaNumeric with special

(required) characters(hyphen and space)
(15).

Request format:

XML Format:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Update_Billing_Details_Query>
<reference_no>123456</reference_no>
<bill_name>bill name</bill_name>
<bill_email>[email protected]</bill_email>
<bill_address>santacruz(west)</bill_address>
<bill_city>mumbai</bill_city>
<bill_state>maharashtra</bill_state>
<bill_country>india</bill_country>
<bill_zip>400000</bill_zip>
</Update_Billing_Details_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

JSON Format:

{
"reference_no":"123456",
"bill_name":"bill name",
"bill_email":"[email protected]",
"bill_address":"santacruz(west)",
"bill_city":"mumbai",
"bill_state":"maharashtra",
"bill_country":"india",
"bill_zip":"400000"
}
Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending it to
CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status421=Unsupported Thisstateswhetherthecallwassuccessfulor not. Value“0”denotes thatthe APIcall
versionfortheAPIcall. Ifvalue ofthisparameter is“1”thenyou need was successful.
notdecrypt the enc_response as itwill Value“1” denotes API call failure.
contain plain errormessage. On enc_response is plain text
representstheerrormessage.

enc_response AESencryptedresponsecontainingformat as
per response_type

error_desc Failure reason if billing details are not updated String

successfully. Please refer below tablefor failure
message.

error_code Error code for Failure reason. String

Please refer below tablefor failure
message.

update_status Update_status denotes whether Billing “0” means update billing details was
informationhavebeenupdatedsuccessfully or successful.
not. “1” means billing details are not
successfully updated.

Response Format:

XML Format:

Success:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Update_Param_Result update_status="0" error_desc=”” error_code=””/>

Failure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Update_Bill_Details_Result update_status=”1” error_desc=”Reference number: Invalid Parameter”
error_code=”51316”/>
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

JSON Format:

Success:
{
"update_status":0,
"error_desc":"",
"error_code":""
}

Failure:

"error_desc":"Referencenumber:InvalidParameter",
"update_status":1,
} "error_code":"51316"
 Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

19. PayId Details

PayId Details API call is used to list transactions for a given PayId.

Request Parameters

Name Description Note

enc_request AES encrypted request data.
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. You must send this with each request.

request_type API requests are accepted in XML or JSON. Possible value for request_type is
(required) Specify the request type. “XML” or “JSON”
 response_type API returns responses in XML or JSON format. Possible value for response_type is
(optional) If left blank, the response will be in thesame “XML” or “JSON”
format as request.
Command Command value specifies the API calls. You Possible value for this API call is
(required) must send this with each request. “payIdDetails”.
pay_id (required) Provide the settlement Date to find the Numeric(25).
payouts list.
page_number (required) A limited number of records are shared as part Numeric(4).
of the response. The total records & number
of pages are shared as part of the response to
enable subsequent calls.
no_of_records(required) Number of records which are available in Numeric.
pages.

Example XML Request

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>

<pay_id_details_query>
<pay_id>XXXXX</pay_id>
<page_number>1</page_number>
<no_of_records>300</ no_of_records >
</pay_id_details_query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly refer to the encryption section.
Example JSON Request

{
'pay_id':'XXXXX',
‘page_number’:1
‘no_of_records’:300
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly refer to the encryption section.
Response Parameters

Name Description Note

status This states whether the call was successful Value “0” denotes that the API
or not. If value of this parameter is “1” call was successful.
then you need not decrypt the Value “1” denotes API call
enc_response as it will contain plain error failure. On enc_response is plain
message. text representing the error
message.

enc_response AES encrypted response containing format

as per response_type.

pay_Id Unique pay Id for payout. Numeric (25).

Amount Amount of transaction. Decimal(12,2).

amt_payable Payable amount for given transaction to Decimal(12,2).

merchant.

bank_ref_no Bank reference number of aggregator Numeric(25).

bank.

bill_email Customer email id for the transaction. Alphanumeric with special

characters (hyphen, underscore,
dot,@)(70).

bill_name Order billing name for the order. Possible value for name is
Alphanumeric with special
characters (space, hyphen,
apostrophe, underscore,
dot)(60).

ccavenue_ref_no CCAvenue reference no allocated to the Numeric(25).

transaction.

currency Currency in which merchant processed the String

transaction. Examples:
INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
EUR – Euro, official currency of
Eurozone
date_time This is the latest date and time when order DateTime in IST( yyyy-MM-dd
status is modified. HH:mm:ss.SSS) format.

fees Fee applied to process transaction by Decimal(12,2).

CCAvenue.

order_no Order No for the transaction. AlphaNumeric with special

characters(hyphen and
underscore)(30).

sub_acc_id Unique Id for sub Account of merchant if Alphanumeric with special

provided for transaction characters (hyphen)(20).

tax Sum of Taxes applied for the transaction. Decimal(12,2).

txn_type Type of transaction included in payouts. String Example:

Auto-Cancelled
Cancelled
MISC
MSGCHRG
Chargeback
Refunded
Shipped
ASUC

order_option_type Type of payment option. String Example:

OPTEMI
OPTNBK
OPTMOBP
OPTIVRS
OPTCASHC
OPTDBCRD
OPTCRDC
OPTWLT
OPTNEFT
OPTUPI

page_count Total pages available based on Example: no_of_records sent in

no_of_records in the request request was 100
total_records matching the
total_records Total no. of orders matching the lookup lookup criteria were 1000
criteria page_count will be 10
(total_records / no_of_records)
rounded to the ceiling

error_desc Reason if customer payment option is not String.

going to be deleted successfully. Please refer below table for
failure message.
error_code Error code for the Failure reason. String.
Please refer below table for
failure message.
 Example XML Response

Success:

<?xml version='1.0' encoding='UTF-8'?>

<pay_id_details_Result>
<error_code></error_code>
<error_desc></error_desc>
<pay_id>XXXXX</pay_id>
<page_count>X</page_count>
<total_records>XXX</total_records>
<pay_id_txn_details_list>
<pay_id_txn_details
amount="40.00" amt_payable="35.88" bank_ref_no="14525144XX217"[email protected]
bill_name="Shashi" ccavenue_ref_no="2XX000170631"currency="INR"
date_time="2016-01-11 17:42:58.223" fees="3.60" order_no="296XX917"sub_acc_id="" tax="0.52"
order_option_type=”OPTDBCRD”txn_type="Chargeback" />
</pay_id_txn_details_list>
</pay_id_details_Result>

Failure:

<?xml version='1.0' encoding='UTF-8'?>

<pay_id_details_Result>

<error_code>51419</error_code>
<error_desc>Enc_request: No record found for given criteria.</error_desc>
<pay_id>XXXXX</pay_id>
<page_count>0</page_count>
<total_records>0</total_records>
</pay_id_details_Result>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Example JSON Response

Success:
{

"pay_id_details_Result":{"error_code":"",
"error_desc":"","pay_id":XXXXX,
“page_count”:X,“total_records”:XXX,
"pay_id_txn_details_list":{
"pay_id_txn_details"[{
"amt_payable":35.88, "bill_email":"[email protected]","fees":3.6, "bill_name":"Shashi", "order_no":29XX9917,
"currency":"INR", "amount":40,"tax":0.52,"ccavenue_ref_no":20XX00170631, "bank_ref_no":1452XXX407217,
"date_time":"2016-01-11 17:42:58.223","order_option_type":"OPTDBCRD","txn_type":"Chargeback",
"sub_acc_id":""
}]
}
}
}

Failure:
{
"pay_id_details_Result":{
"error_code":XXXXX,
"error_desc":"pay_id: Invalid Parameter",
"pay_id": XXXXX,
"total_records":0,
"page_count":0

}
}
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

20. Payouts Summary

Payouts Summary API call is used to list payouts summary for a merchant for a given settlement date.

Request Parameters

Name Description Note

enc_request AES encrypted request data.
(required)

access_code Unique CCAvenue access code which is

(required) generated when merchant registered their IP
address. You must send this with each request.

request_type API requests are accepted in XML or JSON. Possible value for request_type is
(required) Specify the request type. “XML” or “JSON”

response_type API returns responses in XML or JSON format. Possible value for response_type
(optional) If left blank, the response will be in thesame is “XML” or “JSON”
format as request.

Command Command value specifies the API calls. You Possible value for this API call is
(required) must send this with each request. “payoutSummary”.

settlement_date Provide the settlement Date to find the Date must be in IST(dd-mm-yyyy
(required) payouts list. )format.

Example XML Request

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>

<payout_summary_query>

<settlement_date>01-02-2019</settlement_date>

</payout_summary_query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly refer to the encryption section. Example JSON Request

{
'settlement_date': '01-02-2019'
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before sending
it to CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status This states whether the call was successful Value “0” denotes that the API
or not. If value of this parameter is “1” call was successful.
then you need not decrypt the Value “1” denotes API call
enc_response as it will contain plain error failure. On enc_response is plain
message. text representing the error
message.

enc_response AES encrypted response containing format

as per response_type.

pay_amount Payout amount for a payout. Decimal(12,2).

pay_Id Unique pay Id for payout. Numeric (25).

settlement_date Date of settlement. Date in IST(dd-mm-yyyy )

format.

settlement_bank Name of bank in which settlement done. String.

settlement_currency Currency in which settlement is done. String.

Examples:
INR – Indian Rupee

trans_currency Currency in which merchant processed the String

transaction. Examples:
INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
EUR – Euro, official currency of
Eurozone

sub_acc_Id Unique sub account id for merchant if Alphanumeric with special

payouts done for sub account of merchant. characters (hyphen)(20).

utr_no Unique id from bank against each payout String.

id.
error_desc Reason if customer payment option is not String
going to be deleted successfully. Please refer below table for
failure message.

error_code Error code for Failure reason. String

Please refer below table for
failure message.

Example XML Response

Success:

<?xml version='1.0' encoding='UTF-8'?>

<Payout_Summary_Result>

<error_code></error_code>

<error_desc></error_desc>

<payout_summary_list>

<payout_summary_details
pay_amount="211.76"
pay_Id="40907"
settlement_date="19-01-2016"
settlement_bank="KARUR VYSYA BANK"

settlement_currency="INR" sub_acc_Id="split-1"
trans_currency="INR"
utr_no="1234567890” />

</payout_summary_list>

</Payout_Summary_Result>

Failure:

<?xml version='1.0' encoding='UTF-8'?>

<Payout_Summary_Result>

<error_code>51419</error_code>

<error_desc>Enc_request: No record found for given criteria.

 </error_desc>

</Payout_Summary_Result>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Example JSON Response

Success:
{

"Payout_Summary_Result":{

"error_code":"",

"error_desc":"",

"pauyout_summary_list":{

"pauyout_summary_details":[{

"settlement_bank":"KARUR VYSYA BANK",

"pay_amount":211.76,

"trans_currency":"INR",

"pay_Id":40907,

"sub_acc_Id":"split-1",

"settlement_date":"19-01-2016",

"settlement_currency":"INR",

“utr_no”="1234567890”

}]

Failure:
{
 "Payout_Summary_Result":{

"error_code":52014,

"error_desc":"payout_date: Required parameter missing"

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

21. Refund Details API:

The getRefundDetails API call can be used to fetch refund information of the particular transaction.

Sample request

enc_request=63957FB55DD6E7B968A7588763E08B240878046EF2F520C44BBC63FB9CCE726209A473487
7
F5904445591304ABB2F5E58B951E39EAFB9A24584B00590ADB077ADE5E8C444EAC5A250B1EA96F68D22
E
44EA2515401C2CD753DBA91BD0E7DFE7341BE1E7B7550&access_code=8JXENNSSBEZCU8KQ&command
= getRefundDetails&request_type=XML&response_type=XML&version=1.1

Request Parameters

Name Description Note

AES encrypted request data
enc_request
(required)
access_code This is the access code for your
(required) application. You must send this
with each request.

request_type(required) API requests are accepted in XML Value is “XML” or “JSON”.

or
JSON formats. Specify the
request type.

response_type API returns XML or JSON Value is “XML” or “JSON”.

(optional) responses. If left blank, the
response will be in the same
format as request.
command (required) This is the command to access the Value is “getRefundDetails”
API Calls. You must send this with
each request.

reference_no Unique CCAvenue reference Numeric (25)

number for the transaction.
(required)

Example XML Request

<?xml version='1.0' ?>

<RefundDetails_Query
reference_no='123456789012'> </RefundDetails_Query>

Example JSON Request

{'reference_no':'123456789012'}

Note: You will have to encrypt the above request and store in the “enc_request” parameter before
sending it to CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status This states whether the call was successful Value “0” denotes that the API call
or not. If value of this parameter is “1” was successful.
then you need not decrypt the Value “1” denotes API call failure. On
enc_response as it will contain the plain enc_response is plain text that
error message. represents the error message.

enc_response AES encrypted response containing format

as per response_type

error_desc Reason if API call fails. String

Please refer to the below table for
failure message.

error_code Error code for Failure reason. String

Please refer to the below table for
failure message.

reference_no Unique CCAvenue reference number for Numeric (25)

the transaction.

order_no Order No for the transaction. Alphanumeric with special characters

(hyphen and underscore) (30).

order_curr Possible Order Currency in which String

merchant processed the transaction. Examples:
INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
 EUR – Euro, official currency of
Eurozone
order_amt Amount for the transaction. Decimal (12,2).

order_status Status of the order. It can be single or String

multiple. Possible values are:
Auto-Reversed (Two identical
transactions for same order number,
both were successful at bank's end
but we got response for only one of
them, then next day during
reconciliation we mark one of the
 transaction as auto reversed, or we
mark transaction as Auto-Reversed if
merchant Instant
Gratification setting is Yes )
Cancelled (Transaction is cancelled by
merchant )
Refunded (Transaction amount is
refunded)
Auto-Cancelled (Transaction was not
confirmed in given time)

refund_amt Transaction amount that was refunded. Decimal (12,2).

Amount can be full or partial of the
transaction amount.

refund_issue_date Refund Issue Date &Time. DateTime in IST ( yyyy-MM-dd

HH:mm:ss.SSS) format.

refund_processed_on Latest refund process Date &Time. DateTime in IST ( yyyy-MM-dd

HH:mm:ss.SSS) format.

refund_completion_date Refund Completion Date &Time. DateTime in IST ( yyyy-MM-dd

HH:mm:ss.SSS) format.

refund_bank_ref_no Reference number shared by Bank after Alphanumeric (25)

refund.

refund_mer_ref_no Reference number shared by merchant at Alphanumeric (30)

the time of refund.

refund_status Status of issued refund. TS-REFC: Refund Confirmed

TS-REFA: Refund Awaited
TS-REFF: Refund Failed
TS-REFD: Refund Declined

Successful Response

XML Response:

<?xml version='1.0' encoding='UTF-8'?>

<refund_details_Result error_code=""
error_desc=""
order_amt="10.00"
 order_curr="INR"
order_no="06333954"
order_status="Refunded"
reference_no="203000111377">
<refund_list>
<RefundDetails refund_amt="1.00"
refund_bank_ref_no="2492"
refund_completion_date="2014-09-12 15:12:07.77"
refund_issue_date="2014-09-12 15:11:07.877"
refund_mer_ref_no="A1"
refund_processed_on=""
refund_status="TS-REFC" />
<RefundDetails refund_amt="1.00"
refund_bank_ref_no="2493"
refund_completion_date="2014-09-12 15:12:10.413"
refund_issue_date="2014-09-12 15:11:13.99"
refund_mer_ref_no="A2"
refund_processed_on=""
refund_status="TS-REFC" />
</refund_list>
</refund_details_Result>

JSON Response:

{
"refund_list":[{"refund_amt":"1.00",
"refund_issue_date":"2014-09-12 15:11:07.877",
"refund_processed_on":"",
"refund_completion_date":"2014-09-12 15:12:07.77",
"refund_bank_ref_no":"2492",
"refund_mer_ref_no":"A1",
"refund_status":"TS-REFC"
},
{
"refund_amt":"1.00",
"refund_issue_date":"2014-09-12 15:11:13.99",
"refund_processed_on":"",
"refund_completion_date":"2014-09-12 15:12:10.413",
"refund_bank_ref_no":"2493",
"refund_mer_ref_no":"A2",
"refund_status":"TS-REFC"
}],
"reference_no":"203000111377",
"order_no":"06333954",
"order_amt":"10.00",
"order_curr":"INR",
"order_status":"Refunded",
"error_desc":"",
"error_code":""
}
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.

Failure Response:

XML Response:

<?xml version='1.0' encoding='UTF-8'?>

<refund_details_Result
error_code="51419"
error_desc="Enc_request: No record found for given criteria."
order_amt=""
order_curr=""
order_no=""
order_status=""
reference_no="123456789012"
/>

JSON Response:

{
"reference_no":"123456789012",
"order_no":"",
"order_amt":"",
"order_curr":"",
"order_status":"",
"error_desc":"Enc_request: No record found for given criteria.",
"error_code":"51419"
}

22. getSettlementDetails :- – The getSettlementDetails call is use to get the Settlement details such payid
,UtrNo and settlement date. It works on XML and JSON request format only and version 1.2

Sample request

enc_request=63957FB55DD6E7B968A7588763E08B240878046EF2F520C44BBC63FB9CCE726209A4734877
F5904445591304ABB2F5E58B951E39EAFB9A24584B00590ADB077ADE5E8C444EAC5A250B1EA96F68D22E
44EA2515401C2CD753DBA91BD0E7DFE7341BE1E7B7550&access_code=8JXENNSSBEZCU8KQ&command=
getSettlementDetails &request_type=XML&response_type=XML&version=1.2

Request Parameter

Name Description Note

AES encrypted request data
enc_request
(required)
access_code This is the access code for your
(required) application. You must send this
with each request.

request_type(required) API requests are accepted in XML or Value is “XML” or “JSON”.

JSON formats. Specify the
request type.

response_type API returns XML or JSON Value is “XML” or “JSON”.

(optional) responses. If left blank, the
response will be in the same
format as request.

command (required) This is the command to access the Value is “getSettlementDetails”

API Calls. You must send this with
each request.

reference_no Unique CCAvenue reference Numeric (12)

(required) number for the transaction.
Response Parameter

Name Description Note

enc_response AES encrypted response containing format
as per response_type

error_desc Reason if API call fails. String

Please refer to the below table for
failure message.

error_code Error code for Failure reason. String

Please refer to the below table for
failure message.

reference_no Unique CCAvenue reference number for Numeric (25)

the transaction.

Pay_Id Unique pay Id for payout. Numeric(25)

Utr_no Unique id from bank against each payout String

id.

Settlement_date Date of Settlement Date in IST(dd-mm-yyyy)

Following are the request and response formats...

1. XML request format:

<?xml version='1.0' ?>

<SettlementDetails_Query reference_no='109810375484'>
</SettlementDetails_Query>

XML response format:

<?xml version='1.0' ?><SettlementDetails_Query order_no=''

reference_no='109810375484'></SettlementDetails_Query>
<?xml version='1.0' encoding='UTF-8'?>
<Settlement_Details_Result>
<error_code></error_code>
<error_desc></error_desc>
<settlement_details_list><settlement_details pay_Id="485807528" settlement_date="2020-03-31"
utr_no="CMS1450654388"/>
</settlement_details_list>
</Settlement_Details_Result>

2. Json request format:

 {'reference_no':'109810375484'}

Json response format:

{"Settlement_Details_Result":
{"settlement_details_list":
"settlement_details":
{"settlement_date":"2020-03-31","utr_no":"CMS1450654388","pay_Id":485807528}},
"error_desc":"",
"error_code":""}}

24. Consolidate Payout Summary

ConsolidatePayouts Summary API call is used to list payouts summary for a merchant for a given
settlement date.

Request Parameters

Name Description Note

enc_request AES encrypted request data.
(required)
access_code Unique CCAvenue access code which is
(required) generated when merchant registered their
IP
address. You must send this with each
request.

request_type API requests are accepted in XML or JSON Possible value for request_type is
(required) . Specify the request type. “XML” or “JSON”

response_type API returns responses in XML or JSON Possible value for response_type

(optional) format. If left blank, the response will be inthe is “XML” or “JSON”
 same format as request.

Command Command value specifies the API calls. You Possible value for this API call is
(required) must send this with each request. “consolidatepayoutSummary”.

settlement_date Provide the settlement Date to find the Date must be in IST(dd-mm-yyyy
(required) payouts list. )format.

Example XML Request

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>

<Consolidatepayout_summary_query>

<settlement_date>01-02-2019</settlement_date>

</Consolidatepayout_summary_query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter
before sending it to CCAvenue. Kindly refer to the encryption section. Example JSON Request

{
'settlement_date': '01-02-2019'
}

Note: You will have to encrypt the above request and store in the “enc_request” parameter
before sending it to CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status This states whether the call was Value “0” denotes that the API
successful
or not. If value of this parameter is “1 call was successful.
then you need not decrypt theValue “1” denotes API call
enc_response as it will contain plain failure. On enc_response is plain
error
message. text representing the error
message.

enc_response AES encrypted response containing

format
as per response_type.
account_no numeric(25)
Account number for payout
ifsc_code Ifsc code of bank

pay_amount Payout amount for a payout. Decimal(12,2).

pay_Id Unique pay Id for payout. Numeric (25).

settlement_date Date of settlement. Date in IST(dd-mm-yyyy )

format.

settlement_bank Name of bank in which settlement done. String.

settlement_currency Currency in which settlement is done. String.

Examples:

INR – Indian Rupee

trans_currency Currency in which merchant processed String

the
transaction. Examples:
INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
EUR – Euro, official currency of
Eurozone

sub_acc_Id Unique sub account id for merchant if Alphanumeric with special

payouts done for sub account of characters (hyphen)(20).
merchant.

utr_no Unique id from bank against each String.

payout
id.

error_desc Reason if customer payment option is String

not
going to be deleted successfully. Please refer below table for
failure message.
error_code Error code for Failure reason. String
Please refer below table for
failure message.
Example XML Response

Success:

<?xml version='1.0' encoding='UTF-8'?>

<ConsolidatePayout_Summary_Result>

<error_code></error_code>

<error_desc></error_desc>

<Consolidatepayout_summary_list>

<Consolidatepayout_summary_details
account_no=”784857445”
ifsc_code=”HDFC000060”
pay_amount="211.76"
pay_Id="40907"
settlement_date="19-01-2016"
settlement_bank="KARUR VYSYA BANK"
sub_acc_id=” ”
settlement_currency="INR" sub_acc_Id="split-1"
trans_currency="INR"
utr_no="1234567890” />

<Consolidatepayout_summary_details
account_no=”784857445”
ifsc_code=”HDFC000060”
pay_amount="211.76"
pay_Id="0"
settlement_date="19-01-2016"
settlement_bank="KARUR VYSYA BANK"
sub_acc_id=””

settlement_currency="INR" sub_acc_Id="split-1"
trans_currency="INR"
utr_no="1234567890” />

</Consolidatepayout_summary_list>

</ConsolidatePayout_Summary_Result>

Failure:

<?xml version='1.0' encoding='UTF-8'?>

<ConsolidatePayout_Summary_Result>

<error_code>51419</error_code>
 <error_desc>Enc_request: No record found for given criteria.

</error_desc>

</ConsolidatePayout_Summary_Result>
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer
to the decryption section.

Example JSON Response

Success:
{

"ConsolidatePayout_Summary_Result":{

"error_code":"",

"error_desc":"",

"Consolidatepauyout_summary_list":{

"Consolidatepauyout_summary_details":[{

“account_no”:”784857445”,
“ifsc_code”:”HDFC000060”,
"settlement_bank":"KARUR VYSYA BANK",

"pay_amount":211.76,

"trans_currency":"INR",
"pay_Id":40907,
"sub_acc_Id":"split-

1","settlement_date":"19-01-2016",

"settlement_currency":"INR",

“utr_no”:"”

}],

"Consolidatepauyout_summary_details":[{

“account_no”=”784857445”,
“ifsc_code”:”HDFC000060”,
"settlement_bank":"KARUR VYSYA BANK",
"pay_amount":211.76,

"trans_currency":"INR",
"pay_Id":”0”,

"sub_acc_Id":"split-1",

"settlement_date":"19-01-2016",

"settlement_currency":"INR",
 “utr_no”:"”

Failure:
{

"ConsolidatePayout_Summary_Result":{

"error_code":52014,

"error_desc":"payout_date: Required parameter missing"

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly
refer to the decryption section.

25. ConsolidateSettlementDetails

ConsolidateSettlementDetails API call is used to list Settelement Details for a merchant for a given Order
Number And Reference Number.

Request Parameters

Name Description Note

enc_request AES encrypted request data.
(required)
access_code Unique CCAvenue access code which is
(required) generated when merchant registered their
IP
address. You must send this with each
request.

request_type API requests are accepted in XML or JSON Possible value for request_type is
(required) . Specify the request type. “XML” or “JSON”

response_type API returns responses in XML or JSON Possible value for response_type

(optional) format. If left blank, the response will be in is “XML” or “JSON”

the

same format as request.

Command Command value specifies the API calls. You Possible value for this API call is
(required) must send this with each request. “ConsolidateSettlementDetail

Order Number Provide the Order Number to find the

(required) ConsolidateSettlementDetails Order number should be numeric

Reference Number Provide the Reference Number to find the

(required) ConsolidateSettlementDetails Reference number should be
numeric

xml request-
<?xml version='1.0' ?><ConsolidateSettlementDetails_Query> order_no='53889594'
reference_no='53889594' ></ConsolidateSettlementDetails_Query>

Note: You will have to encrypt the above request and store in the “enc_request” parameter
before sending it to CCAvenue. Kindly refer to the encryption section. Example JSON Request

{
'Order Number': '53889594'
'Reference Number': ' 53889594’

Note: You will have to encrypt the above request and store in the “enc_request” parameter
before sending it to CCAvenue. Kindly refer to the encryption section.

Response Parameters

Name Description Note

status This states whether the call was Value “0” denotes that the API
successful
or not. If value of this parameter is “1 call was successful.
then you need not decrypt theValue “1” denotes API call
enc_response as it will contain plain failure. On enc_response is plain
error
message. text representing the error
message.

enc_response AES encrypted response containing

format
as per response_type.
pay_Id Unique pay Id for payout. Numeric (25).

settlement_date Date of settlement. Date in IST(dd-mm-yyyy )

utr_no Unique id from bank against each String utr_no

payout .
error_desc Reason if customer payment option is String
not
going to be deleted successfully. Please refer below table for
failure message.
error_code Error code for Failure reason. String
 Please refer below table for
failure message.

XML Response Data

<?xml version='1.0' encoding='UTF-

8'?><ConsolidateSettlement_Details_Result><error_code></error_code><error_desc></error_des
c><Consolidatesettlement_details_list><Consolidatesettlement_details pay_Id="711304"
settlement_date="2020-03-12" utr_no=""/>
pay_Id="0" settlement_date="2020-03-12"
utr_no=""/></Consolidatesettlement_details_list></ConsolidateSettlement_Details_Result>

Failure:

<?xml version='1.0' encoding='UTF-8'?>

<ConsolidateSettlement_Details_Result>

<error_code>51419</error_code>

<error_desc>Enc_request: No record found for given criteria.

</error_desc>

</ConsolidateSettlement_Details_Result>

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer
to the decryption section.

Example JSON Response

Success:
{
"ConsolidateSettlement_Details_Result":{

"error_code":"",

"error_desc":"",

"Consolidatesettlement_details_list":{

"Consolidatesettlement_details":[{

"pay_Id":40907,
 "settlement_date":"19-01-2016",

“utr_no”=" ”

}],

"Consolidatesettlement_details":[{

"pay_Id":0, "settlement_date":"19-

01-2016",

“utr_no”=" ”

Failure:
{

"ConsolidateSettlement_Details_Result":{

"error_code":51002,

"error_desc":"Reference Number: Invalid Parameter"

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly
refer to the decryption section.
Note: - Error Message when API status is “1”.

Error_code Short Description Long Description Message

51401 Missing Parameter Request_type: Required Parameter is “Ensure that request_type
Missing parameter is not blank.”
51402 Missing Parameter Command: Required parameter “Ensure that Command parameter is not
missing blank.”
51403 Missing Parameter Access_code: Required Parameter is “Ensurethataccess_code
Missing parameterisnot blank.”
51404 Invalid Parameter Request Type: Invalid Parameter "Ensurethat Request Typeparameter
valueis only XML/JSON."
51405 Invalid Parameter Response Type: Invalid Parameter "EnsurethatResponseTypeparameter
valueis only XML/JSON."
51407 Invalid Parameter Access_code: Invalid Parameter “You are not allowed to
performthis operation.”
51408 Missing Parameter Enc_request: Required parameter “Ensure that enc_request
missing parameter is not blank.”
51410 Invalid Parameter Command: Invalid Parameter “Ensure that the commandname isnot
invalid. Pleaserefer API documentfor
valid command.”
51411 Invalid Parameter JSONrequestformat:Invalid “Ensure that the JSON request
Parameter format format isnot invalid. Pleaserefer API
documentforthe API call.”
51412 Invalid Parameter XMLrequestformat: Invalid “Ensure that XML request format is not
Parameter format invalid. PleasereferAPIdocumentfor
theAPIcall.”
51419 Invalid Parameters Enc_request: No record found for “No records were found for given
given search
 criteria. criteria.”
51420 Invalid Parameters Enc_request:Unabletoprocess “Unable to process your request for
request the API call.”
51421 Invalid Parameter API version: Invalid Parameter “Pleaseuseonlysupportedversionfor
the API call.”
-1 Invalid Parameter Enc_request: Invalid Request "Ensure that Request parameter isnot
invalid."

Note: Failure Reason for API call

Error_cod Short Description Long Description Reason /Error_desc Applicable to

e
51001 Missing Parameter Reference Number: Required “Ensurethatthe Reference Confirm, Cancel, Refund,
parameter missing Number parameter is not Status,
blank.” UpdateBillingDetails,
UpdateMerchantParams,
InvoiceLookUp,
51002 Invalid Parameter Reference Number: Invalid “Ensurethatthe Reference Confirm, Cancel, Refund,
Parameter Number parameter is Status, OrderLookUp,
numeric.” UpdateBillingDetails,
UpdateMerchantParams,
InvoiceLookUp,
GetPendingOrders
51003 Invalid Parameter Reference Number: Invalid “Ensurethatthe Reference Confirm, Cancel, Refund,
Parameter Number parameter does Status, OrderLookUp,
notexceed 25 UpdateBillingDetails,
characters.” UpdateMerchantParams,
InvoiceLookUp,
GetPendingOrders
51004 Invalid Parameter Reference number/Order “Ensure that reference Status
number: Invalid number/ordernumberis
Parameter provided.”
51006 Missing Parameter Start/From Date: “Ensure that OrderLookUp
Required start/fromdateis
parameter provided.”
missing
51007 Invalid Parameter Start/From Date: Invalid “Ensure that Start/From OrderLookUp
Parameter date is in dd-mm-yyyy
format.”
51008 Invalid Parameter End/To Date: Invalid “Ensure that End/To date OrderLookUp
Parameter is in dd- mm-yyyy
format.”
51009 Missing Parameter Mobile number: Required “Ensure that Mobile Number GenerateQuickInvoice,
parameter missing parameter is not blank.” GenerateRecurringInvoice
, GenerateInvoice, Order
Lookup
51010 Invalid Parameter Mobilenumber:Invalid “Ensure that Mobile InvoiceLookUp,
Parameter number
parameter contains 10 GenerateQuickInvoice,
digits.” GenerateRecurringInvoice
, GenerateInvoice,
GetPendingOrders,
OrderLookUp
51011 Missing Parameter Emailid:Required “Ensure that Email id is GenerateQuickInvoice,
parameter missing provided.” GenerateRecurringInvoice
51012 Invalid Parameter Email id: Invalid “Ensure that onlyletters, InvoiceLookUp,
Parameter numbers, hyphen, dot, one GenerateQuickInvoice,
@ and underscore are GenerateRecurringInvoice
provided for Email id , GetPendingOrders, Order
parameter.” Lookup
51013 Invalid Parameter Email id: Invalid “Ensure that Email id InvoiceLookUp,
Parameter parameter doesnot GenerateQuickInvoice,
exceed 70characters.” GenerateRecurringInvoice,
GetPendingOrders
51014 Missing Parameter Amount: Required “Ensure that Amount GenerateQuickInvoice,
parameter missing parameter is not blank.” GenerateRecurringInvoice
, GenerateInvoice, Refund
Order
51015 Invalid Parameter Amount: Invalid “Ensure that the Amount Confirm, Cancel, Refund,
Parameter parameter is in Decimal.” OrderLookUp,
InvoiceLookUp,
51017 Invalid Parameter Order Number: Invalid “Ensure only letters, Status, GetPendingOrders,
Parameter numbers, hyphen OrderLookUp
and underscore are
provided for Order
Number parameter.”
51018 Invalid Parameter Order Number: Invalid “Ensure that Order Status, GetPendingOrders,
Parameter Number parameter OrderLookUp
does notexceed 30
characters.”
51020 Invalid Parameter Minimum "Ensure that Minimum Order Lookup
amount: Invalid amount parameter has
Parameter Decimal value."
51022 Invalid Parameter Maximum amount: Invalid "Ensure that Maximum Order Lookup
Parameter. amount parameter ghas
decimal value.”
51023 Missing Parameters Page Number: Required "Ensurethat Order Lookup
Parameter missing Page Number
parameter isnot
blank.”
51024 Invalid Parameter Page Number: Invalid "Ensure that Page Order Lookup
Parameter Number parameter is
greater than zero."
51026 Invalid Parameter Invoice id: Invalid “Ensure that invoice id Invoice Lookup
Parameter parameter is numeric.”
51027 Invalid Parameter Invoice id: Invalid “Ensure that invoice id Invoice Lookup
Parameter parameter parameter
does not exceed 30
characters.”
51028 Invalid Parameter Invoice Number: Invalid "Ensure that only Order Lookup
Parameter letters, number hyphen
and underscore are
provided for invoice
Number parameter."
51029 Invalid Parameter Invoice Number: Invalid "Ensure tha Invoice Invoice Lookup
Parameter number parameter
does notexceed 30
characters."
51031 Invalid Parameter Invoice type: Invalid “Ensure that values for InvoiceLookUp,
Parameter invoice type parameter
are TASK/ITEM.”
51032 Missing Parameter Currency: Required “Ensurethat Currency GenerateQuickInvoice,
parameter missing parameteris not blank.” GenerateRecurringInvoice,
GenerateInvoice
51033 Invalid Parameter Currency: Invalid “EnsurethatCurrencyis GenerateQuickInvoice,
Parameter assignedto the GenerateRecurringInvoice,
merchant.” GenerateInvoice
51034 Missing Parameter Valid for: Required “Ensure that'validfor' GenerateQuickInvoice,
parameter missing parameteris not blank.” GenerateRecurringInvoice,
GenerateInvoice
51035 Invalid Parameter Valid for: Invalid “Ensure that 'validfor' GenerateQuickInvoice,
Parameter parameteris Numeric.” GenerateRecurringInvoice,
GenerateInvoice
51036 Invalid Parameter Valid for: Invalid “Ensure that 'valid for' GenerateQuickInvoice,
Parameter parameter does not exceed GenerateRecurringInvoice,
4 digits.” GenerateInvoice
51037 Missing Parameter Valid type: Required “Ensure that valid type GenerateQuickInvoice,
parameter missing parameter value is not GenerateRecurringInvoice,
blank.” GenerateInvoice
51038 Invalid Parameter Valid type: Invalid “Ensure that values for GenerateQuickInvoice,
Parameter valid type parameter are GenerateRecurringInvoice,
days/hours/minutes.” GenerateInvoice
51039 Missing Parameter Bill delivery type: “Ensure that bill GenerateQuickInvoice
Required delivery Type
parameter parameter is not
missing blank.”
51040 Invalid Parameter Bill delivery type: Invalid “Ensure that valuefor GenerateQuickInvoice
Parameter billdelivery type
parameter is
SMS/EMAIL.”
51041 Missing Parameter Name:Requiredparameter “Ensure that Name UpdateBillingDetails,
missing parameter is not blank.” GenerateQuickInvoice,
GenerateRecurringInvoice
51042 Invalid Parameter Name: Invalid Parameter “Ensure that only letters, UpdateBillingDetails,
space, dot, underscore, GenerateQuickInvoice,
hyphen and single GenerateRecurringInvoice,
apostrophe are provided PendingOrder
for Name parameter.”
51043 Invalid Parameter Name: Invalid Parameter “Ensurethat Name UpdateBillingDetails,
parameter does not GenerateQuickInvoice,
exceed 60 characters.” GenerateRecurringInvoice,
PendingOrder

51044 Missing Parameter Address: Required “Ensurethat Address UpdateBillingDetails

parameter missing parameteris not blank.”
51045 Invalid Parameter Address: Invalid “Ensure only letters, UpdateBillingDetails
Parameter numbers, space, hyphen,
comma, ampersand, hash,
circularbracketsanddotare
providedforAddress
parameter.”
51046 Invalid Parameter Address: Invalid “Ensure that Address UpdateBillingDetails
Parameter parameter doesnot
exceed315characters.”
51047 Missing Parameter City: Required parameter “Ensure that City Missing
missing parameter is not blank.” Mer_charge_reference_nu
mber,
UpdateBillingDetails
51048 Invalid Parameter City: Invalid Parameter “Ensure that only UpdateBillingDetails
numbers, letters, space,
comma, hyphen and dot
are provided for City
parameter.”
51049 Invalid Parameter City: Invalid Parameter “Ensurethat City UpdateBillingDetails
parameter does not
exceed 30 characters.”
51050 Missing Parameter Zip/PINcode:Required “Ensure that UpdateBillingDetails
parameter missing Zip/PIN code
parameter is not
blank.”
51051 Invalid Parameter Zip/PIN code: Invalid “Ensure that only letters, UpdateBillingDetails
Parameter numbers, hyphen and
space are provided for
Zip/PIN code
parameter.”
51052 Invalid Parameter Zip/PIN code: Invalid “Ensure that UpdateBillingDetails
Parameter Zip/PIN code
parameter doesnot
exceed 15
characters.”
51053 Missing Parameter State: Required parameter “Ensure that State UpdateBillingDetails
missing parameter is not blank.”
51054 Invalid Parameter State: Invalid Parameter “Ensure that only letters, UpdateBillingDetails
hyphen, dot and space are
providedfor State
parameter.”
51055 Invalid Parameter State: Invalid Parameter “Ensurethat State UpdateBillingDetails
parameter does not
exceed 30 characters.”
51056 Missing Parameter Country : Required “Ensurethat UpdateBillingDetails
parameter missing Country Code
parameter isnot
blank.”
51057 Invalid Parameter Country: Invalid Parameter “Ensure that only letters UpdateBillingDetails
andspace are allowed for
Country Code
parameter.”
51058 Invalid Parameter Country: Invalid Parameter “Ensure that UpdateBillingDetails
Country Code
parameter doesnot
exceed 30
characters.”
51059 Missing Parameter Customerid:Required “Ensure that Customer id GetCustomerPaymentO
parameter missing parameter is not blank.” ptions,
DeleteCustomerPayment
Option,
DeleteCustomer,
Customer payment
option,Add customer
payment option
51060 Invalid Parameter Customer id: Invalid “Ensure that only letters GetCustomerPaymentOpti
Parameter and number are provided ons,Ad d customer
for Customer id payment option
parameter.” DeleteCustomerPaymentO
ption, DeleteCustomer
51061 Invalid Parameter Customer id: Invalid “Ensure that Customer id GetCustomerPaymentO
Parameter parameter does not exceed ptions,
25 digits.” DeleteCustomerPayment
Option,
DeleteCustomer,
Customer payment
option,Add customer
payment option
51062 Missing Parameter Customercardid: “Ensure that Customer card DeleteCustomerPaymentO
Required id is not blank.” ption
parameter
missing
51063 Invalid Parameter Customer card “Ensure that only DeleteCustomerPaymentO
id: Invalid numbers are provided ption
Parameter for Customercardid
parameter.”
51064 Invalid Parameter Customer card “Ensure that DeleteCustomerPaymentO
id: Invalid Customer cardid ption
Parameter parameter doesnot
 exceed 25
characters.”
51065 Missing Parameter Parameter value: Required “Ensurethat Merchant UpdateMerchantParams
parameter missing Paramsvalue is notblank.”
51066 Invalid Parameter Parametervalue: Invalid “Ensurethat Alphanumeric, UpdateMerchantParams
Parameter comma, hyphen,backslash
anddotare
provided for parameters
Value.”
51067 Invalid Parameter Parametervalue: Invalid “Ensurethat Parameter UpdateMerchantParams
Parameter valuedoes notexceed 100
characters.”
51068 Missing Parameter Bill id: Required parameter “Ensure that Billid UpdateInvoiceReferenceN
missing parameter is not blank.” umber,
Updatemerchantreference
numbe r
51069 Invalid Parameter Bill id: Invalid Parameter “Ensure that Billid UpdateInvoiceReference
parameter isa numeric Number,
value greater than zero.” InvoiceLookUp,
Updatemerchantreferenc
enumbe r
51070 Invalid Parameter Bill id: Invalid Parameter “Ensure that Bill id UpdateInvoiceReferenceNu
parameter does not exceed mber, InvoiceLookUp
25 characters.”
51071 Missing Parameter Merchant reference “Ensurethatmerchant UpdateInvoiceReferenceNu
number: Required Reference Number is not mber,
parameter missing blank.”
51072 Invalid Parameter Merchant reference “Ensure that only letters, UpdateInvoiceReferenceNu
number: Invalid numbers, hyphen and mber,
Parameter underscore are provided GenerateRecurringInvoic
for merchant Reference e, GenerateInvoice
number parameter.”
51073 Invalid Parameter Merchant reference “Ensure that Merchant UpdateInvoiceReferenceNu
number: Invalid reference number mber,
Parameter parameter does not exceed GenerateRecurringInvoic
25 characters.” e, GenerateInvoice
51074 Missing Parameter SMS Content: Required “Ensurethat SMS GenerateRecurringInvoice,
parameter missing Content GenerateInvoice
parameter isnot
blank.”
51075 Missing Parameter SMS Content: Required “Ensurethat'Basicplace GenerateRecurringInvoice,
parameter missing holders in SMS Content' GenerateInvoice
parameter is not blank.”
51076 Invalid Parameter SMS Content: Invalid “Ensurethat SMScontent GenerateRecurringInvoice,
Parameter parameter does not GenerateInvoice
exceed 500 Characters.”
51077 Missing Parameter Emailsubject:Required “Ensurethat GenerateQuickInvoice,
parameter missing EmailSubject GenerateRecurringInvoice,
parameter isnot GenerateInvoice
blank.”
51078 Invalid Parameter Email subject: Invalid “Ensure that Email GenerateQuickInvoice,
Parameter subject parameter GenerateRecurringInvoice,
contains only letters, GenerateInvoice
numbers,hyphens, dot,
spaceand underscores.”
51079 Invalid Parameter Email subject: Invalid “Ensure that Email GenerateQuickInvoice,
Parameter subject parameter GenerateRecurringInvoice,
does notexceed 100 GenerateInvoice
characters.”
51080 Invalid Parameter Email “Ensure that Email GenerateRecurringInvoice,
Description: Description parameter GenerateInvoice
Invalid contains only letters,
Parameter numbers,hyphen,
dot,circular brackets,
space, comma,
underscore, hash and
ampersand.”
51081 Invalid Parameter Email "Ensure that Email Generate QuickInvoice
Description: Description
Invalid parameter doesnot
Parameter exceed 100
characters."
51082 Invalid Parameter File List: Invalid “Ensure that only onefile GenerateQuickInvoice
Parameter isattached in quick
invoice.”
51083 Invalid Parameter File List: Invalid “Ensurethat Attached File GenerateQuickInvoice
Parameter extension is(doc,jpg,jpeg,
docx,pdf,png).”
51084 Invalid Parameter File List: Invalid “Ensurethat File size GenerateQuickInvoice
Parameter does not exceed
1MB.”
51085 Missing Parameter Refund Reference Number: “Ensure that 'refund Refund
Required parameter missing reference no' parameter is
not blank.”
51086 Invalid Parameter Refund Reference Number: “Ensure that Only letters Refund
Invalid Parameter and numbers are provided
for refund Reference
Number parameter.”
51087 Invalid Parameter Refund reference "Ensure that Refund Refund orders
number: Invalid reference number
Parameter parameter does not
exceed 100 characters."
51088 Missing Parameter Frequency: Required “Ensurethat Frequency Generate Recurring
parameter missing parameteris not blank.” Invoice
51089 Invalid Parameter Frequency : Invalid “Ensure that values for Generate Recurring
Parameter frequency parameter Invoice
are only
Daily/Monthly/Quarterly/
Yearly.”
51118 Missing Parameter Occurrences: Required “EnsurethatOccurrences Generate Recurring
parameter missing parameter is notblank.” Invoice
51119 Invalid Parameter Occurrences: Invalid “EnsurethatOccurrences Generate Recurring
Parameter parameter is Numeric.” Invoice
51120 Invalid Parameter Occurrences: Invalid “EnsurethatOccurrences Generate Recurring
Parameter parameter does not Invoice
exceed 3 digits.”
51121 Invalid Parameter Occurrences: Invalid “Adding occurrences is Generate Recurring
Parameter only applicable for Invoice
recurring invoice.”
51122 Missing Parameter Task name: Required “Ensure that task name Generate Recurring Invoice
parameter missing parameter is not blank.” GenerateInvoice
51123 Invalid Parameter Task name: Invalid “Ensurethatonly Generate Recurring Invoice
Parameter letters, space, GenerateInvoice
underscore and
hyphenare
providedfortaskname
parameter.”
51124 Invalid Parameter Task name: Invalid “Ensurethat Taskname Generate Recurring Invoice
Parameter parameter does not GenerateInvoice
exceed 30Characters.”
51125 Missing Parameter TaskNote:Required "Ensurethat Task Note Generate Invoice
parameter missing parameteris not blank."
51126 Invalid Parameter Task note: Invalid “Ensurethat Tasknote Generate Recurring Invoice
Parameter parameter contains GenerateInvoice
only letters, numbers,
hyphen, dot, circular
brackets, space,comma,
underscore,hash and
ampersand.”
51127 Invalid Parameter Task Note: Invalid "Ensurethat Task Note Generate Invoice
Parameter parameter does not
exceed60characters."
51128 Missing Parameter Taskrate:Required “Ensure that task rate Generate Recurring Invoice
parameter missing parameter is not blank.” GenerateInvoice
51129 Invalid Parameter Task rate: Invalid “Ensure that task rate Generate Recurring Invoice
Parameter parameter is decimal.” GenerateInvoice
51130 Missing Parameter Taskhour:Required “Ensure that task hour Generate Recurring Invoice
parameter missing parameter is not blank.” GenerateInvoice
51131 Invalid Parameter Task hour: Invalid “Ensure that task hour Generate Recurring Invoice
Parameter parameter is numeric.” GenerateInvoice
51132 Invalid Parameter Task hour: Invalid “Ensurethat task hour Generate Recurring Invoice
Parameter value does not exceed 4 GenerateInvoice
digits.”
51133 Missing Parameter Item name: Required “Ensure that item name Generate Recurring Invoice
parameter missing parameter is not blank.” GenerateInvoice
51134 Invalid Parameter Item name: Invalid “Ensurethatonly Generate Recurring Invoice
Parameter letters, space, GenerateInvoice
underscore and
hyphen are
providedforitemname
parameter.”
51135 Invalid Parameter Item name: Invalid “Ensure that Item name Generate Recurring Invoice
Parameter parameter does not GenerateInvoice
exceed 30 characters.”
51136 Missing Parameter Item description: “Ensure that item Generate Recurring Invoice
Required description parameter is GenerateInvoice
parameter not blank.”
missing
51137 Invalid Parameter Item description: Invalid “Ensure that Item Generate Recurring Invoice
Parameter description GenerateInvoice
parameter contains
only letters, numbers,
hyphen,dot,circular
brackets,space,
comma, underscore,
hash and ampersand.”
51138 Invalid Parameter Item description: Invalid “Ensure that Item Generate Recurring Invoice
Parameter description GenerateInvoice
parameter doesnot
exceed 60
characters.”
51139 Missing Parameter Item Quantity: Required “Ensure that the Generate Recurring Invoice
parameter missing itemquantity GenerateInvoice
parameter is not
blank.”
51140 Invalid Parameter Item Quantity: Invalid “Ensure thatthe Generate Recurring Invoice
Parameter Item Quantity GenerateInvoice
parameter is
numeric.”
51141 Invalid Parameter Item Quantity: Invalid “Ensure that the Item Generate Recurring Invoice
Parameter Quantity parameter does GenerateInvoice
not exceed 3 digits.”
51142 Missing Parameter Unit cost: Required “Ensure thatunitcostof Generate Recurring Invoice
parameter missing itemisnot blank.” GenerateInvoice
51143 Invalid Parameter Unit cost: Invalid “Ensurethatthe Unit Generate Recurring Invoice
Parameter costofitem parameter GenerateInvoice
is a Decimal Number.”
51144 Invalid Parameter Termsand “Ensure that Only letters, Generate Recurring Invoice
Conditions:Invalid numbers, hyphen,dot, GenerateInvoice
Parameter circularbracketsand
ampersandare provided
for Terms and Condition
parameter.”
51145 Invalid Parameter Termsand “EnsurethatTermsand Generate Recurring Invoice
Conditions:Invalid Conditions parameter GenerateInvoice
Parameter doesnotexceed500
characters.”
51146 Invalid Parameter Due date: Invalid “Ensure that Due date Generate Recurring Invoice
Parameter parameter is Numeric.” GenerateInvoice
51147 Invalid Parameter Due date: Invalid “Ensure that Due date Generate Recurring Invoice
Parameter parameter does not GenerateInvoice
exceed 3 digits”
51148 Invalid Parameter Due Date: Invalid “Ensure that due date Generate Recurring Invoice
Parameter parameter is provided GenerateInvoice
when late payment fees is
present.”
51149 Invalid Parameter Latepayment “Ensure that late Generate Recurring Invoice
fees:Invalid payment fees GenerateInvoice
Parameter parameter is provided
when due date is
present.”
51150 Invalid Parameter Discount_if_paid_within_du “Ensure that value for Generate Recurring Invoice
e_date: Invalid Parameter discount_if_paid_within_ GenerateInvoice
due_date parameteris
notgreaterthandue
date.”
51151 Missing Parameter DiscountType:Required "Ensure that Generate Recurring Invoice
parameter missing discount type GenerateInvoice
parameter is
provided when
discount value is
present."
51152 Missing Parameter Discount value: Required "Ensure that Generate Recurring Invoice
parameter missing discount value GenerateInvoice
parameter is
provided when
discount type is
present."
51153 Missing Parameter Latepaymentfeestype: "Ensure that late payment Generate Recurring Invoice
Required parameter fees type parameter is GenerateInvoice
missing provided when late
payment fees is present."
51154 Missing Parameter Latepaymentfees: "Ensure that late Generate Recurring Invoice
Required payment fees GenerateInvoice
parameter missing parameter is provided
when late payment
fees type is present."
51155 Invalid Parameter Discountvalue:Invalid "Ensurethat Generate Recurring Invoice
Parameter Discount value GenerateInvoice
parameter
ranges are:
For percentage (1.00 -
99.99)
For flat (1.00-99999.99)"
51156 Invalid Parameter Latepayment "Ensurethat Late Generate Recurring Invoice
fees:Invalid paymentfees Generate Invoice
Parameter parameter ranges
 are: For percentage
(1.00 -99.99)
For flat (1.00-
99999.99)"
51157 Invalid Parameter Tax List:Invalid Parameter “Ensure thatthere are Generate Recurring
not more thantwo Invoice Generate Invoice
taxes for onetask.”
51158 Invalid Parameter Item/Task List: Invalid “Ensure thatatleastone Generate Recurring
Parameter task/item is added.” Invoice GenerateInvoice
51159 Invalid Parameter Task List: Invalid “Ensure thatthesame Generate Recurring
Parameter task is not added Invoice GenerateInvoice
twice.”
51160 Invalid Parameter Item List: Invalid “Ensure that the same Generate Recurring
Parameter item isnot added Invoice GenerateInvoice
twice.”
51161 Invalid Parameter Discountvalue:Invalid “Ensure that the Generate Recurring
Parameter Discount value Invoice GenerateInvoice
parameter is
Decimal.”
51162 Invalid Parameter Latepayment “Ensurethat Late Generate Recurring
fees:Invalid paymentfees Invoice GenerateInvoice
Parameter parameter is
Decimal.”
51163 Invalid Parameter Discount type: Invalid “Ensurethat values for Generate Recurring
Parameter Discount type Invoice GenerateInvoice
parameterare
Perc/Flat.”
51164 Invalid Parameter Late paymentfees “Ensure that values for Generate Recurring
type: Invalid Late payment fees type Invoice GenerateInvoice
Parameter parameter are
Perc/Flat.”
51165 Invalid Parameter Discountifpaidwithin “Ensure that Discount if Generate Recurring
duedate: Invalid paidwithin duedate Invoice GenerateInvoice
Parameter parameterisNumeric.”
51166 Invalid Parameter Discountifpaidwithin “EnsurethatDiscountif Generate Recurring
duedate: Invalid paidwithin due date Invoice GenerateInvoice
Parameter parameter doesnotexceed
3 digits.”
51167 Invalid Parameter Tax List: Invalid “Ensure that the Generate Recurring
Parameter same tax isnot Invoice GenerateInvoice
addedtwice forthe
same task/item.”
51168 Invalid Parameter Tax List: Invalid "Ensure that there are not Generate Invoice
Parameter more
 than two taxes
applicable for one item."
51169 Invalid Parameter Due Date: Invalid "Ensure that Duedate Generate Recurring
Parameter cannot be greater than Invoice
valid forparameter."
51205 Invalid Parameter Order List: Invalid “Please provide at least Confirm, Cancel,
Parameter one order list.”
51206 Invalid Parameter Order List: Invalid “EnsurethatReference Confirm, Cancel,
Parameter Number parameter is
notrepeated.”
51207 Invalid Parameter Start Date: Invalid “Ensure that Start date Generate Recurring
Parameter is greater than or equal Invoice
to current date.”
51208 Invalid Parameter Start Date: Invalid “Adding start date is only Generate Recurring
Parameter applicable for recurring Invoice
invoice.”
51209 Invalid Parameter Frequency: Invalid “Addingfrequencyisonly Generate Recurring
Parameter applicable for recurring Invoice
invoice.”
51210 Invalid Parameters InvoiceSetting:Invalid "Ensurethatthe Advance Generate Recurring
Parameter Settings option is Invoice
enabled under Invoice
Settings."
51211 Invalid Parameters InvoiceSetting:Invalid "Ensure that SMS Generate Recurring
Parameter content is provided if Invoice
the same is enabled
under Invoice
Settings."
51212 Invalid Parameters InvoiceSetting:Invalid "Ensure that the Adding Generate Recurring
Parameter Task option is enabled Invoice
under Invoice Settings."
51213 Invalid Parameters InvoiceSetting:Invalid "Ensure that theAdding Generate Recurring
Parameter Item option is enabled Invoice
under Invoice Settings."
51214 Invalid Parameters InvoiceSetting:Invalid "Ensurethatthe Generate Recurring
Parameter ChangingInvoice Invoice
Validityoptionis
enabledunder Invoice
Settings."
51215 Invalid Parameters InvoiceSetting:Invalid "Ensure that Changing pre- Generate Recurring
Parameter Invoice
 populated values for item: GenerateInvoice
{e.g. abc} withunitcost{e.g.
1.23}isenabled under
InvoiceSettings."
51216 Invalid Parameters InvoiceSetting:Invalid "Ensure that Changing Generate Recurring Invoice,
Parameter pre- populatedvalues for GenerateInvoice
task {e.g. def} withunit
rate{e.g.1.00}isenabled
under InvoiceSettings."
51217 Invalid Parameters InvoiceSetting:Invalid "Ensure that the number Generate Recurring
Parameter of hours/rateamountfor Invoice, GenerateInvoice
taskisvalid."
51218 Invalid Parameters InvoiceSetting:Invalid "Ensure that unit cost Generate Recurring
Parameter amount/quantityforitem Invoice, GenerateInvoice
isvalid."
51219 Invalid Parameters InvoiceSetting:Invalid "Ensure that Quick Invoice Generate Recurring
Parameter optionis enabled under Invoice, GenerateInvoice
InvoiceSettings."
51226 Invalid Parameters SMS_Content: Invalid "Ensure that Basic Generate Recurring
Parameter placeholders should Invoice, GenerateInvoice
not repeated in SMS
content."
51174 Missing Parameter Cardexpireddate: "Ensurethat Card Add customer payment
Required expireddate option
parameter missing parameter is not
blank."
51175 Invalid Parameter Cardexpired "Ensure that Card Add customer payment
date:Invalid expired date parameter option
Parameter isinMM/yyyyformat."
51177 Missing Parameter CardNumber:Required "Ensurethat Card Add customer payment
parameter missing Number option
parameter isnot
blank."
51178 Invalid Parameter Card Number : Invalid "Ensure that Card Add customer payment
Parameter Number parameter option
is Numeric only."
51179 Invalid Parameter Card Number: Invalid "Ensurethat Card Add customer payment
Parameter Number option
parameterisnot
invalid."
51180 Missing Parameter Card Name: Required "Ensurethat Card Name Add customer payment
parameter missing parameter is notblank." option
51181 Invalid Parameter Card Name: Invalid "Ensurethat Card Name Add customer payment
Parameter parameter is notinvalid." option
51182 Invalid Parameter Name on card: Invalid "Ensure that onlyletters Add customer payment
Parameter andspace are provided option
for name on card
parameter."
51183 Invalid Parameter Name on card: Invalid "Ensure that Name Add customer payment
Parameter on card parameter option
does notexceed 30
characters."
51227 Missing Parameters Issuer Bank: Required “Ensurethat Issuerbank Add customer payment
parameter missing nameis not blank.” option
51228 Invalid Parameters Issuer Bank: Invalid "Ensure that onlyletters Add customer payment
parameter andspace are provided option
for issuer bank
parameter."
51229 Missing Parameters PamentOptionType: "Ensure that payment Add customer payment
Required parameter option type is not blank." option
missing
51230 Invalid Parameters PaymentOption "Ensure that payment Add customer payment
Type:Invalid option type is option
parameter OPTCRDC/OPTDBCRD."
51231 Missing Parameters Nameoncard: Required "Ensure thatname on Add customer payment
parameter missing card is not blank" option
51232 Missing Parameters Cardtype:Required "Ensure thatname on Add customer payment
parameter missing cardtypeis not blank" option
51233 Invalid Parameters Card type: Invalid "Ensure that name on Add customer payment
parameter card type is option
CRDC/DBCRD"
51301 Invalid Parameter Order List: Invalid "Order is already Confirm
Parameter confirmed”
51302 Invalid Parameter Order List: Invalid "Order is already Cancel
Parameter Cancelled:”
51303 Invalid Parameter Order List: Invalid “Invalid order status:” Confirm, Cancel,
Parameter
51304 Invalid Parameter Order List: Invalid “Invalid order/tracking id Confirm, Cancel,
Parameter :”
51305 Invalid Parameter Order List: Invalid “Pending Risk Mitigation:” Confirm, Cancel,
Parameter
51306 Invalid Parameter Order List: Invalid “Order Amt Mismatch:” Confirm, Cancel,
Parameter
51307 Invalid Parameter Order List: Invalid “Pending risk mitigation.” Confirm, Cancel
Parameter
51308 Invalid Parameter Order List: Invalid “Norecord was foundfor Refund, Status,
Parameter thegiven criteria.” OrderLookUp,
51309 Invalid Parameter Reference “Ensure that merchant Refund
number: Invalid reference number
Parameter parameter is not repeated.”
51310 Invalid Parameter Reference “Refund not allowed.” Refund
number: Invalid
Parameter
51311 Invalid Parameter Reference “Multiplerefundsare Refund
number: Invalid notallowed for the
Parameter gateway.”
51312 Invalid Parameter Reference "Cannot initiate refund Refund
number: Invalid request for the given
Parameter order."
51313 Invalid Parameter Order List: Invalid “No records found.” Order Status,
Parameter OrderLookUp,
51314 Invalid Parameter Reference “Refund limit exceeds.” Refund
number: Invalid
Parameter
51315 Invalid Parameter Reference “This is adisputedorder. Refund,
number: Invalid You can refund only up to
Parameter {Currency}{Refund amount
limit}.”
51316 Invalid Parameter Reference “Ensurethat Reg Idor UpdateBillingDetails,
number: Invalid Reference No parameters
Parameter are notinvalid.”
51317 Invalid Parameter Reference number: “Recordalreadyupdatedor UpdateBillingDetails
Invalid Invalid
 Parameter Order Status.”
51318 Invalid Parameter Reference “Ensurethat Order Status UpdateBillingDetails
number: Invalid OR Order Type
Parameter parametersarenot
invalid.”
51319 Invalid Parameter bill_id: Invalid Parameter “Ensure that bill_id UpdateInvoiceReference
parameter isnot invalid.” Number
51320 Invalid Parameter Bill Merchant Reference “Bill Merchant UpdateInvoiceReference
No:Invalid Parameter Reference No Number
parameter
already exists.”
51321 Invalid Parameter Reg ID: Invalid Parameter “Ensurethat Reg ID UpdateMerchantParams
parameter is not invalid.”
51322 Invalid Parameter Reference "Ensure that UpdateMerchantParams
number: Invalid reference number
Parameter parameter is not
invalid."
51323 Invalid Parameter Tax List: Invalid "Ensure that Taxis GenerateInvoice
Parameter configured for the ,GenerateRecurringI
merchant." nvoice
51324 Invalid Parameter Tax List: Invalid “Ensurethat Taxvalue GenerateInvoice
Parameter matches with the given ,GenerateRecurringI
Tax name.” nvoice
51325 Missing Parameter Customerid:Required “Ensurethat Customer DeleteCustomer,
parameter missing parameteris present.”
51326 Invalid Parameter Currency: Invalid "EnsurethatCurrencyis GenerateInvoice,
Parameter assignedto the GenerateRecurringInvoice,
merchant." GenerateQuickInvoice
51327 Invalid Parameter Customer id: Invalid "Ensure that the OrderLookup, Delete
Parameter merchant is not Customer
invalid."
51328 Invalid Parameter Reference "Multiple refunds not RefundOrder
number: Invalid allowed."
Parameter
51336 Invalid Parameter CustomerCard "Card Not Present." DeleteCustomer
Id:Invalid paymentoption
Parameter
51337 Invalid Parameters Customer Id:Invalid “Card Alreday Exists” Add Customer payment
parameters option