Upload
pankajh
View
224
Download
0
Embed Size (px)
Citation preview
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 1/30
EBS- Direct link Integration Guide
E - B i l l i n g
S o l u t i o n s P v t
L t d
E - B i l l i n g
S o l u t i o
n s P v t L t d
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 2/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 2 of 3
Table of Contents
1. INTRODUCTION ........................................................................................................... 3
2. PRE-REQUISITE .......................................................................................................... 3
3. ENVIRONMENT DETAILS ............................................................................................... 3i. Cred ent ials to tes t th e payment .............................................................................. 3
ii. Paym ent Reques t URL : ........................................................................................... 3
iii . Merch ant Lo gi n URL ................................................................................................ 3
iv . API Reques t URL ...................................................................................................... 3
4. SALE PROCESS FLOW .................................................................................................. 4
5. INTERNA L STATUS FLOW ............................................................................................ 5
6. MERCHANT WEBSITE INTEGRATION .......................................................................... 6
i. HTML Code Sni pp et ...................................................... Error! Bookmark not defined.
ii. Sample HTML fo rm .................................................................................................. 7
iii . Reques t Parameter Detai ls ..................................................................................... 8
iv . Paym ent Respo ns e ................................................................................................. 9
v. Paym ent Resp on se Param eter s ............................................................................. 9
7 . API Act io ns ..................................................................................................................11
i. Pre-requi si tes ...........................................................................................................11
ii. Pro ces s Flow w ith HTTP Info rm atio n ......................................................................11
iii . HTTP Stat us Codes ..................................................................................................11
iv . Reques t an d Respo ns e ..........................................................................................12
v. Tes ti ng th e API .......................................................................................................12
vi . Tran sac ti on A PI Act io ns ........................................................................................12
vi i . Invoice API Actions – Web & IVR ..........................................................................17
vi ii. Inv oi ce AP I Er ro r Cod es: .......................................................................................21
APPENDIX A – SECURE HASH VALIDA TION ..................................................................22
APPENDIX B – SETTLEMENT CYCL E ..............................................................................23
APPENDIX C – ISO3 Cou nt ry Name .................................................................................24
APPENDIX D –
PCI DSS COMPL IANCE ...........................................................................27
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 3/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 3 of 3
1. INTRODUCTION
This document works as a guide for Merchants on understanding the EBS payment gateway DirectIntegration. This integration will allow the Merchant to have the Payment option Selection and Credit
card details capture on the Merchant website itself.
2. PRE-REQUISITE
For capturing Credit card details on the Merchant website, the Merchant application should be incompliance to PCI DSS. For more details on PCI DSS, please refer Appendix D.
EBS should enable the Option for Merchant to capture Credit card data.
3. ENVIRONMENT DETAILS
We recommend you to make your Integration on Test Environment before going Live in the Production
environment.
Our Test environment works in similar way to the Production Environment, except that you can test onlyCredit Card payments using the Test card details provided.
To test the payments in Test mode, send the mode as TEST in payment request.
i. Credentials to test the payment
Card Number – 4111111111111111Expiry – 07/16CVV – 123
Bank – EBS
ii. Payment Request URL:
Test – https://testing.secure.ebs.in/pg/ma/sale/directProduction – https://secure.ebs.in/pg/ma/sale/direct
iii. Merchant Login URL
Test – https://testing.secure.ebs.inProduction – https://secure.ebs.in
iv. API Request URL
Test – https://testing.secure.ebs.in/api/1_0Production – https://secure.ebs.in/api/1_0
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 4/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 4 of 3
4. SALE PROCESS FLOW
Customer selects to check out on the Merchant Website.
Customer Selects Payment Method (Credit Card, Debit Card, Netbanking, Cash Card) and
Payment option on the Merchant Website. If the Customer selected Credit or Debit cards, he will
be asked to provide Credit card number.
Merchant will redirect the Customer to EBS along with the Credit card information and Billing
details.
Customer is redirected to Bank for processing
EBS redirect the Customer back to Merchant website with the transaction status after
confirmation from bank.
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 5/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 5 of 3
5. INTERNAL STATUS FLOW
Status Details:
I. Authorized Payments – Payments which are completed successfully
II Flagged Payments – Payments which are completed are successfully and areflagged by Fraud Screening System. These payments will be reviewed manually byEBS internal team and unflagged.
III Captured Payments captured by the Merchant.
IV Refund Payments refunded by the Merchant to the Customer.
V Charge Back Payments which are refunded forcefully by EBS for any
complaints raised by the Customer with the Card provider or Card Brands.
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 6/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 6 of 3
6. MERCHANT WEBSITE INTEGRATION
Basic concept of EBS Integration: Place the HTML Code snippet on the Payment page Post the transaction parameters to EBS Parse the response received from EBS
i. HTML Code snippet
Code snippet to be placed on the Payment page
In the following code, "<UniqueSessionId>" must be replaced with unique session identifier whichshould be generated in MD5 format by Merchant.
<aid> will be provided by EBS.
<script type="text/javascript">
(function() {var rd = document.createElement('script'); rd.type = 'text/javascript'; rd.async = true;rd.src = ('https:' == document.location.protocol ? 'https://' : 'http://')+ 'elistva.com/api/script.js?'+ 'aid=<aid>&sid=<UniqueSessionId>';var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(rd, s);
})();</script>
<noscript><p style="background:url(//elistva.com/api/assets/clear.png?aid=<aid>&sid=<UniqueSessionId>)"></p></noscript>
<object type="application/x-shockwave-flash" data="//elistva.com/api/udid.swf?aid =<aid>&sid =<UniqueSessionId>" width="1" height="1"><param name="movie" value="//elistva.com/api/udid.swf?aid=<aid>&sid=<UniqueSessionId>" />
</object>
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 7/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 7 of 3
ii. Sample HTML form
The link between Merchant website and EBS Payment page has to be maintained on the last page ofthe shopping basket on Merchant website.
Sample HTML form:
<form action="https://testing.secure.ebs.in/pg/ma/sale/direct" method="post" /><input name="vpc_AccountId" type="text" value="" /><input name="vpc_SessionId" type="text" value="" /><input name="vpc_ReferenceNo" type="text" value="" /><input name="vpc_Amount" type="text" value="" /><input name="vpc_Description" type="text" value="" /><input name="vpc_Name" type="text" value="" /><input name="vpc_Address" type="text" value="" /><input name="vpc_City" type="text" value="" />
<input name="vpc_State" type="text" value="" /><input name="vpc_PostalCode" type="text" value="" /><input name="vpc_Country" type="text" value="" /><input name="vpc_Email" type="text" value="" /><input name="vpc_Phone" type="text" value="" /><input name="vpc_ShipName" type="text" value="" /><input name="vpc_ShipAddress" type="text" value="" /><input name="vpc_ShipCity" type="text" value="" /><input name="vpc_ShipState" type="text" value="" /><input name="vpc_ShipPostalCode" type="text" value="" /><input name="vpc_ShipCountry" type="text" value="" /><input name="vpc_PaymentOption" type="text" value="" /><input name="vpc_CardNo" type="text" value="" />
<input name="vpc_ExpiryDate" type="text" size="4" value="" /><input name="vpc_Cvv" type="text" value="" /><input name="vpc_Issuingbank" type="text" value="" /><input name="vpc_ReturnUrl" type="text" value="" /><input name="vpc_GoBackUrl" type="text" value="" /><input name="vpc_Mode" type="text" value="" /><input type="hidden" name="vpc_SecureHash" value=""/><input name="submitted" value="Submit" type="submit" /></form>
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 8/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 8 of 3
iii. Request Parameter Details
Parameter Description Type Min Max Mandatory
vpc_AccountId Your Account ID numeric - - YESvpc_SessionId Unique Session ID for the
payment. Should be same assent in HTML code snippet
Alphanumeric(md5 string)
32 32 YES
vpc_ReferenceNo Your Reference Number char 1 20 YESvpc_Amount Total Sale Amount decimal 1 14,2 YESvpc_Mode Mode of the LIVE => live,
TEST => testchar LIVE /
TESTLIVE /TEST
YES
vpc_Description Detail description of the sale char 1 255 YESvpc_ReturnUrl Return back after transaction
is completedchar 1 255 YES
vpc_GoBackUrl This is the url wherecardholder will be redirectedwhen the chosen paymentoption is not available. If its
empty, cardholder will beredirected to the primaryregistered domain.
char 1 255 NO
vpc_Name Customer billing Name char 1 128 YESvpc_Address Customer billing address char 1 255 YESvpc_City Customer billing city char 1 32 YESvpc_State Customer billing state char 1 32 YESvpc_Country Customer billing country.[3
Digit country code]char 3 3 YES
vpc_PostalCode Customer billing postal code char 1 10 YESvpc_Phone Customer billing phone char 5 20 YESvpc_Email Customer billing email char 1 100 YES
vpc_ShipName Customer delivery Name char 1 255 YESvpc_ShipAddress Customer delivery address char 1 255 YESvpc_ShipCity Customer delivery city char 1 32 YESvpc_ShipState Customer delivery state char 1 32 YESvpc_ShipCountry Customer delivery country[3
Digit country code]char 3 3 YES
vpc_ShipPostalCode Customer delivery postal code char 1 10 YESvpc_PaymentOption Payment option code
provided by EBSchar 1 5 YES
vpc_CardNo Credit card number numeric 13 19 YES, IfPayment_Optionis credit/debit
vpc_ExpiryDate Expiry date of the credit card.
[Format: MMYY]
numeric
4
4 YES, If
Payment_Optionis credit/debit
vpc_Cvv CVV number of the creditcard
numeric 3 4 YES, IfPayment_Optionis credit/debit
vpc_Issuingbank Credit card Issued bank name char 2 20 Optionalvpc_SecureHash Hash value calculated –
Refer Appendix Achar 32 32 YES
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 9/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 9 of 3
iv. Payment Response
The response parameters given back to the return URL are listed below. The response is provided
using POST method to the URL defined under vpc_ReturnURL parameter in the payment request.
v. Payment Response Parameters
Response in case all the validations are passed
SNO Parameter Description
1 vpc_SecureHash MD5 Hash value of all the response parameters,
2 vpc_ResponseCode Response Code which gives the status of the transaction.0 (Zero) for success and for other value, Failed.
3 vpc_IsFlagged Either YES/NO. YES denotes that its under review.
4 vpc_ResponseMessage Response Message which tells about the Response Code5 vpc_Address CardHolder Billing Address
6 vpc_Amount Sales Amount of the transaction
7 vpc_City CardHolder Billing City
8 vpc_Country CardHolder Billing Country
9 vpc_DateCreated DateTime of the transaction
10 vpc_Email CardHolder Email Id
11 vpc_Mode Mode of Transaction done - TEST/LIVE
12 vpc_Name CardHolder Billing Name
13 vpc_PaymentId Unique Payment Id given for all the payments by EBS
14 vpc_Phone CardHolder Contact Number 15 vpc_PostalCode CardHolder Postal Code
16 vpc_ReferenceNo Provided by Merchant to identify the transaction
17 vpc_ShipAddress Shipping Address
18 vpc_ShipCity Shipping City
19 vpc_ShipCountry Shipping Country
20 vpc_ShipName Person Name, to whom its shipped
21 vpc_ShipPostalCode Shipping Postal Code
22 vpc_ShipState Shipping state
23 vpc_TransactionId A Unique Id given for identifying the transaction.
24 vpc_AccountId Your Account ID25 vpc_PaymentOption Payment option code provided by EBS
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 10/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 10 of
Response in case validations fail
SNO1 vpc_SecureHash MD5 hash of all the parameters with your EBS
secret key.
2 vpc_Error Error Message3 vpc_ResponseCode Response code for the error (2)
Recommended validation in the response file to avoid duplication of records in your backend
Pass your orderid in the vpc_ReferenceNo parameter and in response, check whethervpc_ReferenceNo and your orderid matches.
Check the amount of the order and the " vpc_Amount" parameter in the response isequal
If both the conditions results as true, insert order in your backend, which nullifies theduplications.
ResponseMessage Values:
Transaction Successful
Transaction Failed
Invalid parameters:Invalid Account ID / VPC is not enabled for the account
Invalid SecureHash
Amount can not be less than 1
Invalid Payment Option
Invalid payment request
Invalid mode selected
Selected payment method is NOT available now
Invalid Response
Bank Declined Transaction
3D Secure Authentication failed
Denied By Risk
Insufficient funds
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 11/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 11 of
7. BACKEND OPERATIONS
EBS API is the interface which enables to interact with EBS Server remotely, to perform actions onthe transactions. The document describes the API operations which can be performed remotely onthe EBS transactions along with providing sample codes.
i. API Actions
getCurrencyValue
status
statusByRef capture cancel refund Invoice - create Invoice – get
vi. Pre-requisites
The Merchant should have the following to make use of this Transaction API and they arelisted below:
An Account with EBS Unique EBS Account ID Secret Key
vii. Process Flow with HTTP Information
The request for accessing any of the API/actions should use POST HTTP and the response willbe XML.
viii. HTTP Status Codes
HTTP Status codes are a numerical code denoting the status of a client request response. The EBS API attempts to return appropriate HTTP status codes for every request. Here's what you shouldexpect:
200 OK: Everything went well. 400 Bad Request: There was something wrong with your request, an error
message will tell you what the problem was.
401 Not Authorized: The authentication credentials you provided are invalid. 403 Forbidden: You're attempting to access something that you're not authorized
to access.
404 Not Found: The resource you're requesting could not be found. 500 Internal Server Error: An error occurred, an error message will tell you
what the problem was.
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 12/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 12 of
ix. Request and Response
In general, most API actions take a combination of required and optional parameters. The EBStransaction API has those combinations of which are explained in detail below, based on theaction.
The request is the set of parameters that should be posted to EBS secure server.
The response is received as XML based on which the Merchant can take other appropriate action.
x. Testing the API
You can test the API simply by using a web browser. Firefox is recommended to get decentformatting of the XML returned.
xi. Transaction API Actions
a. Action: getCurrencyValue
This API can be used to make a remote call to get the approx imate equi va lentva lue of an INR for the requested cu rrency . The supported currencies are USD, GBP, EUR.
URL https://testing.secure.ebs.in/api/1_0
Methods POST
Action getCurrencyValue
Mandatory
Parameters
Action : getCurrencyValue
Currency: Your request currency. Can be either of USD,GBP, EUR
AccountID : Your EBS AccountId
SecretKey: Your EBS SecretKey
Sample HTML Code for getCurrencyValue.
<form method="POST" action=" https://testing.secure.ebs.in/api/1_0" name="frmTransaction">
<input name="Action" type="hidden" value="getCurrencyValue" /><input name="Currency" type="hidden" value="XXXX" /><input name="AccountID" type="hidden" value="XXXX" /><input name="SecretKey" type="hidden" value="XXXXXX" /><input name="submitted" value="Submit" type="submit">
</form >
Example response:<?xml version='1.0' encoding='UTF-8'?>
<output Currency="USD" Value="0.02131" Description=" 1 INR => 0.02131 USD"/>
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 13/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 13 of
b. Action:status
This API can be used to get the transaction details corresponding to the Transaction Id & PaymentId passed. This gives back the amount, date time, mode, reference no, transaction type, status andflagged status corresponding to the transaction id and payment id.
URL https://testing.secure.ebs.in/api/1_0
Methods POST
Action Status
Parameters
Action : Status
TransactionID : EBS Transaction ID
SecretKey : Your EBS Secret Key
AccountID : Your unique EBS Account ID
PaymentID : Unique ID generated for the payment by EBS.
Sample HTML Code for status.
<form method="POST" action="https://testing.secure.ebs.in/api/1_0" name="frmTransaction">
<input name="Action" type="hidden" value="Status" /><input name="TransactionID" type="hidden" value="XXXX" /><input name="SecretKey" type="hidden" value="XXXXXX" /><input name="AccountID" type="hidden" value="XXXX" />
<input name="PaymentID" type="hidden" value="XXXXX" /><input name="submitted" value="Submit" type="submit">
</form >
Example response:<?xml version='1.0' encoding='UTF-8'?>
<output transactionId="2144154" paymentId="1112034" amount="1" dateTime="2010-07-3116:59:28" mode="TEST" referenceNo="223" transactionType="Authorized" status="Processed"isFlagged="NO"/>
c. Action:statusByRef
This API is similar to Status API to get the transaction details. Unlike status API, statusByRef API getthe transaction details by Merchant Reference Number.
URL https://testing.secure.ebs.in/api/1_0
Methods POST
Action statusByRef
MandatoryParameters
Action : statusByRef
AccountID : Your allocated EBS Account ID
SecretKey : Your allocated EBS Secret Key
RefNo : Merchant Reference number corresponding to the transaction
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 14/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 14 of
Sample HTML Code for statusByRef.
<form method="POST" action=" https://testing.secure.ebs.in/api/1_0" name="frmTransaction"><input name="Action" type="hidden" value="statusByRef">
<input name="AccountID" type="hidden" value="XXXX"><input name="SecretKey" type="hidden" value="XXXXXX"><input name="RefNo" type="hidden" value="XXXXX">
<input name="submitted" value="Submit" type="submit"></form >
Example response:<?xml version='1.0' encoding='UTF-8'?>
<output transactionId="2144154" paymentId="1112034" amount="1" dateTime="2010-07-31 16:59:28" mode="TEST" referenceNo="223" transactionType="Authorized"status="Processed" isFlagged="NO"/>
d. Action:capture
This API can be used to make remote API call to capture the transaction. The amount provided inthe request should be equal to the amount of transaction else you receive corresponding error asresponse.
URL https://testing.secure.ebs.in/api/1_0
Methods POST
Action capture
MandatoryParameters
Action : capture
AccountID : Your allocated EBS Account ID
SecretKey : Your allocated EBS Secret Key
Amount : Amount to be captured
Payment ID: Unique ID generated by EBS for identifying the payment
Sample HTML Code for Capture.
<form method="POST" action="https://testing.secure.ebs.in/api/1_0" name="frmTransaction"><input name="Action" type="hidden" value="capture">
<input name="AccountID" type="hidden" value="XXXX"><input name="SecretKey" type="hidden" value="XXXXXX"><input name="Amount" type="hidden" value="XXXXX"><input name=" PaymentID" type="hidden" value="XXXXX"><input name="submitted" value="Submit" type="submit">
</form >
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 15/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 15 of
Example response:<?xml version='1.0' encoding='UTF-8'?>
<output transactionId="2690686" paymentId="1399586" amount="0.5" dateTime="2010-10-06 17:39:38" mode="TEST" refrenceNo="223" transactionType="Captured"status="Processing"/>
e. Action:cancel
This API can be used to make remote API call to cancel the transaction. The amount provided in therequest should be equal to the amount of transaction else you receive corresponding error asresponse.
URL https://testing.secure.ebs.in/api/1_0
Methods POST
Action Cancel
MandatoryParameters
Action : cancel
AccountID : Your allocated EBS Account ID
SecretKey : Your allocated EBS Secret Key
Amount : Amount to be captured
Payment ID: Unique ID generated by EBS for identifying the payment
Sample HTML Code for Cancel.
<form method="POST" action="https://testing.secure.ebs.in/api/1_0" name="frmTransaction"><input name="Action" type="hidden" value="cancel">
<input name="AccountID" type="hidden" value="XXXX"><input name="SecretKey" type="hidden" value="XXXXXX"><input name="Amount" type="hidden" value="XXXXX"><input name=" PaymentID" type="hidden" value="XXXXX"><input name="submitted" value="Submit" type="submit">
</form >
Example response:<?xml version='1.0' encoding='UTF-8'?>
<output response=”SUCCESS” transactionId="2690686" paymentId="1399586"amount="200" dateTime="2010-10-06 17:39:38" mode="TEST" refrenceNo="223"transactionType="Cancelled" status="Processing"/>
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 16/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 16 of
f. Action:refund
This API can be used to make remote API call to initiate a refund process for a transaction. Partialrefund can also be performed for a transaction using this call.
URL https://testing.secure.ebs.in/api/1_0
Methods POST
Action Refund
MandatoryParameters
Action : refund
AccountID : Your allocated EBS Account ID
SecretKey : Your allocated EBS Secret Key
Amount : Amount to be captured
Payment ID: Unique ID generated by EBS for identifying the payment
Sample HTML Code for Refund.
<form method="POST" action="https://testing.secure.ebs.in/api/1_0" name="frmTransaction"><input name="Action" type="hidden" value="refund">
<input name="AccountID" type="hidden" value="XXXX"><input name="SecretKey" type="hidden" value="XXXXXX"><input name="Amount" type="hidden" value="XXXXX"><input name=" PaymentID" type="hidden" value="XXXXX">
<input name="submitted" value="Submit" type="submit"></form >
Example response:
<?xml version='1.0' encoding='UTF-8'?><output response=”SUCCESS” transactionId="2690686" paymentId="1399586"amount="200" dateTime="2010-10-06 17:39:38" mode="TEST" refrenceNo="223"transactionType="refunded" status="Processing"/>
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 17/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 17 of
xii. Invoice API Actions – Web & IVR
a. Action:create
Using this API call, you can create a IVR or Online Invoice in the EBS Backend. The response willhave a Invoice ID along with the other User provide Information.
Note:- Maximum 100 Invoices can be created per hour.
URL https://testing.secure.ebs.in/api/invoice
Methods POST
Action create
Is required? Parameter Name Min Max
Mandatory
action : create na na
account_id : EBS Account ID na na
secret_key : EBS Secret Key na nareference_no : Unique number generated at Merchant end for the 1 20
currency : Currency code for the specified amount (INR, USD, EUR,GBP)
3 3
name : Customer Name 1 128
email : Customer Email 1 100
payment_mode : 0 for Online and 99 for IVR 1 2
products[0][name] : Selling Product Name. If there are multipleproducts, they should be listed sequentially, for ex -products[1][name], products[2][name], etc
1 255
products[0][qty] : Selling Product Quantity. If there are multipleproducts, they should be listed sequentially, for ex - products[1][qty],products[2][qty], etc
1 3
products[0][price] : Selling Product Price. If there are multipleproducts, they should be listed sequentially, for ex -products[1][price], products[2][price], etc. The total amount will becalculated by EBS automatically.
1 16
address : Customer Address 1 255
city : Customer City 1 32
state : Customer State 1 32
postal_code : Customer Postal Code 1 10
country : Customer Country code as per Appendix A 3 3
phone : Customer Phone 9 20
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 18/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 18 of
Sample HTML Code for Invoice.
<form method="POST" action="https://testing.secure.ebs.in/api/invoice" name="frmTransaction"><input name="action" type="hidden" value="create"><input name="account_id" type="hidden" value="XXXX"><input name="secret_key" type="hidden" value="XXXXXX">
<input name="reference_no" type="hidden" value="XXXX"><input name="currency" type="hidden" value="INR"><input name="name" type="hidden" value="XXXX"><input name="address" type="hidden" value="XXXXX"><input name="city" type="hidden" value="XXXXX"><input name="state" type="hidden" value="XXXXX"><input name="postal_code" type="hidden" value="XXXXX"><input name="country" type="hidden" value="XXX"><input name="email" type="hidden" value="XXXXXX"><input name="phone" type="hidden" value="XXXXXXX"><input name="products[0][name]" type="hidden" value="XXXXXX"><input name="products[0][qty]" type="hidden" value="X"><input name="products[0][price]" type="hidden" value="XX.XX">
<input name="payment_mode" type="hidden" value="0"> --For Online
OR
<input name="payment_mode" type="hidden" value="99"> - For IVR
<input name="submitted" value="Submit" type="submit"></form>
Example response:
For Online Invoice
<?xml version='1.0' encoding='UTF-8'?><output>
<invoice><invoice_id>1xxxxx</invoice_id><date_created>2011-08-31 07:57:34</date_created>
<account_id>5xxx</account_id><reference_no>223</reference_no><amount>10.00</amount><status>Pending</status><payment_id>null</payment_id><return_url>http://yourdomain.com/page.php</return_url><payment_mode>Online</payment_mode><payment_url>https://secure.ebs.in/pg/ma/xyxyxy</payment_url><name>Test EBS</name><address>Arcot Road</address><city>Chennai</city><state>Tamil Nadu</state><postal_code>600001</postal_code><country>IND</country><phone>04423452345</phone>
<email>[email protected]</email><products><item0>
<name>Test Product</name><qty>2</qty><itemprice>5</itemprice><itemtotal>10.00</itemtotal>
</item0></products>
</invoice></output>
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 19/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 19 of
For IVR Invoice<?xml version='1.0' encoding='UTF-8'?>
<output><invoice>
<invoice_id>1xxxxxx</invoice_id><date_created>2011-08-31 08:12:33</date_created><account_id>5xxx</account_id><reference_no>225</reference_no><amount>10.00</amount><status>Pending</status><payment_id>null</payment_id><return_url>http://yourdomain.com/page.php</return_url><payment_mode>IVR</payment_mode><name>Test EBS</name><address>Arcot Road</address><city>Chennai</city><state>Tamil Nadu</state><postal_code>600087</postal_code><country>IND</country><phone>04423452345</phone><email>[email protected]</email>
<products><item0>
<name>Test Product</name><qty>2</qty><itemprice>5</itemprice><itemtotal>10.00</itemtotal>
</item0></products>
</invoice></output>
b. Action:get
Using this API call, you can retrieve the Invoice details created in the EBS Backend.
URL https://tesing.secure.ebs.in/api/invoice
Methods POST
Action get
MandatoryParameters
action : get
account_id : Your allocated EBS Account ID
secret_key : Your allocated EBS Secret Key
invoice_id: Unique ID generated by EBS for invoice
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 20/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 20 of
Sample HTML Code for Invoice.
<form method="POST" action="https://testing.secure.ebs.in/api/invoice" name="frmTransaction"><input name="action" type="hidden" value="get"><input name="account_id" type="hidden" value="XXXX"><input name="secret_key" type="hidden" value="XXXXXX">
<input name="invoice_id" type="hidden" value="1XXXXXX"><input name="submitted" value="Submit" type="submit">
</form>
Example response:
For Online Invoice<?xml version='1.0' encoding='UTF-8'?>
<output><invoice>
<invoice_id>1xxxxx</invoice_id><date_created>2011-08-31 07:57:34</date_created><account_id>5xxx</account_id><reference_no>223</reference_no>
<amount>10.00</amount><status>Pending</status><payment_id>null</payment_id><return_url>http://yourdomain.com/page.php</return_url><payment_mode>Online</payment_mode><payment_url>https://secure.ebs.in/pg/ma/xyxyxy</payment_url><name>Test EBS</name><address>Arcot Road</address><city>Chennai</city><state>Tamil Nadu</state><postal_code>600001</postal_code><country>IND</country><phone>04423452345</phone><email>[email protected]</email><products>
<item0><name>Test Product</name><qty>2</qty><itemprice>5</itemprice><itemtotal>10.00</itemtotal>
</item0></products>
</invoice></output>
For IVR Invoice<?xml version='1.0' encoding='UTF-8'?>
<output><invoice>
<invoice_id>1xxxxxx</invoice_id>
<date_created>2011-08-31 08:12:33</date_created><account_id>5xxx</account_id><reference_no>225</reference_no><amount>10.00</amount><status>Pending</status><payment_id>null</payment_id><return_url>http://yourdomain.com/page.php</return_url><payment_mode>IVR</payment_mode><name>Test EBS</name><address>Arcot Road</address><city>Chennai</city>
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 21/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 21 of
<state>Tamil Nadu</state><postal_code>600087</postal_code><country>IND</country><phone>04423452345</phone><email>[email protected]</email><products>
<item0>
<name>Test Product</name><qty>2</qty><itemprice>5</itemprice><itemtotal>10.00</itemtotal>
</item0></products>
</invoice></output>
Test URL - https://testing.secure.ebs.in/api/invoice Production URL - https://secure.ebs.in/api/invoice
xiii.
Invoice API Error Codes:
Error Code => Error Description1 => 'Invalid Action',2 => 'Invalid Account ID/Secret Key',3 => 'Invalid Refrence No',4 => 'Invalid InvoiceID',5 => 'Problem in retrieving invoice',6 => 'Currency is empty',7 => 'This currency is not supported now!',8 => 'Invalid Inputs',9 => 'Error in inserting invoice',10 => 'Invoice created already',
11 => 'Hourly invoice quota exceeded',12 => 'Invalid Product Details',
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 22/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 22 of
APPENDIX A – SECURE HASH VALIDATION
Secure hash is technology to check for the authenticity of the parameters posted to EBS. The securehash value is posted along with other post parameters. The received parameters are hashed at EBS
and compared against the Secure hash value received from Merchant.
In case of non-conformity, the payment is failed and further processing is stopped.
Sample Code:
$secret_key = ’ ’; //Provide your EBS Account’s Secret Key
$hashData = $secret_key; // Intialise with Secret Keyksort ($_POST); // Sort the post parameters in alphabetical order of parameter Names.
//Append the posted values to $hashData
foreach($_POST as $key => $value) {
// create the md5 input leaving out any fields that has no value$hashData .= ‘|’ . $value;
}
// Create the secure hash and append it to the Post data
if (strlen($hashData) > 0) {$hashvalue = strtoupper(md5($hashData));
}
$vpc_SecureHash = $hashvalue;
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 23/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 23 of
APPENDIX B – SETTLEMENT CYCLE
This is with reference to the RBI Notification RBI/2009-10/231 DPSS.CO.PD.No.1102/02.14.08/2009-10 dated November 24, 2009 captioned "Directions for opening and operationof accounts and settlement of payments for electronic payment transactions involvingintermediaries".
As per the aforementioned notification, EBS has implemented a T+2 Settlement Cycle.
Below mentioned are the details concerning T+2 Settlement process:
Transaction Day - Day on which Merchant completes the Order from his Customer by capturing it
in the EBS Backend.
Settlement Day - Day on which EBS Settles the Transaction Amount to Merchant for the
Transaction done on Transaction Day
Transaction Day Settlement Day
Monday(this week) ednesday (this week)
Tuesday(this week) hursday(this week)
Wednesday(this week) riday(this week)
Thursday(this week) aturday(this week)
Friday(this week) Monday(next week)
Saturday, Sunday(this week) Tuesday(next week)
Note - If any Bank Holidays or Unexpected Holidays happen to be on the Settlement Day,
the Settlement is postponed to the next Working Day.
For Example: If Tuesday happens to be Bank Holiday, The Settlement is postponed to
Wednesday. So the transactions done on Thursday and Friday (this week) are settled
on Wednesday (next week).
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 24/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 24 of
APPENDIX C – ISO3 Country Name
ISO3 Country Name ISO3 Country Name
ABW Aruba COD Congo, the Democratic Republic of the
AFG Afghanistan COG Congo AGO Angola COK Cook Islands AIA Anguilla COL Colombia ALA Aland Islands COM Comoros
ALB Albania CPV Cape Verde AND Andorra CRI Costa Rica ANT Netherlands Antilles CUB Cuba ARE United Arab Emirates CXR Christmas Island
ARG Argentina CYM Cayman Islands ARM Armenia CYP Cyprus ASM American Samoa CZE Czech Republic ATA Antarctica DEU Germany
ATF French Southern Territories DJI Djibouti ATG Antigua and Barbuda DMA Dominica AUS Australia DNK Denmark AUT Austria DOM Dominican Republic
AZE Azerbaijan DZA AlgeriaBDI Burundi ECU EcuadorBEL Belgium EGY EgyptBEN Benin ERI EritreaBFA Burkina Faso ESH Western SaharaBGD Bangladesh ESP SpainBGR Bulgaria EST EstoniaBHR Bahrain ETH Ethiopia
BHS Bahamas FIN FinlandBIH Bosnia and Herzegovina FJI FijiBLM Saint Barthlemy FLK Falkland Islands (Malvinas)BLR Belarus FRA FranceBLZ Belize FRO Faroe IslandsBMU Bermuda FSM Micronesia, Federated States ofBOL Bolivia GAB GabonBRA Brazil GBR United Kingdom
BRB Barbados GEO GeorgiaBRN Brunei Darussalam GGY GuernseyBTN Bhutan GHA GhanaBVT Bouvet Island GIN N Guinea
BWA Botswana GIB GibraltarCAF Central African Republic GLP GuadeloupeCAN Canada GMB GambiaCCK Cocos (Keeling) Islands GNB Guinea
CHE Switzerland GNQ Equatorial GuineaCHL Chile GRC GreeceCHN China GRD GrenadaCIV Cote d`Ivoire GRL Greenland
CMR Cameroon GTM Guatemala
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 25/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 25 of
ISO3 Country Name ISO3 Country Name
GUF French Guiana MEX Mexico
GUM Guam MHL Marshall IslandsGUY Guyana MKD Macedonia, the former Yugoslav Republic HKG Hong Kong MLI Mali
HMD Heard Island and McDonald Islands MLT MaltaHND Honduras MMR MyanmarHRV Croatia MNE MontenegroHTI Haiti MNG MongoliaHUN Hungary MNP Northern Mariana Islands
IDN Indonesia MOZ MozambiqueIMN Isle of Man MRT MauritaniaIND India MSR MontserratIOT British Indian Ocean Territory MTQ Martinique
IRL Ireland MUS MauritiusIRN Iran, Islamic Republic of MWI MalawiIRQ Iraq MYS Malaysia
ISL Iceland MYT MayotteISR Israel NAM NamibiaITA Italy NCL New CaledoniaJAM Jamaica NER NigerJEY Jersey NFK Norfolk IslandJOR Jordan NGA NigeriaJPN Japan NIC NicaraguaKAZ Kazakhstan NOR R NorwayKEN Kenya NIU NiueKGZ Kyrgyzstan NLD NetherlandsKHM Cambodia NPL NepalKIR Kiribati NRU Nauru
KNA Saint Kitts and Nevis NZL New ZealandKOR Korea, Republic of OMN OmanKWT Kuwait PAK PakistanLAO Lao People`s Democratic Republic PAN PanamaLBN Lebanon PCN Pitcairn
LBR Liberia PER PeruLBY Libyan Arab Jamahiriya PHL PhilippinesLCA Saint Lucia PLW PalauLIE Liechtenstein PNG Papua New Guinea
LKA Sri Lanka POL PolandLSO Lesotho PRI Puerto RicoLTU Lithuania PRK Korea, Democratic People`s Republic of
LUX Luxembourg PRT PortugalLVA Latvia PRY ParaguayMAC Macao PSE Palestinian Territory, OccupiedMAF Saint Martin (French part) PYF French PolynesiaMAR Morocco QAT Qatar
MCO Monaco REU ReunionMDA Moldova ROU RomaniaMDG Madagascar RUS Russian FederationMDV Maldives RWA Rwanda
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 26/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 26 of
ISO3 Country Name ISO3 Country Name
SAU Saudi Arabia VNM Viet Nam
SDN Sudan VUT VanuatuSEN Senegal WLF Wallis and FutunaSGP Singapore WSM Samoa
SGS South Georgia and the South Sandwich Islands YEM YemenSHN Saint Helena ZAF South AfricaSJM Svalbard and Jan Mayen ZMB ZambiaSLB Solomon Islands ZWE ZimbabweSLE Sierra Leone
SLV El SalvadorSMR San MarinoSOM SomaliaSPM Saint Pierre and Miquelon
SRB SerbiaSTP Sao Tome and PrincipeSUR Suriname
SVK SlovakiaSVN SloveniaSWE SwedenSWZ SwazilandSYC SeychellesSYR Syrian Arab RepublicTCA Turks and Caicos IslandsTCD ChadTGO TogoTHA ThailandTJK TajikistanTKL Tokelau
TKM TurkmenistanTLS TimorTON TongaTTO Trinidad and TobagoTUN Tunisia
TUR TurkeyTUV TuvaluTWN Taiwan, Province of ChinaTZA Tanzania, United Republic of
UGA UgandaUKR UkraineUMI United States Minor Outlying Islands
URY UruguayUSA United StatesUZB Uzbekistan VAT Holy See (Vatican City State) VCT Saint Vincent and the Grenadines
VEN Venezuela VGB Virgin Islands, British VIR Virgin Islands, U.S.
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 27/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 27 of
APPENDIX D – PCI DSS COMPLIANCE
i. Compliance Requirements
Control Objectives PCI DSS Requirements
Build and Maintain a Secure Network
1. Install and maintain a firewall configuration to protectcardholder data
2. Do not use vendor-supplied defaults for system passwords and other security parameters
Protect Cardholder Data
3. Protect stored cardholder data
4. Encrypt transmission of cardholder data across open,public networks
Maintain a Vulnerability ManagementProgram
5. Use and regularly update anti-virus software on allsystems commonly affected by malware
6. Develop and maintain secure systems and applications
Implement Strong Access Control Measures
7. Restrict access to cardholder data by business need-to-know
8. Assign a unique ID to each person with computer access
9. Restrict physical access to cardholder data
Regularly Monitor and Test Networks
10. Track and monitor all access to network resources andcardholder data
11. Regularly test security systems and processes
Maintain an Information Security Policy 12. Maintain a policy that addresses information security
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 28/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 28 of
ii. PCI Self-Assessment Questionnaire (SAQ)
The PCI Data Security Standard Self-Assessment Questionnaire is a validation tool intended to assistmerchants and service providers in self-evaluating their compliance with the Payment Card IndustryData Security Standard (PCI DSS). All merchants and their service providers are required to complywith the PCI Data Security Standard in its entirety.
SAQ Description
ACard-not-present (e-commerce or mail/telephone-order) merchants, all cardholder datafunctions outsourced. This would never apply to face-to-face merchants.
B Imprint-only merchants with no electronic cardholder data storage, or standalone, dial-out terminal merchants with no electronic cardholder data storage.
C-VT Merchants using only web-based virtual terminals, no electronic cardholder data storage.
C Merchants with payment application systems connected to the Internet, no electroniccardholder data storage.
D All other merchants not included in descriptions for SAQ types A through C above, and allservice providers defined by a payment brand as eligible to complete an SAQ.
iii. Merchant PCI DSS Compliance Criteria and PCI levels
Level 1 Criteria
Merchants with over 6 million transactions a year, or merchants whose data has previously beencompromisedLevel 1 Validation Requirements Annual Onsite Security Audit (reviewed by a QSA or Internal Audit if signed by officer of merchantcompany and pre-approved by acquirer) and quarterly network security scan
Level 2 CriteriaMerchants with 1,000,000 to 6 million transactions a yearLevel 2 Validation Requirements Annual Self Assessment QuestionnaireQuarterly Scan by an Approved Scanning Vendor (ASV)
Level 3 CriteriaMerchants with 20,000 to 1,000,000 transactions a yearLevel 3 Validation Requirements
Quarterly Scan by an Approved Scanning Vendor (ASV) Annual Self Assessment Questionnaire
Level 4 CriteriaMerchants with less than 20,000 transactionsLevel 4 Validation Requirements Annual Self Assessment QuestionnaireQuarterly Scan by an Approved Scanning Vendor
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 29/30
© Copyright E-Billing Solutions Pvt Ltd.
EBS-Direct Integration Page 29 of
iv. Achieving Compliance with PCI DSS
The PCI DSS compliance procedure can take anything from a day to many weeks, depending on what isuncovered by the vulnerability assessment scan and the self-assessment questionnaire. Organizationsthat currently have a good level of information security are likely to be compliant a lot more quickly thanthose that don't.
QSAs carry out inspections of PCI DSS implementations and determine a recommendation of complianceto the various payment brands. Each individual payment brand will separately determine whether toaccept the recommendation of compliance and whether a detailed review of the report of complianceand compensating controls is warranted.
The starting point for all organizations that need to comply is to download the Payment CardIndustry Self-Assessment Questionnaire and to contact a PCI Approved Scanning Vendor(ASV ).
8/12/2019 Ebs Direct Merchant Guide v1.2 (1)
http://slidepdf.com/reader/full/ebs-direct-merchant-guide-v12-1 30/30
EBS-Direct Integration Page 30 of
To ensure prompt support, EBS has a simple online ticketing system
accessible 24x7 at http://support.ebs.in.
Please send your suggestions/ feedback to: [email protected]
(OR)
Call Us: +91 44 4231 3333