AUTO PAY – USER GUIDE 4 · EBS Payment Gateway. This manual has been prepared on best effort. Despite every effort to avoid errors it is likely that some errors may creep in. EBS

AUTO PAY – USER GUIDE 4.1

DISCLAIMER This manual is intended to be used by EBS, its registered merchants and its employees, only to facilitate the use of

EBS Payment Gateway. This manual has been prepared on best effort. Despite every effort to avoid errors it is likely

that some errors may creep in. EBS may, at its sole discretion modify, alter, delete, add or amend any of the contents

of this manual without assigning any reason or prior intimation to the Customer. It is notified that EBS shall not be

liable for any damage or loss of action to anyone, of any kind in any manner arising by this manual.

The contents of this manual are proprietary to the EBS and contain information that is privileged and confidential.

Use or dissemination of the contents of this manual in any manner whatsoever is strictly prohibited. No part of this

manual may be reproduced or copied in any form without prior permission of the EBS. Breach of this condition shall

be liable for legal action.

Contents

1.INTRODUCTION1.INTRODUCTION1.INTRODUCTION1.INTRODUCTION ........................................................................................................................................................... 4

2. SUBSCRIPTION FORM2. SUBSCRIPTION FORM2. SUBSCRIPTION FORM2. SUBSCRIPTION FORM................................................................................................................................................ 5

2.1 Subscription Validation ............................................................................................................................................ 8

2.2 Subscription Confirmation ...................................................................................................................................... 9

3. VIEWING SUBSCRIPT3. VIEWING SUBSCRIPT3. VIEWING SUBSCRIPT3. VIEWING SUBSCRIPTION ION ION ION ---- MERCHANT PORTAL AND MERCHANT PORTAL AND MERCHANT PORTAL AND MERCHANT PORTAL AND TRANSACTION MANAGER TRANSACTION MANAGER TRANSACTION MANAGER TRANSACTION MANAGER LOLOLOLOGINGINGINGIN ............................. 13

3.1 Autopay – Status ................................................................................................................................................... 14

3.2 Subscription Cancellation ...................................................................................................................................... 15

4 INITIATION OF AUTO4 INITIATION OF AUTO4 INITIATION OF AUTO4 INITIATION OF AUTOPAY TRANSACTION REQUPAY TRANSACTION REQUPAY TRANSACTION REQUPAY TRANSACTION REQUESTESTESTEST ............................................................................................. 16

4.1 Initiation from merchant’s website ....................................................................................................................... 16

4.2 Initiation from merchant portal ............................................................................................................................. 18

4.3 Autopay initiation validation – Merchant's website/ Portal .................................................................................. 19

5 PAYMENT STATUS5 PAYMENT STATUS5 PAYMENT STATUS5 PAYMENT STATUS ...................................................................................................................................................... 20

6 API TO CANCEL AUTO6 API TO CANCEL AUTO6 API TO CANCEL AUTO6 API TO CANCEL AUTOPAYPAYPAYPAY ........................................................................................................................................ 21

6.1 API to get status of autopay .................................................................................................................................. 22

6.2 API to Inititiate payment immedieatly ................................................................................................................... 23

6.3 API to get status by refno of autopay .................................................................................................................... 24

7 AUTOPAY EMAILS7 AUTOPAY EMAILS7 AUTOPAY EMAILS7 AUTOPAY EMAILS ...................................................................................................................................................... 25

Annexure A: Successful Auto Pay Registration (Merchant).......................................................................................... 25

Annexure B: Successful Auto Pay Registration (Customer) .......................................................................................... 26

Annexure C: Un Successful Auto Pay Registration (Merchant) .................................................................................... 27

Annexure D: Un Successful Auto Pay Registration (Customer) .................................................................................... 28

Annexure E: No Action Intimation (Merchant) ............................................................................................................ 29

Annexure F: Consecutive Un-Successful Transaction (Merchant) ............................................................................... 30

Annexure G: Card Expiry Intimation (Merchant) ......................................................................................................... 31

Annexure H: Auto Pay Expiry Intimation (Merchant)................................................................................................... 32

1.INTRODUCTION

Autopay is an instruction which a customer gives to the merchant to pay a set amount at regular intervals into

merchant’s account i.e. a money transfer scheduled on a predetermined date to make recurring payments.

Autopay can be used in a variety of situations, from monthly subscriptions and leasing arrangements to paying

electricity and telephone bills.

Autopay means that customers do not have to worry about remembering to make their payment each time it is due,

while you provide better service, receive your payments regularly and save valuable time.

Autopay is used to pay rent, subscribe Insurance, donation and electricity bills, etc.

To enable Auto pay, merchants are required to contact [email protected]

2. SUBSCRIPTION FORM

Once the Autopay is enabled for a merchant, a subscription form would be provided at merchant website. When a

customer chooses to subscribe using this form, he needs to fill the following mandatory details for initial registration.

URL https://secure.ebs.in/pg/ma/subscription/sisubscribe/action/add

Methods POST

Parameter Description Type Min Max Mandatory

account_id Your Account ID numeric - - YES

name Customer billing Name char 1 128 YES

address Customer billing address char 1 255 YES

city Customer billing city char 1 32 YES

state Customer billing state Char 1 32 NO

country

Customer billing country.

[3 Digit ISO3 country code- refer Appendix

C]

Char 3 3 YES

postal_code Customer billing postal code Char 1 10 YES

email Customer billing email Char 1 100 YES

Mobile_number 10 digit mobile Number - - YES

start_date YYYY-MM-DD Date - - YES

end_date YYYY-MM-DD Date - - YES

frequency period like 7 DAY, 14 DAY, 1 MONTH, 6

MONTH, 1 YEAR Text - - YES

amount_limit limit for the amount decimal 1 14,2 YES

initial_transaction_amount initial transaction amount value decimal 1 14,2 YES

additional_info1 Any additional Information can be shared Text - - NO

additional_info2 Any additional Information can be shared Text - - NO

secure_hash Hash value calculated Char 32 32 YES

Sample Code using SHA512 Hashing Algorithm in PHP

$secret_key = ’ ’; //Provide your EBS Account’s Secret Key

$hashData = $secret_key; // Intialise with Secret Key

ksort ($_POST); // Sort the post parameters in alphabetical order of parameter names.

//Append the posted values to $hashData

foreach($_POST as $key => $value) {

//create the hashing input leaving out any fields that has no value and by concatenating the values using a ‘|’ symbol.

if (strlen($value) > 0) {

$hashData .= '|'.$value;

}

}

// Create the secure hash and append it to the Post data

if (strlen($hashData) > 0) {

$hashvalue = strtoupper(hash("sha512", $hashData));

}

$secure_hash = $hashvalue;

Sample HTML Code

<HTML>

<body>

<form method="post" action="https://secure.ebs.in/pg/ma/subscription/sisubscribe/action/add"

name="frmTransaction" >

<input type="text" name="account_id" value="16474" />

<input type="text" name="name" value="xxxx" />

<input type="text" name="address" value="xxxx" />

<input type="text" name="city" value="xxx" />

<input name="state" type="text" value="xxxx" />

<input type="text" name="country" value="IND" />

<input name="postal_code" type="text" value="xxxxx" />

<input name="email" type="text" value="xxxx" />

<input name="mobile_number" type="text" value="xxxxx" />

<input name="start_date" type="text" value='xxxxx' />

<input name="end_date" type="text" value="xxxxxx" />

<select name="frequency">

<option value="7 DAY">Every week</option>

<option value="14 DAY">Every two weeks</option>

<option value="1 MONTH">Every month</option>

<option value="6 MONTH">Every six months</option>

<option value="1 YEAR">Every year</option>

</select>

<input name="amount_limit" type="text" value="xxxx" />

<input name="initial_transaction_amount" type="text" value="xx"/>

<textarea name="additional_info1" value = "xxxx"></textarea>

<textarea name="additional_info2" value = "xxxx"></textarea>

<input name="secure_hash" type="text" value="xxxx" />

<input name="submitted" value="Submit" type="submit" />

</form>

</body>

</html>

2.1 SUBSCRIPTION VALIDATION

• System can validate the AutoPay details passed by the merchant with the existing AutoPay details ( unique

email ID/ mobile no)

• System will throw an alert message to the customer as below

“Auto Pay already exists for Mobile No: <mob> and/ or An Auto Pay already exists for Email ID: <email>. Do

you wish to continue/close”

• System will create a new Auto Pay for the customer with the same email Id/phone no (A new Auto Pay ID to

be created in this case) if the customer wishes to continue.

• Customer can cancel the requested autopay on click of ‘Close’ button.

2.2 SUBSCRIPTION CONFIRMATION

Once the merchant pass details such as frequency, transaction upper limit, first transaction amount, and first

transaction date, the customer views the Auto Pay form in the EBS page. Customer only fills in the credit card details

in the Auto Pay form link if he/she accepts the Auto Pay.

• Customer can view the pre-filled in details as passed from the merchant in the Auto Pay form

• Customer will be able to fill in the following MANDATORY fields in order to accept the subscription:

◦ Credit Card Number

◦ CVV

◦ Card Expiry – Month and year ( to be selected from a drop-down)

◦ Name on Card

• System will redirect the customer to the EBS payment page with the first transaction amount

• Customer will be able to complete the payment of the initial transaction amount only with the card details

and the transaction amount as filled in in the subscription form.

• System will throw an alert message : “ Please enter a valid credit Card Number” if the customer has not

entered a credit card number or has not entered a valid credit card number

• Customer can reject the Auto Pay and be returned to the merchant url if rejected.

• If the customer has accepted the Auto Pay and attempted for initial payment, an email is to be sent across to

the merchant and the customer for successful autopay registration.

• No option for retry an autopay

Response URL:

The response of the subscription will be posted to the subscription from URL in POST method with the below

parameters

Response parameters:

S.No Parameter Description

1 Response

Whether the payment is successful or not 0

=>Successful

2 PaymentID

For that particular payment a id will be created for our reference

3 AutoPayId Auto pay id

4 account_id

Account ID

5 additional_info1 Additional info 1 passed during transaction

6 additional_info2 Additional info 2 passed during transaction

7 address Customer’s address posted during subscription

8 amount_limit limit for the amount

9 city Customer billing city

10 country Customer billing country.

11 email Customer billing email

12 end_date YYYY-MM-DD

13 frequency period like 7 DAY, 14 DAY, 1 MONTH, 6 MONTH, 1 YEAR

14 initial_transaction_amount initial transaction amount value

15 merchant_type Merchant Type

16 mobile_number Customer mobile number

17 name Customer billing Name

18 postal_code Customer billing postal code

19 return_url Return URL posted during subscription

20 start_date YYYY-MM-DD

21 state Customer billing state

22 previousPage Previous Page URL posted during subscription

Response in case all the validations are failed.

S.No Parameter Description

1 SecureHash The hashed value of the response parameters.

2 Error Error Message

3 ResponseCode Response Code of the error

3. VIEWING SUBSCRIPTION - MERCHANT PORTAL AND TRANSACTION MANAGER LOGIN

The subscriptions requested by the customer can be viewed by logging in into the merchant portal https://secure.ebs.in/pg/ma/user/login and selecting Autopay > Subscriptions tab

Here, the list of subscriptions of all the customers can be viewed with the following filter criteria - Email, Status – All/ Approved/ Cancelled/ Expired

Subscription list will have the following information

• Auto pay ID – Unique id will be created automatically • Customer name • Email ID • Amount limit – Maximum amount limit • Frequency – Every week, Every two weeks, Every month, Every six months, Every year • Payment ID – Initial transaction payment id will be displayed • Acceptance status – By default, the status will be approved. • Actions – View , Payment status

3.1 AUTOPAY – STATUS

• Autopay has the status such as Approved/Cancelled/Expired.

• Approved - The status of the Autopay will be APPROVED if the customer makes a successful transaction with

the details passed from the merchant.

• Cancelled – The status of the Autopay will be CANCELLED, if:

◦ The merchant cancels an auto-pay

◦ After one month an email will be sent to the customer if there isn't any Auto Pay initiated by the

merchant for a customer for more than 2 years or more than 6 cycles ( whichever is earlier)

◦ After one month an email will been sent to the customer if there exists 6 consecutive unsuccessful

transactions when merchant initiates the transaction through API or file upload

• Expired – The status of the Autopay will be EXPIRED, if:

◦ The credit card entered by the customer has expired

◦ The Auto Pay has crossed the END DATE

3.2 SUBSCRIPTION CANCELLATION

• On selecting View for a particular Autopay ID, the complete details of the subscription can be viewed

• The customer's details and the autopay details will be displayed in non-editable form.

• Merchant can only edit the status of a subscription. Current status will be 'Approved'. • If the merchant wishes to cancel a subscription, it can be done by selecting the status 'Cancelled' from the

subscription status panel.

4 INITIATION OF AUTOPAY TRANSACTION REQUEST

Merchant can initiate the Auto Pay either on merchant website or from the merchant portal in secure through a file upload option.

4.1 INITIATION FROM MERCHANT’S WEBSITE

Auto Pay can be initiated from the merchant website by API

URL http://api.secure.ebs.in/api/autoPay

Methods POST

Parameters account_id : Your allocated EBS account id

secret_key : Your allocated EBS secret key

auto_pay_id : Subscription id

transaction_date : date(YYYY-MM-DD)

transaction_amount : Amount

secure_hash : Refer below

Sample Code using SHA512 Hashing Algorithm in PHP

$secret_key = ’ ’; //Provide your EBS Account’s Secret Key

$hashData = $secret_key; // Intialise with Secret Key

ksort ($_POST); // Sort the post parameters in alphabetical order of parameter names.

//Append the posted values to $hashData

foreach($_POST as $key => $value) {

//create the hashing input leaving out any fields that has no value and by concatenating the values using a ‘|’ symbol.

if (strlen($value) > 0) {

$hashData .= '|'.$value;

}

}

// Create the secure hash and append it to the Post data

if (strlen($hashData) > 0) {

$hashvalue = strtoupper(hash("sha512", $hashData));

}

$secure_hash = $hashvalue;

Sample HTML Code

<form method="POST" action="https://api.secure.ebs.in/api/autoPay" name="frmTransaction">

<input name="account_id" type="hidden" value="123">

<input name="secret_key" type="hidden" value="XXXX">

<input name="auto_pay_id" type="hidden" value="XXXXXX">

<input name="transaction_date" type="hidden" value="XXXXX">

<input name="transaction_amount" type="hidden" value="XXXXX">

<input name="secure_hash” type="hidden" value="XXXXX">

<input name="submitted" value="Submit" type="submit"> </form >

Sample output:

<output>

<subscription>

<errorCode>10</errorCode>

<error>

Auto Pay date should be greater than or equal to today

</error>

</subscription>

</output>

4.2 INITIATION FROM MERCHANT PORTAL

Autopay can be initiated from the merchant portal in secure by uploading a file with the following details:

1) Auto Pay ID

2) Transaction Date

3) Transaction Amount

• To upload the file, Click 'Upload Autopay' from Autopay menu • Select the upload file • Click on 'Upload' to upload the file • If any information in the upload file is incorrect, system will not consider the file and throw error.

4.3 AUTOPAY INITIATION VALIDATION – MERCHANT'S WEBSITE/ PORTAL

• System will validate and initiate the autopay as per the necessary details passed by the merchant • System will validate if the transaction amount falls within the upper limit as accepted by the customer for a

particular frequency. • System will validate if the transaction frequency falls within the frequency accepted by the customer during

subscription acceptance • System will be able to complete the transaction with the card details shared by the customer at the time

Auto Pay acceptance

5 PAYMENT STATUS

• On selecting 'Autopay > Payment status', initiated autopay payments will be listed.

• The payment status can be filtered by Autopay ID, Request Transaction Date, Scheduled Transaction Date,

Paid Transaction Date, Request From ( API / Upload) and Status (All/Paid/Pending/Failed/Cancelled) • The list of Initiated Autopay payment status would be displayed as Pending • If the initiated Autopay payments for a particular frequency was successful, the payment status would be

updated as Paid • If the initiated Autopay payments for a particular frequency was unsuccessful, the payment status would be

updated as Failed • If the subscription is cancelled by the merchant/ system, the pending payments corresponding to the

subscription would be updated as 'Cancelled'.

6 API TO CANCEL AUTOPAY

Action: Cancel

URL Https://secure.ebs.in/api/autoPay

METHOD POST

Action cancel

Mandatory Parameters

action : cancel

account_id – your EBS account id

secret_key – your EBS secret key

auto_pay_id- your auto pay id available in the

merchant panel

secure_hash -Refer sample code using SHA512

algorithm

Sample HTML code:

<form method="POST" action="https://api.secure.ebs.in/api/1_0" name="frmTransaction">

<input name="action" type="hidden" value="cancel" />

<input name="account_id" type="hidden" value="XXXX" />

<input name="secret_key" type="hidden" value="XXXXXX" />

<input name="auto_pay_id" type="hidden" value="XXXXXX" />

<input name="secure_hash" type="hidden" value="XXXXXX" />

<input name="submitted" value="Submit" type="submit">

</form >

Sample response:

<output>

<subscription>

<autopay_status>Cancelled</autopay_status>

<setup_date>2016-01-28 17:45:43</setup_date>

<expiry_date>2018-06-18</expiry_date>

<last_successful_charge_date/>

<last_successful_payment_id/>

</subscription>

</output>

6.1 API TO GET STATUS OF AUTOPAY

Action: status


METHOD POST

Action status


action : payment




merchant panel


algorithm

Sample HTML code:


<input name="action" type="hidden" value="status" />






</form >

Sample response:

<output>

<subscription>

<autopay_status>Approved</autopay_status>

<setup_date>2015-12-28 17:53:06</setup_date>

<expiry_date>2018-06-18</expiry_date>

<last_successful_charge_date>2015-12-29 10:58:00</last_successful_charge_date>

<last_successful_payment_id>34658709</last_successful_payment_id>

</subscription>

</output>

6.2 API TO INITITIATE PAYMENT IMMEDIEATLY

Action: processPayment


METHOD POST

Action processPayment


action : processPayment

account_id - your EBS account id



merchant panel

transaction_amount- Transaction amount

ref_no- Merchant reference number


algorithm

Sample HTML code:


<input name="action" type="hidden" value="processPayment" />




<input name="transaction_amount" type="hidden" value="XXXXXX" />

<input name="ref_no" type="hidden" value="XXXXXX" />



</form >

Sample response:

<output>

<subscription>

<AutoPay>Inserted</AutoPay>

<ResponseCode>2</ResponseCode>

<FailureDescription>

|100.00|34660725||2|!ERROR!-GW00460-TranPortal ID required.|||

</FailureDescription>

<PaymentId>34660725</PaymentId>

<PaymentStatus>Failed</PaymentStatus>

<Amount>100.00</Amount>

</subscription>

</output>

6.3 API TO GET STATUS BY REFNO OF AUTOPAY

Action: statusByRef


METHOD POST

Action statusByRef


action : statusByRef


secret_key - your EBS secret key

ref_no- Merchant reference number

secure_hash – Refer sample code using SHA512

algorithm

Sample HTML code:


<input name="action" type="hidden" value="statusByRef" />



<input name="ref_no" type="hidden" value="XXXXXX" />



</form >

Sample response:

<output>

<subscription>

<ResponseCode>0</ResponseCode>

<PaymentId>34658673</PaymentId>

<PaymentStatus>paid</PaymentStatus>

<Amount>200.00</Amount>

</subscription>

</output>

7 AUTOPAY EMAILS

Mails will be sent for the following cases:

• Successful Autopay Registration ( Merchant) • Successful Autopay Registration ( Customer) • Unsuccessful Autopay Registration ( Merchant) • Unsuccessful Autopay Registration ( Customer) • No Action Intimation ( Merchant) • Consecutive Un-Successful Transaction ( Merchant) • Card Expiry Intimation ( Merchant) • Autopay Expiry Intimation ( Merchant)

ANNEXURE A: SUCCESSFUL AUTO PAY REGISTRATION (MERCHANT)

Subject:

Auto Pay ID: <Auto Pay ID> Successfully Registered

Body:

Hi,

A new Auto-Pay instruction has been successfully registered on <URL> with the following details.

• Auto Pay ID: <Auto Pay ID>

• Customer Name: < Customer Name>

• Customer Email ID: < Customer Email ID>

• Frequency: <Frequency>

• Maximum Transaction Value: <Amount Limit>

• Start Date: <Transaction Start Date>

• End Date: <End Date>

• Initial Transaction Value: <Value>

• Payment ID: <Payment ID>

Warm regards,

EBS

DO NOT reply to this email. This is an automated email.

For any queries regarding this transaction, please reach us on [email protected] or 044 – 6663 3333 (between 8:00 AM

to XX:XX PM on all days except for Sundays and Public Holidays)

ANNEXURE B: SUCCESSFUL AUTO PAY REGISTRATION (CUSTOMER)

Subject:

Auto Pay ID: <Auto Pay ID> Successfully Registered

Body:

Hi,

You been successfully registered for Auto Pay on <Merchant Name>. Details of Auto Pay instruction is as below.


• Name: < Customer Name>

• Email ID: < Customer Email ID>







Warm regards,

EBS




ANNEXURE C: UN SUCCESSFUL AUTO PAY REGISTRATION (MERCHANT)

Subject:

Auto Pay Registration Failed

Body:

Hi,

Auto-Pay instruction for <Customer Name> has failed.

• Auto Pay ID: <Auto Pay ID> // Only if Auto Pay ID is created for failed transaction.//









• Failure Reason: <Reason>

Warm regards,

EBS




ANNEXURE D: UN SUCCESSFUL AUTO PAY REGISTRATION (CUSTOMER)

Subject:

Auto Pay Registration Failed

Body:

Hi,

Your Auto Pay registration request on <Merchant Name> has failed. Details of failed Auto Pay instruction are as

below.

• Auto Pay ID: <Auto Pay ID> // Only if Auto Pay ID is created for failed transaction.//

• Name: < Customer Name>

• Email ID: < Customer Email ID>







• Failure Reason: <Reason>

Warm regards,

EBS




ANNEXURE E: NO ACTION INTIMATION (MERCHANT)

Subject:

Auto Pay ID <Auto Pay ID> is inactive

Body:

Hi,

Auto Pay instruction for <Customer Name> has no successful transactions in last 6 Auto Pay cycles and/ or two years.

In case there in no successful transaction within the next 25 days, this Auto Pay instruction will be removed.

Auto Pay details:








Warm regards,

EBS


For any queries regarding this transaction, please reach us on [email protected] or 044 –6663 3333 (between 8:00 AM


ANNEXURE F: CONSECUTIVE UN-SUCCESSFUL TRANSACTION (MERCHANT)

Subject:

Consecutive 6 un-successful transactions for the Auto Pay ID <Auto Pay ID>

Body:

Hi,

Auto Pay instruction for <Customer Name> has no successful transactions in last 6 Auto Pay cycles . In case there in

no successful transaction within the next 25 days, this Auto Pay instruction will be removed.

Auto Pay details:








Warm regards,

EBS


For any queries regarding this transaction, please reach us on [email protected] or 044 –6663 3333 (between 8:00 AM


ANNEXURE G: CARD EXPIRY INTIMATION (MERCHANT)

Subject:

Credit Card linked to Auto Pay ID <Auto Pay ID> will expire in MON YYYY

Body:

Hi,

Credit Card linked to Auto Pay instruction for <Customer Name> will expire on MONTH YYYY. Once the Credit Card

expires, Auto Pay instruction will be removed.

Auto Pay details:








Warm regards,

EBS




ANNEXURE H: AUTO PAY EXPIRY INTIMATION (MERCHANT)

Subject:

Auto Pay ID <Auto Pay ID> will expire in MON YYYY

Body:

Hi,

Auto Pay instruction for <Customer Name> will expire on MONTH YYYY.

Auto Pay details:








Warm regards,

EBS

DO NOT reply to this email. This is an automated email. For any queries regarding this transaction, please reach us on [email protected] or 044 – 6663 3333 (between 8:00 AM to XX:XX PM on all days except for Sundays and Public Holidays)

End of the document

Documents

AUTO PAY – USER GUIDE 4 · EBS Payment Gateway. This manual has been prepared on best effort. Despite every effort to avoid errors it is likely that some errors may creep in. EBS