100% found this document useful (1 vote)

429 views

HDFC API Document

The document provides documentation for merchants on how to implement CCAvenue's API for payment processing. It describes the API authentication process, available API calls, how to encrypt requests and decrypt responses, and includes examples of API calls.

Uploaded by

bala govindam

Available Formats

Download as PDF, TXT or read online on Scribd

100% found this document useful (1 vote)

429 views

HDFC API Document

Uploaded by

bala govindam

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 160

Merchant’s API Implementation Guide

1
Statement of Confidentiality

This document contains information that is proprietary and confidential to Avenues India Private Limitedwhichshallnot
bedisclosed,transmitted,orduplicated,usedinwholeorinpartforany purposeotherthanitsintendedpurpose.Any
useordisclosureinwholeorinpartofthis informationwithoutexpresswrittenpermissionofAvenuesIndiaPrivateLtd
isprohibited.Any othercompanyandproductnamesmentionedareusedforidentificationpurposesonly,andmay be
trademarks of their respective owners.

2
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, JSON or String 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 IP address from where the API calls will be initiated. API calls
will work only after CCAvenue registers the IP address provided.

1. Merchant ID

2. Access Code

3. Encryption Key

3
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 order has been auto-cancelled by the system, 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 debit card or net banking account that was originally charged. An order 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 – 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 customer of the merchant.

10. Get Customer Payment Option(Kindly pass version as 1.2) – The Customer payment option API call
is used to list payment options saved for a customer. Payments options are saved for a customer in
the vault for easy and convenient payment.

11. Generate Invoice(Kindly pass version as 1.2) - The Invoice API call is used to generate an invoice for a
customer. Values can be passed as for generating invoice using the flexibility of Invoice Settings.

4
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 and tasks are used to create a regular Invoice or a recurring invoice.

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 Invoice reference Number API call is used to update
Invoice referencenumberifthe same was notprovidedat the timeof invoicegeneration.

17. Update Merchant Param - Update Merchant params API is used to add some extra parameter
against Merchant params if the same could not be done at the time of the transaction.

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

19. Bin Details – This is used to fetch the card details for a bin number.

20. PayId Details - Kindly pass version as 1.2) - PayId Details API call is used to list
transactions for a given PayId.

21. 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.

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

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 used for real-time transaction. Encryption key is

5
mapped to Access code as mentioned in API Authentication section.

Name Description
enc_request(required) AES encrypted request data.
access_code(required) This is the access codeforyour application. You must sendthis with each
request.
command(required) This is the command to access the API Calls. You must send this with each
request.
request_type(required) API requests are accepted in XML, JSON or String. Specify the request type.
response_type(optional) API returns XML, JSON or String responses. If left blank, the response will
be in the same format as request.
version(required) This is the version to access API based on version 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

6
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- time transactions.
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 value if status is “1” please refere belowtable
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_response as it will
contain 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.

7
1. Confirm

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 order has been
auto-cancelled by the system, it cannot be confirmed. You can optionally confirm only part of an order.
Remember,youcando soonly once.Remaining funds willbe refunded tothe credit cardor debit cardor 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 inXML, JSONor Possible value for request_type is
(required) String. Specify the request type. “XML” or “JSON” or “STRING”.
response_type API returns responses in XML, JSON or String Possiblevalue for response_typeis
(optional) format. If left blank, the response will be in “XML” or “JSON” or “STRING”.
the same format as request.
Command Commandvalue specifies the API calls. You Possible value for this API call is
(required) must send this with each request. “confirmOrder”.
reference_no Unique CCAvenue reference number for the 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="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

8
"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.

Example STRING Request

Format: reference_no$amt|reference_no$amt|reference_no$amt|

Example: 203000099429$1.00|203000104640$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 successful or not. Value “0” denotes thatthe API call
If value of this parameter is “1” then you need was successful.
not decrypt the enc_response as it will contain Value “1” denotes API call failure.
plain error message. On enc_response is plain text
represents the error message.

enc_response AES encrypted response containing format as

per response_type
success_count Merchant checks the successfully processed Numeric
records for confirmation of the transactions.
0<=success_count<=
Number of orders to be confirmed.
reference_no Unique CCAvenue reference numbers for the Numeric(25)
transaction.
reason Failure reason 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

9
<?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_order error_code="51206" reason="Order List: Invalid Parameter"
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.

Example STRING Response

Format: success_count|error_code$reference_no$reason^error_code$reference_no$reason|

Example: 0|51304 $123456788$ Invalid order/tracking id ^51206$123456788$Order List: Invalid

Parameter|

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

10
2. Cancel

Cancel APIcallallowsyoutocancel a pendingorder. Anorder olderthan12daysis automatically cancelled. Once

an order has been cancelled/auto-cancelled by the system, it cannot be confirmed. Funds will be refunded to the
credit card or debit card or net banking account that was originally charged.

Request Parameters

Name Description Note

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": [

11
{"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.

Example STRING Request

Format: reference_no$amt|reference_no$amt|

Example: 203000099429$1.00|203000104640$101.23|

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”denotesthatAPIcallis
If value of this parameter is “1” then you need successful.
not decrypt the enc_response as it will contain Value “1” denotes API call failure. On
plain error message. enc_response is plain text that
represents the error message.
enc_response AES encrypted response containing format as
per response_type
success_count Merchant checks the successfully processed Numeric
records for cancellation of the transactions.
0<=success_count<=
Numberoforders forthe cancel
request.
reference_no Unique CCAvenue reference number for the Numeric(25)
transaction.
reason Failure reason if given reference_no are not 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>
12
<success_count>0</success_count>
<failed_List>
<failed_order error_code="51304 " reason=" Invalid order/tracking id " reference_no="123456788"/>
<failed_order error_code="51206" reason="Order List: Invalid Parameter"
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

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

Example STRING Response

Format: success_count|error_code$reference_no$reason^error_code$reference_no$reason|

Example: 0|51304 $123456788$ Invalid order/tracking id ^51206$123456788$Order List: Invalid

Parameter|

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. Funds will be refunded to the credit card or debit card or net banking account that was originally
charged.
13
Request Parameters

Name Description Note

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.

14
Example STRING Request

Format: reference_no|refund_amount|refund_ref_no|

Example: 203000094245|1.00|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 This states whether the call was successful or not. Value “0” denotes the API call was
If value of this parameter is “1” then you need successful.
not decrypt the enc_response as it will contain Value “1” denotes API call failure.
plain error message. On enc_response is plain text
represents the error message.

enc_response AES encrypted response containing format as

per response_type
refund_status Refund status specifies whether given refund Numeric
request is going to succeed or fail. Value “0” denotes refund was
successful
Value “1” denotes refund was
failure.
reason Failure reasonif the refundrequest isgoingto fail 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" 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”/>

15
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":"Reference number: Invalid Parameter",
"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.

Example STRING Response

Success Response: Format:

refund_status|
Example: 0|

Failure Response:

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

16
4. Status

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.
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 are accepted inXML, JSONor Possible value for request_type is
(required) String. Specify the request type. “XML” or “JSON” or “STRING”.
response_type API returns responses in XML, JSON or String Possible value for response_type is
(optional) format. If left blank, the response will be in “XML” or “JSON” or “STRING”.
the same format as request.
command (required) Command value specifies the API calls. You Value is “orderStatusTracker”.
must send this with each request.
reference_no CCAvenue reference no. allocated to the 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 is required if you do not 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.

17
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.

Example STRING Request

Format: reference_no|order_no|
Example: 225013271813|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 This states whether the call was successful or not. Value “0” denotes that the API
If value of this parameter is “1” then you need call wassuccessful.
not decrypt the enc_response as it will contain Value “1” denotes API call failure. On
plain error message. enc_response is plain text
represents the error message.

enc_response AES encrypted response containing format 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 Email Address of the Order for notifications. Possible value for email ID is

18
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 pin code 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).
Captured amount can be full or partial of the
transaction amount.
order_curr Possible order Currency in which merchant String Examples:
processed the transaction. INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
EUR – Euro, official currency of
Eurozone

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

Page 19
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(#),
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. Possible value for country is
Alphanumeric with special
characters (space)(30).
order_ship_email Shipping emailID for the notificationsofthe Possible value for email id is
transaction. Alphanumeric with special
characters (hyphen, underscore,
dot, @)(70).
order_ship_name Shipping Name 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).

Page 20
order_ship_tel Telephone no. for notifications of the Numeric(10).
transaction.
order_ship_zip Order shipping address's pin code for the Possible value for zip is
order. Alphanumeric with special
characters(hyphen and space)
(15).
order_status Status of the order. It can be single or multiple. String

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, bothwere 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 )
Awaited (transaction is processed
from billing 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, 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)
Page 21
Successful
Systemrefund(Refunded by
CCAvenue for various findings 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 Amount of TDS (tax deducted at source) 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 Description about the transaction shared by 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 Specify the payment option type for the order. String
Possible value for payment option
type is:
OPTCASHC-Cash card
OPTCRDC -Credit Card
OPTDBCRD-Debit Card
OPTEMI-EMI
OPTIVRS-IVRS
OPTMOBP-MobilePayments
OPTNBK-Net Banking
param_value1 Tempparameters value update bymerchant String
at transaction time for further use.

Page 22
param_value2 Tempparameters value update by merchant String
at transaction time for further use.
param_value3 Tempparameters value update bymerchant String
at transaction time for further use.
param_value4 Tempparameters value update bymerchant String
at transaction time for further use.
param_value5 Tempparameters value update bymerchant String
at transaction time for further use.
page_count Total pages available based on no_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 Reasonifsearchcriteriadidnotfindtheorders for String.
the transactions. Please refer below table for
Error code for Failure reason. failure message.
error_code 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 no 1101, near Railway station 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>
Page 23
<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 no 1101, near Railway station 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>
<param_value1>Mobile No9595226054</param_value1>
<param_value2>Flight from Dehli</param_value2>
<param_value3>ToMumbai</param_value3>
<param_value4>Mobile No9595226054</param_value4>
<param_value5>Mobile No9595226054</param_value5>
<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:

Page 24
{
"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 Railway station 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 no 1101, near Railway station Ambad",
"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-16 15: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",
"param_value1":"Mobile No9595226054",
"param_value2":"Flight from Dehli",
"param_value3":"ToMumbai",
"param_value4":"Mobile No9595226054",
Page 25
"param_value5":"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.

Example STRING Response

Example:

0|Successful|204000163514|068406|Transaction Successful|Shashi|[email protected]|Room no
1101, near Railway station Ambad|Indore|MP|India|9595226054|425001|MasterCard|INR|2015-
09-18 12:53:40.407||PC|NA|ICICI|192.168.2.182|64807533|order will be
shipped|OPTCRDC|Shashi||Room no 1101, near Railway station
Ambad|Indore|MP|India|9595226054|425001|2015-09-18
12:54:15.357|0.0|1.0|0.0|0.0|0.0|2.3|0.02|1.0|0.0028|Mobile No9595226054|Flight from
Dehli|ToMumbai|Mobile No9595226054|Mobile No9595226054|

Failure Response:

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

5. Order Lookup

The Lookup API call can be used to extract transaction details for a certain set of transactions. 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. You must send this with each
request.
request_type API requestsareaccepted inXML, JSONor Possible value for request_type is
(required) String. Specify the request type. “XML” or “JSON” or “STRING”.
response_type API returns responses in XML, JSON or String Possiblevalue for response_typeis
(optional) format. If left blank, the response will be in “XML” or “JSON” or “STRING”.
the same format as request.
Command Commandvalue specifiesthe APIcalls. You Possible value for this API call is
(required) must send this with each request. “orderLookup”.
reference_no Unique CCAvenue referencenumber forthe Numeric(25).
(optional) transaction.
from_date Provide the Start Date to find the orders list. Datemust be inIST(dd-mm-yyyy
(required) )format.
to_date Provide the end date to search the orders Date must be in IST(dd-mm-yyyy)
(optional) between from date and to date. It should be format.
greater than or equal to from date.
order_currency Currencyinwhichyouprocessed the String
(optional) transaction. You can send the multiple
currencies format. Example:
INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar GBP
– Pound Sterling
EUR – Euro, official currency of
Eurozone

Multiple currency format:

INR|USD|GBP in JSON & XML
request type but INR$USD$GBP in
STRING request type

Page 27
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 “No Risk”
4) Value “GA” denotes “Go Ahead”
5) Value “NA” denotes “Not
Applicable”
order_min_amount Minimum amount limit for search criteria for Decimal(12,2).
(optional) the transaction.
order_max_amount Maximum amount limit for search criteria for Decimal(12,2).
(optional) the transaction.
order_name Customer name for the transaction. Alphanumeric with special character
(optional) (space, hyphen, apostrophe,
underscore, dot)(60).
order_no Unique merchantordernoforthe transaction. AlphaNumeric with special
(optional) characters(hyphen and
underscore)(60).
order_payment_type Payment Modeforthetransaction.It canbe String
(optional) single or multiple.
Below are the Possible Values:
1) CASHC (Cash Card Payment Type)
2) CRDC (Credit Card Payment Type)
3) DBCRD (Debit Card Payment
Type)
4) MOBP (Mobile Payment Type)
5) NBK (Net Banking )

Multiple values format:

MOBP|NBK for JSON & XML request
type butMOBP$NBK for STRING
request type.

Page 28
order_status Status of the 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,
both were successful at bank'sendbut
we gotresponsefor
only one of them, then next day
during reconciliation we mark one of
the transaction as auto reversed )
Awaited (transaction is processed from
billing 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)

Page 29
Fraud (we update this during recon,
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-ORDSC denotes “Shopping
Cart Orders”
4) OT-PPAY denotes” Phone Pay”
5) OT-SNIP denotes “SNIP orders”
order_bill_tel Customermobilenumber for thetransaction. Numeric(10).
(optional)
page_number A limited number of records are shared as part of Numeric(4).
(required) the response. The total records & number of
pages are shared as partof the response to
enable subsequent calls.

Page 30
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 refer to 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
}

Page 31
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 STRING Request

Example: ||21-03-2015|03-04-2015||||||||||||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.

Response Parameters

Name Description Note

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

enc_response AES encrypted response containing format 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(#),
circularbrackets 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 Email Address of the Order for notifications. Possible value for email id is
Alphanumeric with special characters
(hyphen, underscore,
dot,@)(70).

Page 32
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).
Captured amount can be full or partial of the
transaction amount.
order_curr Possible order Currency in which merchant String Examples:
processed the transaction. INR – Indian Rupee
USD – United States Dollar SGD –
Singapore Dollar GBP – Pound
Sterling
EUR – Euro, official currency of
Eurozone

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

Page 33
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(#),
circularbrackets 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. Possible value for country is
Alphanumeric with special
characters (space)(30).
order_ship_email Shipping emailID for the notificationsofthe Possible value for email id is
transaction. Alphanumeric with special
characters (hyphen, underscore,
dot,@)(70).
order_ship_name Shipping Name 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's pin code for the Possible value for zip is
order. AlphaNumeric with special
characters(hyphen and space)
(15).

Page 34
order_status Status of the order. It can be single or multiple. String
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, 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 )
Awaited (transaction is
processed from billing 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, 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_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 Amount of TDS (tax deducted at source) for Decimal(13,4).
the Transaction.
Page 35
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 Description about the transaction shared by 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",
"JCB","ECRD","DINERS
CLUB","DSNV","CTBL","CVMS".

order_option_type Specify the payment option type for the order.String

Possible value for payment
option type is
OPTCASHC-Cash card
OPTCRDC -Credit Card
OPTDBCRD-Debit Card
OPTEMI-EMI
OPTIVRS-IVRS
OPTMOBP-MobilePayments
OPTNBK-Net Banking
error_desc Reasonifsearchcriteriadidnotfindtheorders for String
the 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 Total pages available based on no_of_records Example: no_of_records sent in

in the request request was 100
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"

Page 36
order_amt="1.0"
order_bank_response="Invalid Credentials"
order_bill_address="Room no 1101, near Railway station Ambad"
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="Room no 1101, near Railway station Ambad"
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 37
<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 Railway station 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 no 1101, near Railway station Ambad",
"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,

Page 38
"order_gtw_id":"SBI",
"order_bank_response":"Invalid Credentials",
"order_option_type":"OPTCRDC",
"order_device_type":"PC"
}],
"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.

Example STRING Response

Success Response: Format:

page_count|total_records|reference_no$order_no$order_amount$order_status$order_bank_ref_n
o$order_bank_response$order_card_name$order_currancy$order_date_time$order_delivery_detai
ls$order_device_type$order_fraud_status$order_gateway_id$order_ip$order_notes$order_option_
type$order_bill_name$order_bill_address$order_bill_city$order_bill_state$order_bill_country$orde
r_bill_zip$order_bill_tel$order_bill_email$order_ship_name$order_ship_address$order_ship_city$o
rder_ship_state$order_ship_county$order_ship_zip$order_ship_tel$order_ship_email$order_captu
re_amount$order_discount$order_gross_amount$order_fee_flat$order_fee_perc$order_fee_perc_ value^|

Example:
Successful Response:

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

Page 39
6. Pending Orders
PendingAPIcallallowsyoutofind the list of pendingorders. Only confirmed orders aresettled into the
merchant’s account. Anorder olderthan12 days is automatically canceled. Once anorder has been auto-
canceled by the system, it cannot be confirmed.
You can optionally confirm only part of an order. Remember, you can do so 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 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 inXML, JSONor Possible value for request_type is
(required) String. Specify the request type. “XML” or “JSON” or “STRING”.
response_type API returns responses in XML, JSON or String Possiblevalue for response_type is is
(optional) format. If left blank, the response will be in “XML” or “JSON” or “STRING”.
the same format as request.
Command Commandvalue 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) pending order of the transaction. characters(hyphen and
underscore)(30).
order_bill_name Nameof the customerto findinvoice details Alphanumeric with special character
(optional) after placing orders. (space, hyphen, apostrophe,
underscore, dot)(60).
order_email Email id of customer to send mail for the 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 “No Risk”
4) Value “GA” denotes “Go Ahead”
5) Value “NA” denotes “Not

Page 40
Applicable”
order_currency Currencyinwhichyouprocessed the String
(optional) transaction. You can send the multiple
currencies format. Example:
INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
EUR – Euro, official currency of
Eurozone

Multiple currency format:

INR|USD|GBP in XML & JSON
request type and INR$UDS$GBP in
STRING request type.
order_type Type of the order. String
(optional)
Different types of Orders:

1) OT-INV denotes“Invoice”
2) OT-ORD denotes “Orders”
3) OT-ORDSC denotes “Shopping
Cart Orders”
4) OT-PPAY denotes” Phone Pay”
5) OT-SNIP denotes “SNIP orders”
page_number A limited number of records are shared as part of Numeric(4)
(required) the response. The total records & number of
pages are shared as part of the response to
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>

Page 41
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_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 refer to the encryption section.

Example STRING Request Format:

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
If value of this parameter is “1” then you need API call wassuccessful.
not decrypt the enc_response as it will contain Value “1” denotes API call
plain error message. failure. On enc_response is plain
text represents the error
message.

enc_response AES encrypted response containing format as

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

Page 42
order_bill_address Order billing address details for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circularbrackets anddot)(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 Email Address of the 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’ pin code 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).
Captured amount can be full or partial of the
transaction amount.
order_curr Possible order Currency in which merchant String
processed the transaction. Examples
:
INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
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 Possible value for device type is
transaction was processed. IVRS/MOB/PC.
Page 43
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 Description about the transaction shared by 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",
"JCB","ECRD","DINERS
CLUB","DSNV","CTBL","CVMS".

Page 44
order_option_type Specify the payment option type for the order. String
Possible value for
payment option type is
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- Authorization Fraud
on reconciliation
TS-AUTFRAM- Amt mismatch
TS-AUTFRCM - Currency
mismatch
TS-AUTFRUT- Authorization
fraud
TS-ABRTBNK- Aborted at bank's

Page 45
end.

order_type Type of the order. String

Different types of Orders:
1) OT-INV denotes “Invoice”
2) OT-ORD denotes “Orders”
3) OT-ORDSC denotes “Shopping
Cart Orders”
4) OT-PPAY denotes”Phone
Pay”
5) OT-SNIP denotes “SNIP
orders”

order_ship_address Shipping Address for the order. Possible value for address is
Alphanumeric with special
characters (space, hyphen,
comma, ampersand(&), hash(#),
circularbrackets anddot)(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).

Page 46
order_ship_email Shipping emailID for the notificationsofthe Possible value for email id is
transaction. Alphanumeric with special
characters (hyphen, underscore,
dot, @)(70).
order_ship_name Shipping Name ofthe 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).

Page 47
order_status Status of the order. It can be single or String
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, both were successful
at bank's endbut we got
response for only one of them,
then next day during
reconciliation we mark one of
the transaction as auto
reversed )
Awaited (transaction is
processed from billing
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, 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
Systemrefund(Refunded by
CCAvenue for various findings 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.
Page 48
order_TDS Amount of TDS (tax deducted at source) for Decimal(13,4).
the Transaction.
reference_no Unique CCAvenue referenceno allocatedto Numeric(25).
the transaction.
error_desc Reason if searchcriteriadidnotfind the String
orders for the 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 Total pages available based on no_of_records Example: no_of_records sent in

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 no 1101, near Railway station Ambad"
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"
Page 49
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 be shipped"
order_risk_mitigation="Y"
order_ship_address="room no.701 near bus stand"
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",

Page 50
"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 Railway station 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.701 near bus stand",
"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":"",

Page 51
"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.

Example STRING Response

Success Response: Format:
page_count|total_records|reference_no$order_no$order_status$order_trans_status$order_type$o
rder_capt_amt$order_discount$order_fee_flat$order_fee_perc$order_fee_perc_value$order_gross
_amt$order_tax$days_left$order_bank_mid$order_bank_ref_no$order_bank_response$order_bill_
name$order_bill_email$order_bill_address$order_bill_city$order_bill_state$order_bill_country$ord
er_bill_tel$order_bill_zip$order_card_name$order_card_type$order_curr$order_date_time$order_
delivery_details$order_fraud_status$order_gtw_id$order_ip$order_misc_id$order_notes$order_ris
k_mitigation$order_ship_name$order_ship_email$order_ship_address$order_ship_city$order_ship
_state$order_ship_country$order_ship_tel$order_ship_zip$order_status_date_time^|

Example:
1|1|204000136232$66885810$Successful$TS-AUTC$OT-
ORD$0.0$0.0$0.0$4.0$0.04$1.0$0.0049$3$1234567890$289049$Approved$Shashi$xxxxxx.xx@xxxx
xx.xxxx$Room no 1101, near Railway station
Ambad$Indore$MP$India$1234567890$425001$Amex$Credit Card$INR$2015-04-13
10:59:05.517$$NA$PGT$192.168.2.182$$order will be shipped$Y$Chaplin$$room no.701 near bus
stand$Hyderabad$Andhra$India$1236547892$425001$2015-04-13 10:59:53.217|

Failure Response:

Format:page_no|total_no_of_records|error_code|error_desc|

Example: 0|0|51313|Order List: Invalid Parameter|

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

Page 52
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

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.

Page 53
Example STRING Request

Format:customer_id|

Example: 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

enc_response AES encrypted response containing format as

per response_type
deletion_status Delete status - specify whether customer is Numeric(1)
going to be deleted successfully or not. Possible values for this is 0 -
Deletion successful.
1 - Could not be deleted.
customer_id Unique Customer ID for the deleted customer. Numeric(25).
error_desc Reason if customer is 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”>

Page 54
<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.

Example STRING Response Success:

Format:deletion_status|customer_id|
Example: 0|123|

Failure:

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

Page 55
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

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"
}

Page 56
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 STRING Request

Format: customer_card_id|customer_id|

Example: 14|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

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 Customer card ID against the payment Numeric (25).
option for the transaction.
deletion_status Delete Status value specifies whether Possible values for this is 0 -
customer payment option is going to delete Deletion successful.
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

Merchant’s API Version 1.2 Implementation Guide 57

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="Customer CardId: 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 Card Id: Invalid Parameter",
"error_code":"51336"
}
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.
Example String Response Success:
Format: deletion_status|customer_card_id|customer_id|
Example:0|1234|24|

Merchant’s API Version 1.2 Implementation Guide 58

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 Unique CCAvenue access code
(required) which is generated when
merchant registered their IP
address. You must send this with
each request.
request_type API requests are accepted in Possible value for request_type is
(required) XML, JSON or String. Specify the “XML” or “JSON” or “STRING”.
request type.
response_type API returns responses inXML, Possible value for response_type is
(optional) JSON or String format. If left “XML” or “JSON” or “STRING”.
blank, the response willbe inthe
same format as request.
Command Command value specifies the API Possible value for this API call 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 Customercardissuer bank 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)

Merchant’s API Version 1.2 Implementation Guide 59

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-credit card
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"
}

Merchant’s API Version 1.2 Implementation Guide 60

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 STRING Request Format:

Example: 14|[email protected]|8698319931|subash yadav|421578965236545|mastercard|11/2015|Kotak

mahindra|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 that the API call
If value of this parameter is “1” then you need was successful.
not decrypt the enc_response as it will contain Value “1” denotes API call failure. On
plain error message. enc_response is plain text
representing the error 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 Customer card ID against the 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 - Deletion successful.
deleted successfully or not. 1 - Could not be deleted.
customer_card_no_last Last four digit of card no for the transaction. 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. Alphanumeric with special characters

ank (space, underscore )(70).

Merchant’s API Version 1.2 Implementation Guide 61

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.
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" 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>
Merchant’s API Version 1.2 Implementation Guide 62
<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 Card Id: Invalid Parameter",
"error_code":"51337",
"status":1
}

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

Example String Response Format:

Status|customer_id|customer_card_id|customer_card_no_last4digits|customer_card_expiry|custo
mer_pay_opt_type|customer_card_name|customer_card_issuer_bank|error_code|error_desc|
Merchant’s API Version 1.2 Implementation Guide 63
Failure:
Example:1|14||test user|1111|11/2015|OPTCRDC|Visa|HDFC|51337|Customer Id:Invalid
parameters|

Success:
Example:0|14|415|test user|1111|11/2015|OPTCRDC|Visa|HDFC|||

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 API call is used to list payment option saved for a customer. Payments options are
saved for a customer in vault for easy and convenient payment.

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 inXML, JSONor Possible value for request_type is
(required) String. Please specify the request type. “XML” or “JSON” or “STRING”.
response_type API returns responses in XML, JSON or String Possible value for response_type is is
(optional) format. If left blank, the response will be in the “XML” or “JSON” or “STRING”.
same format as request.
Command Commandvalue specifies the API calls. 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"

Merchant’s API Version 1.2 Implementation Guide 64

}
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 String Request

Format: customer_id|
Example: 6|

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 call
successful or not. If value of this was successful.
parameter is “1” then you need not Value “1” denotes API call failure. On
decryptthe enc_responseas it will enc_response is plain text represents
contain plain error message. the error message.

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 digit of card no for the Numeric(4)
transaction.
Will contain values only for Credit
Card and Debit Card.
customer_payopt_type Number of Payment options assign String.
against to this customer 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 Alphanumeric with special characters
transaction. (space, hyphen,apostrophe,
underscore, dot)(60).
customer_email Customer email id for the transaction. Alphanumeric with special characters
(hyphen, underscore, dot,@)(70).
customer_card_label Customer card label name for the Alphanumeric with special characters
transaction. (space, hyphen, apostrophe, underscore,
dot)(60).

Merchant’s API Version 1.2 Implementation Guide 65

customer_card_id Unique Customer Card ID is the Numeric(25).
identifier for the 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 Reason if API call does not find the String.
record based on given search criteria. 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>
Merchant’s API Version 1.2 Implementation Guide 66
<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":""
}

Merchant’s API Version 1.2 Implementation Guide 67

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.

Example STRING Response

Success:

Format: customer_card_id$customer_card_no(last four

digits)$customer_card_name$customer_card_type$customer_payopt_type$customer_card_label$custo
mer_email$customer_card_expiry$customer_card_issuing_bank^customer_card_id$customer_card_no( last four
digits$customer_card_name$customer_card_type$customer_payopt_type$customer_card_label$custo
mer_email$customer_card_expiry$customer_card_issuing_bank|

Example:27$”1234”$MasterCard$CRDC$OPTCRDC$”xxxx”$"[email protected]"^29$”4567”$MasterCard$ CRDC$
OPTCRDC$”xxxx”$"[email protected]"$”10/2020”$”xxxx”

Failure:

Format: error_code|error_desc|
Example: 51327|Customer id: Invalid Parameter|

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

Merchant’s API Version 1.2 Implementation Guide 68

11. Generate Invoice

The Invoice API call is used to generate an invoice for a customer. Values can be passed as for generating invoice
using the flexibility of Invoice settings.

Request Parameters

Name Description Note

enc_request AES encrypted request data
(required)
access_code Unique access code which is generated
(required) when merchant registered their IP
address. Youmustsendthis
with each request.
request_type API requests are accepted in XML, Possible value for request_type is
(required) JSON or String. Specify the request “XML” or “JSON” or “STRING”.
type.
response_type API returns responses in XML, JSON or Possible value for response_type is
(optional) String format. If left blank, the “XML” or “JSON” or “STRING”.
responsewillbeinthesame format
as request.
command Command value specifies the API calls. Possible value for this API call is
(required) Youmust sendthiswitheachrequest. “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 Duration for which the Invoice is valid Numeric(4).
(required)
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 – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
EUR – Euro, official currency of
Eurozone
merchant_reference_no Merchant identifier for the Invoice Alphanumeric with special
(optional) characters(hyphen and
Merchant’s API Version 1.2 Implementation Guide underscore)(25). 69
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).
sub_acc_id Unique Sub Account ID. String
(optional)
Amount Invoice Amount Decimal(12,2).
(required
terms_and_conditions Terms and conditions to be present in
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 Fees to be charged in case of late Decimal(12,2).
(conditional) payment.

Late_payment_fees is required if
merchant provide
late_payment_fees_type.
late_payment_fees_type Unit representation of Possible value for late payment
(conditional) late_payment_fees. fees type is Perc/Flat.

Late_payment_fees type is required if

merchant provide late_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 beappliediftheabove Decimal(12,2).
condition is true.

Discount value is required if merchant

provide discount type.
discount_type Unit representation of discount_value. Possible value for late payment
(conditional) fees type is Perc/Flat.
Discount type is required if merchant
provide discount value.
item_List Items associated with the Invoice. Item type array. Refer to Item_list
Merchant’s API Version 1.2 Implementation Guide
(conditional) section for structure. 70
Provide at least one Item if merchant
does not provide any Task.
task_List Tasks associated with the Invoice Tasktype array.RefertoTask_list
(conditional) section for structure.
Provide at least one Task if merchant
does not provide any Item.

Item_List:

Name Description Note

name Item Name Alphanumeric with special characters
(space, underscore, hyphen)(30).
description Item description Alphanumeric with special characters
(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 Alphanumeric with special characters
(space, underscore and hyphen)(30).
notes Notes for the task Alphanumeric with special characters
(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>
Merchant’s API Version 1.2 Implementation Guide 71
<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>

Merchant’s API Version 1.2 Implementation Guide 72

<terms_and_conditions>terms and condition</terms_and_conditions>
<sms_content>Pls pay your LegalEntity_Name bill # Invoice_ID for 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",
"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 pay your LegalEntity_Name bill # Invoice_ID for Invoice_Currency
Invoice_Amount online at Pay_Link."
} Merchant’s API Version 1.2 Implementation Guide 73

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.
String Request format:

Format:

Example:

abcd|INR|2|days|[email protected]|email subject|1234567890|term and condition|Pls call 022-2121212121 to

payyour LegalEntity_Name bill # Invoice_ID for Invoice_Currency Invoice_Amount or payonline at
Pay_Link.|MER123654|44785555654|4444545477878|sub1|ITEM$2$FIRST$1.00~Edu Tax$5.0$Pint
Tax$2.5|TASK$1.0$2$NEW~STG Tax$7.0$Rent Tax$8.0|||||||

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>

Merchant’s API Version 1.2 Implementation Guide 74

</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’s API Version 1.2 Implementation Guide 75

<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.

Json request string:

{
"customer_name": "abc",
"customer_email_id": "[email protected]",
"customer_email_subject": "Test",
"customer_mobile_no": "1234567890",
"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’s API Version 1.2 "123456987",
"merchant_reference_no": Implementation Guide 76
"merchant_reference_no1":123456987,
"merchant_reference_no2":123456987,
"sub_acc_id":"sub1",
"terms_and_conditions": "terms and condition",
"due_date": "3",
"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 pay your LegalEntity_Name bill # Invoice_ID for 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.
String Request format:

Format:

Example:

abcd|INR|2|days|[email protected]|email subject|1234567890|term and condition|Pls call 022-2121212121 to

payyour LegalEntity_Name bill # Invoice_ID for Invoice_Currency Invoice_Amount or payonline at
Pay_Link.|MER1234654|44785555654|4444545477878|sub1|ITEM$2$FIRST$1.00~Edu Tax$5.0$Pint
Tax$2.5|TASK$1.0$2$NEW~STG Tax$7.0$Rent Tax$8.0|1|2.5|Perc|1|1.50|Perc|

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>
Merchant’s API Version 1.2 Implementation Guide 77
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="Merchant reference number: Invalid Parameter"
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"

Merchant’s API Version 1.2 Implementation Guide 78

2.Failure

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

String Response: 1.Success

Format:invoice_status|invoice_id|qr_code|tiny_url merchant_reference_no l

Example:

0|5089334|iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAYAAACPgGwlAAAB6UlEQVR42u3dQW7DMAwEQP
3_08kXEpgr0tIs0EvRurHHgETKctdHrstyCaALdIEu0AW6QBfoAl2gC3SBLtAFukAXGIvG3To0KGPunkSmxF05KBD h35hyZYe-
9LHTMwxoEOHDv3Cjlyiu5VeHJnYhYMOHTr0jeg7S6fEurnHpaBDhw591H6xrtd-
KtmgQ4cOvWXfWQJx4tsqoEOHDv0lHbn0freqbps3UUCHDv1g9J3_wyV9I3kaFjp06J57l0GBDl2gC3SBLtAFukA
X6AJdoAt0gS7QBbpAF-gCHbpAF-
gCXaALdJmcLyERMkikhZ8LAAAAAElFTkSuQmCC|http://payit.cc/I5089334|123456789|

2.Failure

Format:invoice_status|error_code|error_desc|merchant_reference_no|

Example: 1|51323|Tax not configured for the merchant.|123456789|

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

Merchant’s API Version 1.2 Implementation Guide 79

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 access code for your application.
(required) You must send this with each request.
request_type API requests are acceptedinXML, JSONor Possible value for request_type is
(required) String. Specify the request type. “XML” or “JSON” or “STRING”.
response_type APIreturns response inXML, JSONor String Possiblevalue for response_type is is
(optional) format. If left blank, the response will be in “XML” or “JSON” or “STRING”.
the same format as request.
Command Commandvalue specifies the API calls.You Possible value for this API call is
(required) must send this with each request. “generateRecurringInvoice”
customer_name (required) Name of the customer receiving the Invoice Alphanumeric with special character
(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, space and
underscores)(100).
valid_for Duration for which the Invoice is valid Numeric(4).
(required)
valid_type The unit of duration represented by valid_for Possible values for valid type is
(required) minutes/hours/days/month/year
Currency Currency forwhichtheInvoice is to be String
(required) generated
Example:
INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
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
Page 80
terms_and_conditions Termsandconditionsto bepresentinthe AlphaNumeric with special
(optional) Invoice characters(hyphen, dot, circular
brackets and ampersand)(500)
customer_mobile_no Mobile number of the customer receiving the Numeric(10).
(required) Invoice
due_date Invoice Due date Numeric(3)
(required)
late_payment_fees Fees to be charged in case of late payment. Decimal(12,2).
(conditional)
Late_payment_fees is required if merchant
provide late_payment_fees_type.
late_payment_fees_typ e Unit representation of late_payment_fees. Possible value for late payment fees
(conditional) type is Perc/Flat.
Late_payment_fees type is required if
merchant provide late_payment_fees.
discount_if_paid_within Number of days prior to due date when an 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. Discount is applicable up to 11th
type. Jan 2014.
discount_value Discount to be applied if the abovecondition is Decimal(12,2).
(conditional) true.

Discount value is required if merchant provide

discount type.
discount_type Unit representation of discount_value. Possible value for late payment fees
(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 required if merchant provide
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. Item type array. Refer to Item_list
(conditional) section for structure.
Provide at least one Item if merchant does not
provide any Task.

Page 81
task_List Tasks associated with the Invoice Tasktype array.Referto Task_list
(conditional) section for structure.
Provide at least one Task if 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>

Page 82
</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": "STG Tax","amount": "7.0"},
{"name": "Rent Tax","amount": "8.0"}
]
}],

Page 83
"merchant_reference_no": "123456987",
"terms_and_conditions": "terms and condition",
"sms_content":"Pls pay your LegalEntity_Name bill # Invoice_ID for Invoice_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.

String Request format:

Format:

Example:

abcd|INR|2|days|[email protected]|email subject|9999999999|t&c|Pls call 022-2121212121 to pay your

LegalEntity_Name bill # Invoice_ID for Invoice_Currency Invoice_Amount or pay online at
Pay_Link.|MER1234|ITEM$2$FIRST$1.00~Edu Tax$5.0$Pint Tax$2.5|TASK$1.0$2$NEW~STG Tax$7.0$Rent
Tax$8.0|18-09-2014|Monthly|5|||||||

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>
Page 84
<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>

Page 85
<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": "STG Tax","amount": "7.0"},
{"name": "Rent Tax","amount": "8.0"}
],
}],
"merchant_reference_no": "123456987",
"terms_and_conditions": "terms and condition",
"due_date": "1",
Page 86
"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 pay your LegalEntity_Name bill # Invoice_ID for 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.

String Request format:

Format:

Example:

abcd|INR|2|days|[email protected]|email subject|9999999999|t and c|Pls call 022-2121212121 to pay your

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. You must send this with
each request.
request_type API requests are accepted in XML, Value is “XML” or “JSON” or
(required) JSON or String. Specify the request “STRING”.
type.
Page 87
response_type API returns XML, JSON or String Value is “XML” or “JSON” or
(optional) responses. If left blank, the response “STRING”.
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 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 characters
(required) sent (hyphen, underscore, dot, @)(70).
customer_email_subject Subject of the email containing the Alphanumeric with special characters
(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 beString
(required) generated
Example:
INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
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 Terms and conditions 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 Alphanumeric with special characters
(optional) type is SMS or BOTH Page 88
(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. Possiblevalue forbill delivery type is
(required) EMAIL/SMS/BOTH.
Files Attachments to be sent with the File type array described in below
(optional) quick invoice. Applicable only if bill table.
delivery type is EMAIL/BOTH.

Files:-

Name Description Note

Name Attachment file name which is passing at String
(required) generate invoice time. 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
(required) format decoded with decodeBase64 to 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>

Page 89

<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_Amount online 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-2121212121 to pay your LegalEntity_Name bill # Invoice_ID for
Invoice_Currency Invoice_Amount or pay online at Pay_Link.",
"files": [{
"name": "Test.doc",
"content": "77u/SGVsbG8gaW5kaWEK"
}]
}

Page 90

Example: xxxxxxx|INR|2|days|1.00|SMS|123456987|44785555654|4444545477878|sub1|terms and

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>

Page 91

2. Failure
<?xml version='1.0' encoding='UTF-8'?>
<Generate_Invoice_Result error_code="51072"
error_desc="Merchant reference number: Invalid Parameter"
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",

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

2.Failure

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

Page 92

String Response: 1.Success

Format:invoice_status|invoice_id|qr_code|tiny_url merchant_reference_no l

Example:
0|5089334|iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAYAAACPgGwlAAAB6UlEQVR42u3dQW7DMAwEQP
3_08kXEpgr0tIs0EvRurHHgETKctdHrstyCaALdIEu0AW6QBfoAl2gC3SBLtAFukAXGIvG3To0KGPunkSmxF05KBD h35hyZYe-
9LHTMwxoEOHDv3Cjlyiu5VeHJnYhYMOHTr0jeg7S6fEurnHpaBDhw591H6xrtd-
KtmgQ4cOvWXfWQJx4tsqoEOHDv0lHbn0freqbps3UUCHDv1g9J3_wyV9I3kaFjp06J57l0GBDl2gC3SBLtAFukA
X6AJdoAt0gS7QBbpAF-gCHbpAF-
gCXaALdJmcLyERMkikhZ8LAAAAAElFTkSuQmCC|http://payit.cc/I5089334|123456789|

2.Failure

Format:invoice_status|error_code|error_desc|merchant_reference_no|

Example: 1|51323|Tax not configured for the merchant.|123456789|

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

14.Get Item List

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

Request Parameters
For Invoice Items, end request data is not required. Merchant has to send the command , Access code ,
request_type and response_type parameters only.

Name Description value

Page 93
Request example: access_code=xxxxxxxxxxxxx&command=getInvoiceItems&request_type=xml&response_type=xml

Response Parameters

Name Description Note

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

enc_response AES encrypted response containing format as

per response_type
error_desc This Attribute contains the description of the Please refer below table for
failure request processing. When status is 1 then the failure message.
this attribute will generate the reason for failure.

error_code Error code for Failure reason. String

Please refer below table for
failure message.

item_List List of all item/task which is configured for Item List type array. Refer to
the merchant Item_Listsection for structure

Item List:

Name Description Note

description Descriptive information about the Item/task. Alphanumeric with special
characters (hyphen, dot, circular
brackets, space, comma ,
underscore, hash (#) and symbol
&)(60).
name Unique name of the Item/task for the Alphanumeric with special
generate invoice which is assigned against the characters (space, hyphen,
merchant id. apostrophe, underscore, dot)(60).
type Specify the item type provided. Possible values for item type are
ITEM/TASK.

94
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: No record found for given criteria.” 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”
}
95
Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the decryption
section.

Example STRING Response

Success:

Format: status|type$name$description^ type$name$description|

Example: 0|TASK$First Task$sgsdfgsfgsdfg^TASK$Second Task$Second task notes^TASK$test$test^ITEM$Second

Task$akshay^ITEM$test$test|

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) generated when merchants registered their IP
address. You must send this with each request.
request_type API requests are accepted inXML, JSONor Possible value for request_type is
(required) String. Specify the request type. “XML” or “JSON” or “STRING”.
response_type API returns response in XML, JSON or String Possiblevalue for response_typeis
(optional) format. If left blank, the response will be in the “XML” or “JSON” or “STRING”.
same format as request.
Command Commandvalue specifies the APIcalls. You Possible value for this API call is
(required) must send this with each request. “invoiceList”.
from_date Mandatory along with to_date if no other Date must be dd-mm-yyyy format.
(conditional) criteria mentioned
to_date Mandatory along with from_date if no other Date must be dd-mm-yyyy format.
(conditional) criteria mentioned

96
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 Unique identification of the merchant for 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).
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. The possible values 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>
<invoice_mobile_no>1234567890</invoice_mobile_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.

97
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.

String Format:

Example:11-10-2014|12-10-
2014|10.00|1.00|xxxx|1236547895|[email protected]|123654789|741258|45698741|task|FIRST|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.

98
Response Parameters
Name Description Note
status This states whether the call was successful or not. Value “0” denotes thatthe API
If value of this parameter is “1” then you need call wassuccessful.
not decrypt the enc_response as it will contain Value “1” denotes API call
plain error message. failure. On enc_response is
plaintext representing theerror
message.

enc_response AES encrypted response containing format 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 Email Address of the 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).

Page 99
order_bill_tel Order billing telephone no for the order. Numeric(10)
order_bill_zip Order billing address’ pin code 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)
Captured amount can be full or partial of the
transaction amount.
order_curr Possible order Currency in which merchant String Examples:
processed the transaction. INR – Indian Rupee
USD – United States Dollar
SGD – Singapore Dollar
GBP – Pound Sterling
EUR –Euro,official currencyof
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 Possible value for device type is
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).
Page
100
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 emailID for the notificationsofthe Possible value for email id is
transaction. Alphanumeric with special
characters (hyphen, underscore,
dot, @)(70).
order_ship_name Shipping Name 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).

Page
101
order_status Status of the order. It can be single or multiple. 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
response for only one of them,
then next day during
reconciliation we mark one of
the transaction as auto reversed
)
Awaited (transaction is
processed from billing 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, 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)
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.
Page
102
order_TDS Amount of TDS (tax deducted at source) for Decimal(13,4).
the Transaction.
reference_no Unique CCAvenue reference no for the Numeric(25).
transaction.
error_desc This Attribute contains the description of the Please refer below table for
failure request processing. When status is 1 then the failure message.
this attribute will generate the reason for failure.

error_code Error code for Failure reason. String

Please refer below table for
failure message.

page_count Total pages available based on no_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"

Page
103
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
104
}],
"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
}

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

Example STRING Response

String Format:

page_count|total_records|Invoice_Id$Invoice_ref_no$Invoice_Created_By$Order_No$Order_Type$Ord
er_Currency$Order_Amt$Order_Date_time$Order_Notes$
Order_Ip$Order_Status$$Order_Bank_Response$Order_Bank_Mid$Order_Bank_Ref_No$Order_Status_
Date_Time$Order_Fraud_Status$Order_Card_Name$Order_Card_Type
$Order_Gtw_Id$Order_Gross_Amt$Order_Discount$Order_Capt_Amt$Order_Fee_Flat$Order_Fee_Perc
$Order_Tax$Order_Delivery_Details$Order_Bill_Name$Order_Bill_Email$Order_Bill_Tel$Order_Bill_Add
ress$Order_Bill_City$Order_Bill_State$Order_Bill_Country$Order_Bill_Zip$Order_Ship_Name$Order_Sh
ip_Email$Order_Ship_Tel$Order_Ship_Address$Order_Ship_City$Order_Ship_State$Order_Ship_Countr
y$Order_Ship_Zip^|

Success:

1|1|xxxxxx$xxxxxxx$API$xxxxx$xx-xxx$xxxx$xx.xx$xxxx-xx-xx xx:xx:xx.xxx$$xxx.xxx.xxx.xxx$xxxx$xxx
xxx$xxxxxxx$xxxxxx$xxxx-xx-xx
xx:xx:xx.xxx$xx$xxxxxx$xxxx$xxxx$xx.xx$x.x$x.xx$x.x$xx.x$x.xxxx$$xxxx$xxxx@xxx.com$xxxxxxxx$xxx$xx
xx$xxxx$xxxx$xxxx$xxxx xxxx$$xxxxxxx$xxxxx xxxx$xxxxxx$xx$xxxxx$xxxxxx|
Failure:

page_count|total_records|error_code|error_desc|

0|0|51308|Order List: Invalid Parameter|

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

Page
106
16. Update Invoice Reference Number

Update Invoice reference Number API call is used to update Invoice reference number if the same was not
provided at the time of invoice generation.

Request Parameters:

Name Description value

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:

Page
107
{
"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.

String Format:

Format: Bill_id|merchant_reference_no|

Example: 123456|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

enc_response AES encrypted response containing format as

per response_type
error_desc Failure reason if update merchant reference Please referbelowtableforthe
number is not going to be updated successfully for failure message.
the generatedinvoice.

error_code Error code for Failure reason. String

Please refer below table for failure
message.

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

update merchant reference number.
“0” means update merchant
reference number was successful. “1”
means merchant reference
number was not successfully
updated.

Page
108
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"

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

String Format:

Success Format: update_status|

Example: 0|

Failure Format: update_status|error_code|error_desc|

Example: 1|51320|Bill Merchant Reference No: Invalid Parameter|

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

17. Update Merchant Params

Update Merchant params API is used to add some extra parameter against Reference no if the same could not be
done at the time of the transaction.

Request Parameters:

Name Description value

Page
110
param_value1 Merchant can update one param value against Alphanumeric with special
(optional) unique reference no after placing order. characters(comma, hyphen,
backslash and dot)(100)
param_value2 Merchant can update one param value against Alphanumeric with special
(optional) unique reference no after placing order. characters(comma, hyphen, backslash
and dot)(100)
param_value3 Merchant can update one param value against Alphanumeric with special
(optional) unique reference no after placing order. characters(comma, hyphen,
backslash and dot)(100).
param_value4 Merchant can update one param value against Alphanumeric with special
(optional) unique reference 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.

Example: 123456|10|11|22|33|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

enc_response AES encrypted response containing format as

per response_type
error_desc Failure reason if API call does 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”/>

Page
112
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":"Reference number: 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.

String Format:

Success Format: update_status|

Example: 0|

Failure Format: update_status|error_code|error_desc|

Example: 1|51322|Reference number: Invalid Parameter|

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

Page
113
18. Update Billing Details

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. You must send this with each
request.
request_type API requests are accepted in XML, JSON or Possible value for request_type is
(required) String. Specify the request type. “XML” or “JSON” or
“STRING”.
response_type API returns XML, JSON or String responses. If left Possible value for
(optional) blank, the response will be in the same response_type is “XML” or
format as request. “JSON” or “STRING”.
command Command value specifies the API Calls. You Possible value for this API call
(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).

Page
114
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.

String Format:

Example: 123456|bill name|[email protected]|santacruz(west)|mumbai|maharashtra|india|400054|

Page
115
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 This states whether the call was successful or not. Value “0” denotes thatthe API call
version for the API call. If value of this parameter is “1” then you need was successful.
not decrypt the enc_response as it will contain Value “1” denotes API call failure.
plain error message. On enc_response is plain text
represents the error message.

enc_response AES encrypted response containing format as

per response_type
error_desc Failure reason if billing details are not updated String
successfully. Please refer below table for failure
message.

error_code Error code for Failure reason. String

Please refer below table for failure
message.

update_status Update_status denotes whether Billing “0” means update billing details was
information have been updated successfully 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”/>

Page
116
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":"Reference number: Invalid Parameter",

"update_status":1,
} "error_code":"51316"

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

String Format:

Success Format: update_status|

Example: 0|

Failure Format: update_status|error_code|error_desc|

Example: 1|51316|Reference number: Invalid Parameter|

Note: You will have to decrypt the above response from “enc_response” parameter. Kindly refer to the
decryption section.421=Unsupported version for the API call.

19.Bin Details

Bin Details call is performed to fetch the card details of bin.

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 inXML, JSONor Possible value for request_type is
(required) String. Specify the request type. “XML” or “JSON” or “STRING”
response_type API returns responses in XML, JSON or String Possible value for response_type is
(optional) format. If left blank, the response will be in the “XML” or “JSON” or “STRING”
same format as the request.
Command Commandvalue specifies the API calls. You Possible value for this API call is
(required) must send this with each request. “binDetails”.
bin_number (required) First 6 digits of card number (Bin number). Numeric(6).

Page
118
Example XML Request

<bin_details_query>
<bin_number>464042</bin_number>
</bin_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

{'bin_number': '464042' }
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 STRING Request

Format: bin_number|

Example: 464042|

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 the value of this parameter is “1” then you was successful.
need not decrypttheenc_responseasit will Value “1” denotes API call failure. On
contain the plain error message. enc_response is plain text
representing the error message.

enc_response AES encrypted response containing the format

as per response_type.
bin_number Bin number that was sent in request. Numeric(6).

Page
119
card_name Name of the card of the selected Bin number. String
Possible values,
"Visa Debit Card",

"MasterCard Debit Card",

"Maestro Debit Card"",

"Amex",

"Diners Club",

"DISCOVER",

"JCB",

"MasterCard",

"Visa"
card_type Card type of the given bin number. String
Possible values:
“OPTDBCRD”,
“OPTCRDC”
payment_option Payment option for the card of the given bin String. Values
number :
OPTCRD-credit card
OPTDBCRD-debit card

issuing_bank Name of the bank that issue the card of the String
given bin number
country Country of the bank that issue the card of the String
given bin number

Note this parameter is available only in xml

and JSON response.
error_desc Reason if API call does not find the record String.
based on the given search criteria. Please refer below table for failure
message.
error_code Error code for Failure. String.
Please refer below table for failure
message.

Example XML Response

Success: Page
<?xml version='1.0' encoding='UTF-8'?> 120
<bin_details_Result>

<bin_number>464042</bin_number>

<card_name>Visa Debit Card</card_name>

<card_type>DBCRD</card_type>

<country>UNITED STATES</country>

<error_code></error_code>

<error_desc></error_desc>

<issuing_bank>FLAGSTAR BANK FSB</issuing_bank>

<payment_option>OPTDBCRD</payment_option>

</bin_details_Result>
Failure:
<?xml version='1.0' encoding='UTF-8'?>

<bin_details_Result>

<error_code>52026</error_code>

<error_desc>bin_number: Invalid Parameter</error_desc>

</bin_details_Result>

Example JSON
Response Success:

{"bin_details_Result":{
"issuing_bank":"FLAGSTAR BANK FSB",
"card_type":"DBCRD",
"bin_number":464042,
"payment_option":"OPTDBCRD",
"error_code":"UNITED STATES",
"card_name":"Visa Debit Card",
"country":"",
"error_desc":""
}
}

Failure:
Page
{"bin_details_Result":{
"error_code":52026, 121
"error_desc":"bin_number: Invalid
Parameter"
}
}

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

Example STRING

Response Success:

Example:
464042|Visa Debit Card|DBCRD|OPTDBCRD|FLAGSTAR BANK FSB||

Failure:
Example: |||||52026|bin_number: Invalid Parameter

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

20.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, JSON or Possible value for request_type is
(required) String. Specify the request type. “XML” or “JSON”
response_type API returns responses in XML, JSON or String Possible value for response_type is
(optional) format. If left blank, the response will be in the “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. “payIdDetails”. Page
pay_id (required) Provide the settlement Date to find the Numeric(25).
122
payouts list.
page_number (optional) 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.

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>

</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
}

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).

Page
123
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
Page
Chargeback
Refunded 124
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" Page
125
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>

Page
126
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",
Page
"txn_type":"Chargeback", 127
"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.

21.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

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

response_type Page
API returns responses in XML, JSON or String Possible value for response_type
(optional) format. If left blank, the response will be in the is “XML” or “JSON” 128
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. “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

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).

Page
settlement_date Date of settlement. Date in IST(dd-mm-yyyy129
)
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" Page
pay_Id="40907" 130
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,
Page
"trans_currency":"INR", 131
"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.

22. 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 Page
44EA2515401C2CD753DBA91BD0E7DFE7341BE1E7B7550&access_code=8JXENNSSBEZCU8KQ&command
132
= getRefundDetails&request_type=XML&response_type=XML&version=1.1
Request Parameters

Name Description Note

enc_request AES encrypted request data
(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 “STRING”.
JSON or String formats. Specify the
request type.
response_type API returns XML, JSON or String Value is “XML” or “JSON” or “STRING”.
(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)
(required) number for the transaction.

Example XML Request

<?xml version='1.0' ?>

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

Example JSON Request

{'reference_no':'123456789012'}

Example STRING Request

Format: reference_no|

Example: 123456789012|

Page
133
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
Page
reconciliation we mark one of the
134
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
Page
TS-REFD: Refund Declined
123

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", Page
"refund_issue_date":"2014-09-12 15:11:13.99",
123
"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":""
}

||203000111377|06333954|INR|10.00|Refunded|1.00$2014-09-12 15:11:07.877$$2014-09-12
15:12:07.77$2492$A1$TS-REFC^1.00$2014-09-12 15:11:13.99$$2014-09-12
15:12:10.413$2493$A2$TS-REFC|

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"
/>
Page
JSON Response: 123

{
"reference_no":"123456789012",
"order_no":"",
"order_amt":"",
"order_curr":"",
"order_status":"",
"error_desc":"Enc_request: No record found for given
criteria.", "error_code":"51419"
}
String Response:
Format:
error_code|error_desc|reference_no|order_no|order_curr|order_amt|order_status|refund_amt$refu
nd_
issue_date$refund_processed_on$refund_completion_date$refund_bank_ref_no$refund_mer_ref_no$r
ef und_status|

51419|Enc_request: No record found for given criteria.|123456789012||||||

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 “Ensure that access_code
Missing parameter is not blank.”
51404 Invalid Parameter Request Type: Invalid Parameter "Ensure that Request Type parameter
value is only XML/JSON/STRING."
51405 Invalid Parameter Response Type: Invalid Parameter "Ensure that Response Type parameter
value is only XML/JSON/STRING."
51407 Invalid Parameter Access_code: Invalid Parameter “You are not allowed to
perform this operation.”
51408 Missing Parameter Enc_request: Required parameter “Ensure that enc_request
missing parameter is not blank.”
51410 Invalid Parameter Command: Invalid Parameter “Ensurethatthecommandnameis not
invalid. Please refer API document for
valid command.”
51411 Invalid Parameter JSONrequest format: Invalid “Ensure that the JSON request format
Parameter format is not invalid. Please refer API
document for thePageAPI call.”
51412 Invalid Parameter XML request format: Invalid “Ensure that XML request format is not
123
Parameter format invalid. Please refer API document for
the API call.”
51413 Invalid Parameter STRING request format: Invalid “Ensure that STRING request format is
Parameter format not invalid. Please refer API document
for the API call.”
51419 Invalid Parameters Enc_request: No record found for “No records were found for given
given search
criteria. criteria.”
51420 Invalid Parameters Enc_request : Unable to process “Unable to process your request for
request the API call.”
51421 Invalid Parameter API version: Invalid Parameter “Please use only supported version for
the API call.”
-1 Invalid Parameter Enc_request: Invalid Request "Ensure that Request parameter is not
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 “Ensure that the Reference Confirm, Cancel, Refund,
parameter missing Number parameter is not Status,
blank.” UpdateBillingDetails,
UpdateMerchantPara
ms, InvoiceLookUp,
51002 Invalid Parameter Reference Number: Invalid “Ensure that the Reference Confirm, Cancel,
Parameter Number parameter is Refund, Status,
numeric.” OrderLookUp,
UpdateBillingDetails,
UpdateMerchantPara
ms, InvoiceLookUp,
GetPendingOrders
51003 Invalid Parameter Reference Number: Invalid “Ensure that the Reference Confirm, Cancel,
Parameter Number parameter does Refund, Status,
not exceed 25 OrderLookUp,
characters.” UpdateBillingDetails,
UpdateMerchantPara
ms, InvoiceLookUp,
GetPendingOrders
51004 Invalid Parameter Reference number/Order “Ensure that reference Status
Page
number: Invalid number/order number is
Parameter provided.” 139
51006 Missing Parameter Start/From Date: “Ensure that OrderLookUp
Required start/from date is
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.” ,
GenerateRecurringInv
oice, GenerateInvoice,
Order Lookup
51010 Invalid Parameter Mobile number: Invalid “Ensure that Mobile InvoiceLookUp,
Parameter number
parameter contains 10 GenerateQuickInvoice
digits.” ,
GenerateRecurringInv
oice,
GenerateInvoice,
GetPendingOrders,
OrderLookUp
51011 Missing Parameter Email id: Required “Ensure that Email id is GenerateQuickInvoice
parameter missing provided.” ,
GenerateRecurringInvoi
ce
51012 Invalid Parameter Email id: Invalid “Ensurethatonly letters, InvoiceLookUp,
Parameter numbers, hyphen, dot, one GenerateQuickInvoice
@ and underscore are ,
provided for Email id GenerateRecurringInv
parameter.” oice,
GetPendingOrders,
Order Lookup
51013 Invalid Parameter Email id: Invalid “Ensure that Email id InvoiceLookUp,
Parameter parameter does not GenerateQuickInvoice
exceed 70 characters.” ,
GenerateRecurringInvoi
ce, GetPendingOrders
51014 Missing Parameter Amount: Required “Ensure that Amount GenerateQuickInvoice
parameter missing parameter is not blank.” ,
GenerateRecurringInv
Page
oice, GenerateInvoice,
Refund
140 Order
51015 Invalid Parameter Amount: Invalid “Ensure that the Amount Confirm, Cancel,
Parameter parameter is in Decimal.” Refund, OrderLookUp,
InvoiceLookUp,
51017 Invalid Parameter Order Number: Invalid “Ensure only letters, Status,
Parameter numbers, hyphen GetPendingOrders,
and underscore are OrderLookUp
provided for Order
Number parameter.”
51018 Invalid Parameter Order Number: Invalid “Ensure that Order Status,
Parameter Number parameter GetPendingOrders,
does not exceed 30 OrderLookUp
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
amount

Page
141
Parameter parameter has Decimal
value."
51023 Missing Parameters Page Number: Required "Ensure that Order Lookup
Parameter missing Page Number
parameter is not
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 that Invoice Invoice Lookup
Parameter number parameter
does not exceed 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 “Ensure that Currency GenerateQuickInvoice,
parameter missing parameter is not blank.” GenerateRecurringInvoice,
GenerateInvoice
51033 Invalid Parameter Currency: Invalid “Ensure that Currency is GenerateQuickInvoice,
Parameter assigned to the GenerateRecurringInvoice,
Page
merchant.” GenerateInvoice
142
51034 Missing Parameter Valid for: Required “Ensurethat 'validfor' GenerateQuickInvoice,
parameter missing parameter is not blank.” GenerateRecurringInvoice,
GenerateInvoice
51035 Invalid Parameter Valid for: Invalid “Ensurethat 'valid for' GenerateQuickInvoice,
Parameter parameter is 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 “Ensurethatvaluefor bill GenerateQuickInvoice
Parameter delivery type parameter
is SMS/EMAIL.”
51041 Missing Parameter Name: Required parameter “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 “Ensure that Name UpdateBillingDetails,
parameter does not GenerateQuickInvoice,
exceed 60 characters.” GenerateRecurringInvoice,
PendingOrder
51044 Missing Parameter Address: Required “Ensure that Address UpdateBillingDetails
Page
parameter missing parameter is not blank.”
143
51045 Invalid Parameter Address: Invalid “Ensure only letters, UpdateBillingDetails
Parameter numbers, space, hyphen,
comma, ampersand, hash,
circularbrackets anddot are
provided for Address
parameter.”
51046 Invalid Parameter Address: Invalid “Ensure that Address UpdateBillingDetails
Parameter parameter does not
exceed 315 characters.”
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 “Ensure that City UpdateBillingDetails
parameter does not
exceed 30 characters.”
51050 Missing Parameter Zip/PIN code: 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 does not Page
exceed 15 144
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
provided for State
parameter.”
51055 Invalid Parameter State: Invalid Parameter “Ensure that State UpdateBillingDetails
parameter does not
exceed 30 characters.”
51056 Missing Parameter Country : Required “Ensure that UpdateBillingDetails
parameter missing Country Code
parameter is not
blank.”
51057 Invalid Parameter Country: Invalid Parameter “Ensure that only letters UpdateBillingDetails
and space are allowed for
Country Code
parameter.”
51058 Invalid Parameter Country: Invalid Parameter “Ensure that UpdateBillingDetails
Country Code
parameter does not
exceed 30
characters.”
51059 Missing Parameter Customer id: 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
Page customer
payment
145 option
51062 Missing Parameter Customer card id: “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 ption
Parameter provided for
Customer card id
parameter.”
51064 Invalid Parameter Customer card “Ensure that DeleteCustomerPaymentO
id: Invalid Customer card id ption
Parameter parameter does not
exceed 25

Page
146
characters.”
51065 Missing Parameter Parameter value: Required “Ensure that Merchant UpdateMerchantParams
parameter missing Params value is not blank.”
51066 Invalid Parameter Parameter value: Invalid “Ensure that UpdateMerchantParams
Parameter Alphanumeric, comma,
hyphen, backslash and
dot are
provided for parameters
Value.”
51067 Invalid Parameter Parameter value: Invalid “Ensure that Parameter UpdateMerchantParams
Parameter value does not exceed
100 characters.”
51068 Missing Parameter Bill id: Required parameter “Ensure that Bill id UpdateInvoiceReference
missing parameter is not blank.” Number,
Updatemerchantreferenc
enumbe r
51069 Invalid Parameter Bill id: Invalid Parameter “Ensure that Bill id UpdateInvoiceReference
parameter is a numeric Number,
value greater than InvoiceLookUp,
zero.” Updatemerchantreferen
cenumbe r
51070 Invalid Parameter Bill id: Invalid Parameter “Ensure that Bill id UpdateInvoiceReferenceN
parameter does not umber, InvoiceLookUp
exceed 25 characters.”
51071 Missing Parameter Merchant reference “Ensure that merchant UpdateInvoiceReferenceN
number: Required Reference Number is umber,
parameter missing notblank.”
51072 Invalid Parameter Merchant reference “Ensure that only letters, UpdateInvoiceReferenceN
number: Invalid numbers, hyphen and umber,
Parameter underscore are provided GenerateRecurringInvoi
for merchant Reference ce, GenerateInvoice
number parameter.”
Page
51073 Invalid Parameter Merchant reference “Ensure that Merchant UpdateInvoiceReferenceN
147
number: Invalid reference number umber,
Parameter parameter does not GenerateRecurringInvoi
exceed 25 characters.” ce, GenerateInvoice
51074 Missing Parameter SMS Content: Required “Ensure that GenerateRecurringInvoice,
parameter missing SMS Content GenerateInvoice
parameter is
not blank.”
51075 Missing Parameter SMS Content: Required “Ensure that 'Basic place GenerateRecurringInvoice,
parameter missing holders in SMS Content' GenerateInvoice
parameter is not blank.”
51076 Invalid Parameter SMS Content: Invalid “Ensure that SMS content GenerateRecurringInvoice,
Parameter parameter does not exceed GenerateInvoice
500 Characters.”
51077 Missing Parameter Email subject: Required “Ensure that GenerateQuickInvoice,
parameter missing Email Subject GenerateRecurringInvoice,
parameter is not GenerateInvoice
blank.”
51078 Invalid Parameter Email subject: Invalid “Ensure that Email GenerateQuickInvoice,
Parameter subject parameter GenerateRecurringInvoice,
contains only letters, GenerateInvoice
numbers, hyphens, dot,
space and underscores.”
51079 Invalid Parameter Email subject: Invalid “Ensure that Email GenerateQuickInvoice,
Parameter subject parameter GenerateRecurringInvoice,
does not exceed 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 does not
Parameter exceed 100
characters."
51082 Invalid Parameter File List: Invalid Page
“Ensurethatonlyonefile is GenerateQuickInvoice
Parameter attached in quick invoice.” 148
51083 Invalid Parameter File List: Invalid “Ensure that Attached File GenerateQuickInvoice
Parameter extension is (doc, jpg, jpeg,
docx, pdf, png).”
51084 Invalid Parameter File List: Invalid “Ensure that 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 “Ensure that Frequency GenerateRecurringInvoic
parameter missing parameter is not blank.” e
51089 Invalid Parameter Frequency : Invalid “Ensure that values for GenerateRecurringInvoic
Parameter frequency parameter e
are only
Daily/Monthly/Quarterly/
Yearly.”
51118 Missing Parameter Occurrences: Required “Ensure that Occurrences GenerateRecurringInvoic
parameter missing parameter is not blank.” e
51119 Invalid Parameter Occurrences: Invalid “Ensure that Occurrences GenerateRecurringInvoic
Parameter parameter is Numeric.” e
51120 Invalid Parameter Occurrences: Invalid “Ensure that Occurrences GenerateRecurringInvoic
Parameter parameter does not e
exceed 3 digits.”
51121 Invalid Parameter Occurrences: Invalid “Adding occurrences is GenerateRecurringInvoic
Parameter only applicable for e
recurring invoice.”
51122 Missing Parameter Task name: Required “Ensure that task name GenerateRecurringInvoice,
parameter missing parameter is not blank.” GenerateInvoice
51123 Invalid Parameter Task name: Invalid “Ensure that only GenerateRecurringInvoice,
Parameter letters, space, GenerateInvoice
Page
underscore and
149
hyphen are
provided for task name
parameter.”
51124 Invalid Parameter Task name: Invalid “Ensure that Task name GenerateRecurringInvoice,
Parameter parameter does not GenerateInvoice
exceed 30 Characters.”
51125 Missing Parameter Task Note: Required "Ensure that Task Note Generate Invoice
parameter missing parameter is not blank."
51126 Invalid Parameter Task note: Invalid “Ensure that Task note GenerateRecurringInvoice,
Parameter parameter contains GenerateInvoice
only letters, numbers,
hyphen, dot, circular
brackets, space, comma,
underscore, hash and
ampersand.”
51127 Invalid Parameter Task Note: Invalid "Ensure that Task Note Generate Invoice
Parameter parameter does not
exceed 60 characters."
51128 Missing Parameter Task rate: Required “Ensure that task rate GenerateRecurringInvoice,
parameter missing parameter is not blank.” GenerateInvoice
51129 Invalid Parameter Task rate: Invalid “Ensure that task rate GenerateRecurringInvoice,
Parameter parameter is decimal.” GenerateInvoice
51130 Missing Parameter Task hour: Required “Ensure that task hour GenerateRecurringInvoice,
parameter missing parameter is not blank.” GenerateInvoice
51131 Invalid Parameter Task hour: Invalid “Ensure that task hour GenerateRecurringInvoice,
Parameter parameter is numeric.” GenerateInvoice
51132 Invalid Parameter Task hour: Invalid “Ensure that task hour GenerateRecurringInvoice,
Parameter value does not exceed 4 GenerateInvoice
digits.”
51133 Missing Parameter Item name: Required “Ensure that item name GenerateRecurringInvoice,
parameter missing parameter is not blank.” GenerateInvoice
51134 Invalid Parameter Item name: Invalid “Ensure that only GenerateRecurringInvoice,
Parameter letters, space, GenerateInvoice
underscore and
hyphen are
provided for item name
parameter.”
51135 Invalid Parameter Item name: Invalid “Ensure that Item name Page
GenerateRecurringInvoice,
Parameter parameter does not GenerateInvoice
150
exceed 30 characters.”
51136 Missing Parameter Item description: “Ensure that item GenerateRecurringInvoice,
Required description parameter is GenerateInvoice
parameter not blank.”
missing
51137 Invalid Parameter Item description: Invalid “Ensure that Item GenerateRecurringInvoice,
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 GenerateRecurringInvoice,
Parameter description GenerateInvoice
parameter does not
exceed 60
characters.”
51139 Missing Parameter Item Quantity: Required “Ensure that the GenerateRecurringInvoice,
parameter missing item quantity GenerateInvoice
parameter is not
blank.”
51140 Invalid Parameter Item Quantity: Invalid “Ensurethat the Item GenerateRecurringInvoice,
Parameter Quantity parameter GenerateInvoice
is numeric.”
51141 Invalid Parameter Item Quantity: Invalid “Ensure that the Item GenerateRecurringInvoice,
Parameter Quantity parameter does GenerateInvoice
not exceed 3 digits.”
51142 Missing Parameter Unit cost: Required “Ensure that unit cost of GenerateRecurringInvoice,
parameter missing item is not blank.” GenerateInvoice
51143 Invalid Parameter Unit cost: Invalid “Ensure that the Unit GenerateRecurringInvoice,
Parameter cost of item parameter GenerateInvoice
is a Decimal Number.”
51144 Invalid Parameter Terms and “Ensure that Only letters, GenerateRecurringInvoice,
Conditions: Invalid numbers, hyphen,dot, GenerateInvoice
Parameter circularbracketsand
ampersand are provided Page
for Terms and Condition 151
parameter.”
51145 Invalid Parameter Terms and “Ensure that Terms and GenerateRecurringInvoice,
Conditions: Invalid Conditions parameter GenerateInvoice
Parameter does not exceed 500
characters.”
51146 Invalid Parameter Due date: Invalid “Ensure that Due date GenerateRecurringInvoice,
Parameter parameter is Numeric.” GenerateInvoice
51147 Invalid Parameter Due date: Invalid “Ensure that Due date GenerateRecurringInvoice,
Parameter parameter does not GenerateInvoice
exceed 3 digits”
51148 Invalid Parameter Due Date: Invalid “Ensure that due date GenerateRecurringInvoice,
Parameter parameter is provided GenerateInvoice
when late payment fees is
present.”
51149 Invalid Parameter Late payment “Ensure that late GenerateRecurringInvoice,
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 GenerateRecurringInvoice,
e_date: Invalid Parameter discount_if_paid_within_ GenerateInvoice
due_date parameter is
not greater than due
date.”
51151 Missing Parameter Discount Type: Required "Ensure that GenerateRecurringInvoice,
parameter missing discount type GenerateInvoice
parameter is
provided when
discount value is
present."
51152 Missing Parameter Discount value: Required "Ensure that GenerateRecurringInvoice,
parameter missing discount value GenerateInvoice
parameter is
provided when
discount type is
present."
51153 Missing Parameter Late payment fees type: "Ensure that late payment GenerateRecurringInvoice,
Required parameter fees type parameter is GenerateInvoice
missing provided when late
payment fees is present."
51154 Missing Parameter Late payment fees: "Ensure that late GenerateRecurringInvoice,
Required payment fees GenerateInvoice
parameter missing parameter is provided Page
when late payment 152
fees type is present."
51155 Invalid Parameter Discount value: Invalid "Ensure that GenerateRecurringInvoice,
Parameter Discount value GenerateInvoice
parameter
ranges are:
For percentage (1.00 -
99.99)
For flat (1.00-99999.99)"
51156 Invalid Parameter Late payment "Ensure that Late GenerateRecurringInvoice,
fees: Invalid payment fees GenerateInvoice
Parameter parameter ranges
are:

Page
153
For percentage (1.00 -
99.99)
For flat (1.00-99999.99)"
51157 Invalid Parameter Tax List:Invalid Parameter “Ensure that there are GenerateRecurringInvoice,
not more than two GenerateInvoice
taxes for one task.”
51158 Invalid Parameter Item/Task List: Invalid “Ensurethatat leastone GenerateRecurringInvoice,
Parameter task/item is added.” GenerateInvoice
51159 Invalid Parameter Task List: Invalid “Ensurethatthesame GenerateRecurringInvoice,
Parameter taskis not added GenerateInvoice
twice.”
51160 Invalid Parameter Item List: Invalid “Ensure that the same GenerateRecurringInvoice,
Parameter item is not added GenerateInvoice
twice.”
51161 Invalid Parameter Discount value: Invalid “Ensure that the GenerateRecurringInvoice,
Parameter Discount value GenerateInvoice
parameter is
Decimal.”
51162 Invalid Parameter Late payment “Ensure that Late GenerateRecurringInvoice,
fees: Invalid payment fees GenerateInvoice
Parameter parameter is
Decimal.”
51163 Invalid Parameter Discount type: Invalid “Ensure that values for GenerateRecurringInvoice,
Parameter Discount type GenerateInvoice
parameter are
Perc/Flat.”
51164 Invalid Parameter Late payment fees “Ensure that values for GenerateRecurringInvoice,
type: Invalid Late payment fees type GenerateInvoice
Parameter parameter are
Perc/Flat.”
51165 Invalid Parameter Discount if paidwithin “EnsurethatDiscount if GenerateRecurringInvoice,
due date: Invalid paidwithin due date GenerateInvoice
Page
Parameter parameter is Numeric.”
154
51166 Invalid Parameter Discount if paidwithin “Ensure that Discount if GenerateRecurringInvoice,
due date: Invalid paid within due date GenerateInvoice
Parameter parameter does not exceed
3 digits.”
51167 Invalid Parameter Tax List: Invalid Parameter “Ensure that the same GenerateRecurringInvoice,
tax is not added twice GenerateInvoice
for the same
task/item.”
51168 Invalid Parameter Tax List: Invalid Parameter "Ensure that there are not Generate Invoice
more
than two taxes
applicable for one item."
51169 Invalid Parameter Due Date: Invalid "Ensure that Due date Generate Recurring
Parameter cannot be greater than Invoice
valid for parameter."
51205 Invalid Parameter Order List: Invalid “Please provide at least Confirm, Cancel,
Parameter one order list.”
51206 Invalid Parameter Order List: Invalid “Ensure that Reference Confirm, Cancel,
Parameter Number parameter is
not repeated.”
51207 Invalid Parameter Start Date: Invalid “Ensure that Start date GenerateRecurringInvoic
Parameter is greater than or equal e
to current date.”
51208 Invalid Parameter Start Date: Invalid “Adding start date is only GenerateRecurringInvoic
Parameter applicable for recurring e
invoice.”
51209 Invalid Parameter Frequency: Invalid “Adding frequency is only GenerateRecurringInvoice,
Parameter applicable for recurring GenerateInvoice
invoice.”
51210 Invalid Parameters Invoice Setting: Invalid "Ensure that the Advance GenerateRecurringInvoice,
Parameter Settings option is GenerateInvoice
enabled under Invoice
Settings."
51211 Invalid Parameters Invoice Setting: Invalid "Ensure that SMS GenerateRecurringInvoice,
Parameter content is provided if GenerateInvoice
the same is enabled
under Invoice
Settings."
51212 Invalid Parameters Invoice Setting: Invalid "Ensure that the Adding GenerateRecurringInvoice,
Parameter Task option is enabled GenerateInvoice
under Invoice Settings."
51213 Invalid Parameters Invoice Setting: Invalid "Ensurethat the Adding Page
GenerateRecurringInvoice,
Parameter Itemoption is enabled GenerateInvoice
155
under Invoice Settings."
51214 Invalid Parameters Invoice Setting: Invalid "Ensure that the GenerateRecurringInvoice,
Parameter Changing Invoice GenerateInvoice
Validity option is
enabled under Invoice
Settings."
51215 Invalid Parameters Invoice Setting: Invalid "Ensure that Changing pre- GenerateRecurringInvoic
Parameter e,
populated values for GenerateInvoice
item: {e.g. abc} with unit
cost {e.g. 1.23} is enabled
under Invoice Settings."
51216 Invalid Parameters Invoice Setting: Invalid "Ensure that Changing GenerateRecurringInvoice
Parameter pre- populated values , GenerateInvoice
for task {e.g. def} with
unit rate {e.g. 1.00} is
enabled under Invoice
Settings."
51217 Invalid Parameters Invoice Setting: Invalid "Ensure that the GenerateRecurringInvoice
Parameter number of hours/rate , GenerateInvoice
amount for task is valid."
51218 Invalid Parameters Invoice Setting: Invalid "Ensure that unit cost GenerateRecurringInvoice
Parameter amount/quantity for , GenerateInvoice
item is valid."
51219 Invalid Parameters Invoice Setting: Invalid "Ensure that Quick GenerateRecurringInvoice
Parameter Invoice option is , GenerateInvoice
enabled under Invoice
Settings."
51226 Invalid Parameters SMS_Content: Invalid "Ensure that Basic GenerateRecurringInvoice
Parameter placeholders should , GenerateInvoice
not repeated in
SMS content."
51174 Missing Parameter Card expired "Ensure that Card Add customer payment
date: Required expired date option
parameter parameter is not
missing blank."
51175 Invalid Parameter Card expired "Ensure that Card Add customer payment
date: Invalid expired date option
Parameter parameter is in
MM/yyyy format."
51177 Missing Parameter Card Number: Required "Ensure that Pagepayment
Add customer
parameter missing Card Number option 156
parameter is
not blank."
51178 Invalid Parameter Card Number : Invalid "Ensure that Add customer payment
Parameter Card Number option
parameter is
Numeric only."
51179 Invalid Parameter Card Number: Invalid "Ensure that Add customer payment
Parameter Card Number option
parameter is
not invalid."
51180 Missing Parameter Card Name: Required "Ensure that Card Name Add customer payment
parameter missing parameter is not option
blank."

Page
157
51181 Invalid Parameter Card Name: Invalid "Ensure that Card Name Add customer payment
Parameter parameter is not invalid." option
51182 Invalid Parameter Name on card: Invalid "Ensure that only letters Add customer payment
Parameter and space 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 not exceed 30
characters."
51227 Missing Parameters Issuer Bank: Required “Ensure that Issuer bank Add customer payment
parameter missing name is not blank.” option
51228 Invalid Parameters Issuer Bank: Invalid "Ensure that only letters Add customer payment
parameter and space are provided option
for issuer bank
parameter."
51229 Missing Parameters Pament Option Type: "Ensure that payment Add customer payment
Required parameter option type is not blank." option
missing
51230 Invalid Parameters Payment Option "Ensure that payment Add customer payment
Type: Invalid option type is option
parameter OPTCRDC/OPTDBCRD."
51231 Missing Parameters Name on card: Required "Ensure that nameon Add customer payment
parameter missing cardis not blank" option
51232 Missing Parameters Card type: Required "Ensure that name on card Add customer payment
parameter missing type is 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 Page
Cancel
Parameter Cancelled:” 158
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 “No record was found for Refund, Status,
Parameter the given 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 “Multiple refunds are Refund
number: Invalid not allowed for the
Parameter gateway.”
51312 Invalid Parameter Reference "Cannotinitiaterefund 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 a disputed order. Refund,
number: Invalid You can refund only up to
Parameter {Currency}{Refund amount
Page
limit}.”
159
51316 Invalid Parameter Reference “Ensure that Reg Id or UpdateBillingDetails,
number: Invalid Reference No parameters
Parameter are not invalid.”
51317 Invalid Parameter Reference number: “Record already updated or UpdateBillingDetails
Invalid Invalid
Parameter Order Status.”
51318 Invalid Parameter Reference “Ensure that Order Status UpdateBillingDetails
number: Invalid OR Order Type
Parameter parameters are not
invalid.”
51319 Invalid Parameter bill_id: Invalid Parameter “Ensurethatbill_id UpdateInvoiceReference
parameterisnot 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 “Ensure that 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 Tax is GenerateInvoice
Parameter configured for the ,GenerateRecurringI
merchant." nvoice
51324 Invalid Parameter Tax List: Invalid “Ensure that Tax value GenerateInvoice
Parameter matches with the given ,GenerateRecurringI
Tax name.” nvoice
51325 Missing Parameter Customer id: Required “Ensure that Customer DeleteCustomer,
parameter missing parameter is present.”
51326 Invalid Parameter Currency: Invalid "Ensure that Currency is GenerateInvoice,
Parameter assigned to the GenerateRecurringInvoice,
merchant." GenerateQuickInvoice
51327 Invalid Parameter Customer id: Invalid "Ensure that the OrderLookup, Delete
Parameter merchantis not Customer
invalid."
51328 Invalid Parameter Reference "Multiple refunds not Page
RefundOrder
number: Invalid allowed." 160
Parameter
51336 Invalid Parameter Customer Card "Card Not Present." DeleteCustomer
Id: Invalid paymentoption
Parameter
51337 Invalid Parameters Customer Id:Invalid “Card Alreday Exists” Add Customer payment
parameters option

Lenze Manual Global Drive GDC - en
No ratings yet
Lenze Manual Global Drive GDC - en
25 pages
PayTabs API Documentation V 3.0
0% (3)
PayTabs API Documentation V 3.0
53 pages
UTG21-D Open Channel Flow Meter User Mannual
No ratings yet
UTG21-D Open Channel Flow Meter User Mannual
34 pages
Basic Dialer Management
100% (1)
Basic Dialer Management
15 pages
Basic Wallet Rollout - Paper
No ratings yet
Basic Wallet Rollout - Paper
12 pages
Java LP Solve
No ratings yet
Java LP Solve
5 pages
Elevator SJT-WVF5 Control System Commissioning and Maintenance Instruction
No ratings yet
Elevator SJT-WVF5 Control System Commissioning and Maintenance Instruction
183 pages
PostEx-COD API Integration Guide V4.1.9-1
No ratings yet
PostEx-COD API Integration Guide V4.1.9-1
33 pages
CCAvenue Integration - Ver 1.0
No ratings yet
CCAvenue Integration - Ver 1.0
29 pages
Steps To Integration
No ratings yet
Steps To Integration
4 pages
Cloud API A Clear and Concise Reference
From Everand
Cloud API A Clear and Concise Reference
Gerardus Blokdyk
No ratings yet
Bestbuy API
100% (1)
Bestbuy API
103 pages
Top 5 Payment Gateways in Saudi Arabia
No ratings yet
Top 5 Payment Gateways in Saudi Arabia
3 pages
EIPO Query API-V1.0.2
100% (1)
EIPO Query API-V1.0.2
8 pages
Sani Homam English
0% (1)
Sani Homam English
13 pages
Zen Wor x Case Study
No ratings yet
Zen Wor x Case Study
6,248 pages
Mobikwik Integration Guide
0% (1)
Mobikwik Integration Guide
36 pages
FAQs
No ratings yet
FAQs
5 pages
PayUMoney Technical Integration Document
100% (1)
PayUMoney Technical Integration Document
14 pages
Bulksms API Documentation: Created By: Netcore Solutions Pvt. LTD ©
No ratings yet
Bulksms API Documentation: Created By: Netcore Solutions Pvt. LTD ©
52 pages
Sahay GeM On CredAll Site
100% (1)
Sahay GeM On CredAll Site
12 pages
SOP - MCAPS ID Creation - Version 1
100% (1)
SOP - MCAPS ID Creation - Version 1
9 pages
Bkash Parameter - Requirement-9-10-2019
No ratings yet
Bkash Parameter - Requirement-9-10-2019
4 pages
PP WebsitePaymentsStandard IntegrationGuide PDF
No ratings yet
PP WebsitePaymentsStandard IntegrationGuide PDF
460 pages
CRDB Test Cases TPH v.1.3
No ratings yet
CRDB Test Cases TPH v.1.3
262 pages
Call Center Setup Proposal Home Kse
No ratings yet
Call Center Setup Proposal Home Kse
8 pages
Salesforce Extension Installation and Configuration Guide
No ratings yet
Salesforce Extension Installation and Configuration Guide
33 pages
Software Requirement Specification For Online Fashion Store
No ratings yet
Software Requirement Specification For Online Fashion Store
20 pages
Technical Account Manager or Support Delivery Manager or Account
No ratings yet
Technical Account Manager or Support Delivery Manager or Account
2 pages
Virtual Contact Center CRM API User Guide PDF
No ratings yet
Virtual Contact Center CRM API User Guide PDF
104 pages
Customer Request Form - Axis Bank
100% (1)
Customer Request Form - Axis Bank
2 pages
Developers Guide For Integrating BLUE DART API
No ratings yet
Developers Guide For Integrating BLUE DART API
65 pages
NPCI RFP - CRM & Chatbot Solution April 2018.pdf - Scope of Work
No ratings yet
NPCI RFP - CRM & Chatbot Solution April 2018.pdf - Scope of Work
9 pages
API TCH Doc CREDPay Direct
No ratings yet
API TCH Doc CREDPay Direct
12 pages
How To Mock Service Using SOAPUI
No ratings yet
How To Mock Service Using SOAPUI
27 pages
An Introduction To Rest Api: Presented By: Aniruddh Bhilvare 22 April, 2017
No ratings yet
An Introduction To Rest Api: Presented By: Aniruddh Bhilvare 22 April, 2017
26 pages
Emea Ros Pos Program Presentation Kit
No ratings yet
Emea Ros Pos Program Presentation Kit
19 pages
Ott Platform RFQ
No ratings yet
Ott Platform RFQ
38 pages
Agent Api
No ratings yet
Agent Api
18 pages
Case Study On Mobile Application Testing
No ratings yet
Case Study On Mobile Application Testing
3 pages
Marketplace App Development 7.16
No ratings yet
Marketplace App Development 7.16
50 pages
InstaBIZ 1
No ratings yet
InstaBIZ 1
14 pages
SAP GUI Hand Out
No ratings yet
SAP GUI Hand Out
41 pages
Re Self-Service Manual Refund Request
No ratings yet
Re Self-Service Manual Refund Request
1 page
Trak N Pay
No ratings yet
Trak N Pay
53 pages
One Pager Example
No ratings yet
One Pager Example
1 page
United Software Solution
No ratings yet
United Software Solution
5 pages
CRDB TestingPlan
No ratings yet
CRDB TestingPlan
2 pages
WhatsApp Inspo Guide FINAL
100% (1)
WhatsApp Inspo Guide FINAL
39 pages
MIS in ICICI Bank
100% (2)
MIS in ICICI Bank
3 pages
SOP: Bank Reconciliations: Stage I: Recording Bank Statements
No ratings yet
SOP: Bank Reconciliations: Stage I: Recording Bank Statements
3 pages
List of Escalation Matrix With TAT V 1 9
No ratings yet
List of Escalation Matrix With TAT V 1 9
5 pages
Agreement For Personal Power Loan: Asset Sales Centre
100% (1)
Agreement For Personal Power Loan: Asset Sales Centre
15 pages
BrowserStack Documentation
No ratings yet
BrowserStack Documentation
9 pages
2checkout Digital Commerce: The Only Commerce Solution You'll Ever Need For Selling Products or Services Online
100% (1)
2checkout Digital Commerce: The Only Commerce Solution You'll Ever Need For Selling Products or Services Online
11 pages
Specification Development of An Ecommerce Website
No ratings yet
Specification Development of An Ecommerce Website
9 pages
Upi Project
No ratings yet
Upi Project
26 pages
Ramachandhiran Anantharaman 03101984
No ratings yet
Ramachandhiran Anantharaman 03101984
1 page
Java Aws Devops Resume Template
0% (1)
Java Aws Devops Resume Template
4 pages
Debt Collection Recovery Management Sea Bank
No ratings yet
Debt Collection Recovery Management Sea Bank
4 pages
Comm Project Proposal
No ratings yet
Comm Project Proposal
2 pages
Prime Bank Limited: Implementation of Microsoft Dynamics CRM 2013
No ratings yet
Prime Bank Limited: Implementation of Microsoft Dynamics CRM 2013
83 pages
3 RD Milestone Changes
No ratings yet
3 RD Milestone Changes
4 pages
An Introduction To: Operating System For E-Commerce in Middle East, India and Southeast Asia
100% (3)
An Introduction To: Operating System For E-Commerce in Middle East, India and Southeast Asia
32 pages
Embitel Technologies (India) Private Limited
No ratings yet
Embitel Technologies (India) Private Limited
1 page
Issues
No ratings yet
Issues
1 page
TCs MAG 273 Test Case
No ratings yet
TCs MAG 273 Test Case
8 pages
How To Apply Work From Home
No ratings yet
How To Apply Work From Home
2 pages
How To Retrieve Password
No ratings yet
How To Retrieve Password
3 pages
How Can I Edit My Profile
No ratings yet
How Can I Edit My Profile
4 pages
HRMS Tool Quick Process Flow
No ratings yet
HRMS Tool Quick Process Flow
6 pages
Download
No ratings yet
Download
1 page
Motor Insurance - Two Wheeler Policy - Bundled: Certificate of Insurance Cum Policy Schedule - Endorsed
No ratings yet
Motor Insurance - Two Wheeler Policy - Bundled: Certificate of Insurance Cum Policy Schedule - Endorsed
2 pages
TCs BAP 34
No ratings yet
TCs BAP 34
33 pages
LIC Deduction
No ratings yet
LIC Deduction
1 page
SL No Emp Code Name Date of Birth Father Name Gender
No ratings yet
SL No Emp Code Name Date of Birth Father Name Gender
5 pages
Python Data Science - A Beginner's Guide To Mastering Analysis, Visualization, and Machine Learning by A. Eich Liana
No ratings yet
Python Data Science - A Beginner's Guide To Mastering Analysis, Visualization, and Machine Learning by A. Eich Liana
86 pages
I-Girder Bridge Superstructure
100% (2)
I-Girder Bridge Superstructure
13 pages
C Programming: Unit 3
No ratings yet
C Programming: Unit 3
28 pages
CS411 Quiz-1 by Vu Topper RM
No ratings yet
CS411 Quiz-1 by Vu Topper RM
58 pages
Self Test Questions
No ratings yet
Self Test Questions
46 pages
Calculating in Mathcad: Defining and Evaluating Variables
No ratings yet
Calculating in Mathcad: Defining and Evaluating Variables
30 pages
Internal Memory (RAM and ROM) User Guide
No ratings yet
Internal Memory (RAM and ROM) User Guide
58 pages
Baum 18 1st STN Pile Instructions tp10313
No ratings yet
Baum 18 1st STN Pile Instructions tp10313
50 pages
232 CO1027 Assignment Sherlock (EN Version)
No ratings yet
232 CO1027 Assignment Sherlock (EN Version)
25 pages
CC
No ratings yet
CC
302 pages
Module
No ratings yet
Module
19 pages
Racket Guide
100% (1)
Racket Guide
336 pages
Artificial Intelligence
No ratings yet
Artificial Intelligence
42 pages
JESD216
No ratings yet
JESD216
26 pages
Lock Met30+ Manual
No ratings yet
Lock Met30+ Manual
64 pages
En Subject PDF
No ratings yet
En Subject PDF
13 pages
Abap
No ratings yet
Abap
69 pages
Signal&Systems - Lab Manual - 2021-1
No ratings yet
Signal&Systems - Lab Manual - 2021-1
121 pages
Chapter 13 M-Files
No ratings yet
Chapter 13 M-Files
30 pages
hp42s QRG en PDF
No ratings yet
hp42s QRG en PDF
20 pages
Quick Reference - Ultrasonic Testing
No ratings yet
Quick Reference - Ultrasonic Testing
6 pages
Using Impact GX49-61 With Nektar DAW Integration
No ratings yet
Using Impact GX49-61 With Nektar DAW Integration
25 pages
CS-SQP-Set 2-Ranchi
No ratings yet
CS-SQP-Set 2-Ranchi
9 pages
Concrete For Starters
No ratings yet
Concrete For Starters
38 pages
Datateach - Ai Python Cheat Sheet
No ratings yet
Datateach - Ai Python Cheat Sheet
16 pages
CSC Assignment
No ratings yet
CSC Assignment
2 pages