Merchant Integration Guide

Last Updated: September 30th 2008

Merchant Integration Guide

TABLE OF CONTENTS PREFACE ..................................................................................................................................... 3
DOCUMENT PURPOSE ................................................................................................................................ 3 INTENDED AUDIENCE ................................................................................................................................. 3 NOTATIONAL CONVENTIONS ........................................................................................................................ 3 TECHNICAL ASSISTANCE .............................................................................................................................. 4 DOCUMENT REVISION HISTORY .................................................................................................................... 4

BUSINESS ACCOUNTS ................................................................................................................. 5
INTRODUCTION ........................................................................................................................................ 5 WHAT IS A BUSINESS ACCOUNT? .................................................................................................................. 5 HOW TO ADD A SUB-BUSINESS ACCOUNT ........................................................................................................ 5 EDITING YOUR BUSINESS ACCOUNT ............................................................................................................... 8 SET UP YOUR WEBSITE WITH ALERTPAY ........................................................................................................ 12
Prerequisites ................................................................................................................................................. 12 To setup your website with AlertPay: ............................................................................................................. 12 1Set up your Business Profile [if you haven't already] ............................................................................. 12 2Create Payment buttons [under Standard or Advanced Integration] ..................................................... 12 3Paste the generated code to your website and you're good to go. ........................................................ 12

STANDARD INTEGRATION .......................................................................................................................... 12 ADVANCED INTEGRATION.......................................................................................................................... 12

CREATE PAYMENTS BUTTON .................................................................................................... 13
INTRODUCTION ...................................................................................................................................... 13 ITEM.................................................................................................................................................... 13 CREATE AN ITEM - STANDARD INTEGRATION .................................................................................................. 14 PAYMENT FIELDS FOR ITEM ........................................................................................................................ 24
Payment Fields for Standard Integration ........................................................................................................ 24 Payment Fields for Advanced Integration ....................................................................................................... 24

CREATE A SUBSCRIPTION ......................................................................................................... 26
INTRODUCTION ...................................................................................................................................... 26 PREREQUISITES ....................................................................................................................................... 26
Subscription .................................................................................................................................................. 26

INSTANT PAYMENT NOTIFICATION (IPN) AND PAYMENT FIELDS ............................................. 40
INTRODUCTION ...................................................................................................................................... 40
What is Instant Payment Notification?........................................................................................................... 40 How is IPN set up?......................................................................................................................................... 41 Notification Fields for an Item........................................................................................................................ 44 Notification Fields for a Subscription .............................................................................................................. 46

TESTING YOUR PURCHASE PAYMENT PROCESSES.............................................................................................. 50

SECURED ACCOUNT TERMS OF SERVICE (TOS) ......................................................................... 51
HOW ALERTPAY IMPLEMENTS TOS ............................................................................................................. 51 SETTING UP TERM OF SALE (TOS) ............................................................................................................... 52 INTRODUCTION ...................................................................................................................................... 55 ERROR RESOLUTIONS ............................................................................................................................... 55

2

Merchant Integration Guide

ecaferP
Document Purpose
This document consists of guidelines for integrating individual payments and recurring/subscription payments with the AlertPay payment processing system.

Intended Audience
This document is intended for individuals having knowledge of HTML and programming (server side scripting, such as ASP, PHP, JSP, etc) to process their payments using AlertPay.
Note: Merchants must have either Personal Pro or Business account type

Notational Conventions
Document conventions increase the readability and understanding of the manual. See the following typeface descriptions:
Typeface Bold Description Used to identify links within the AlertPay website. For example: Go to My Profile ! Business Information to add or update your business information. Used to indicate all the payment variables used in HTML Code. For example: ap_merchant is the merchant email where the purchase payment is sent to. URL of merchant/ AlertPay website. For example: Return URL is http://www.returnurl.com where AlertPay sends payment information.

Courier New

http://www.acme-sample.com

3

Merchant Integration Guide

Technical Assistance
If you encounter difficulty implementing the integration process, you can contact us: Customer Support By phone: 1-514-748-5774 By email: supportdesk@alertpay.com Technical Support You can also contact our technical support department: By email: techdesk@alertpay.com

Document Revision History
Revised date March 2007 Description " Test mode for using ap_test variable at a transaction level is no longer supported by AlertPay. A new account level testing mode is now available described in section 3 " Introduced support for subscriptions/recurring billing

Sept 2008

" "

Updated Account types Updated Steps and screen shots for creating Items/Subscriptions/IPN Setup/ Adding TOS

4

Merchant Integration Guide

Business Accounts
Introduction What is a Business Account?
Business account provides seller necessary tools to meet the needs of an online Business owner. The two business account types are: Personal Pro Business With Personal Pro, you can setup your merchant profile for a business under your own personal name. Business account allows you to set up your merchant profile for businesses under your company/business name. You also have the flexibility of adding sub-business account(s) for your multiple businesses.

How to Add a sub-business account
To add a sub business account to your Business account 1. Login to your AlertPay account. 2. Click the Business Tools tab 3. Click on Manage Business Account. 4. Click on the Add button and enter your information. a. Enter an email address for this business account where the purchase payment will be sent. A seller can associate an email address for each business account or use a default email for all their business transactions. b. Enter the business name for this business account, c. Select the business industry from the list. d. Select the business category from the list. e. Enter business website URL for this business account. f. Enter the contact information either by selecting the same as my account check box this will copy contact information that was entered when you registered with AlertPay or you can enter a new address, city, province, zip code, country and phone for this business account. g. Enter the customer support email and phone number for this business account. 5. Click on the Submit button

5

Merchant Integration Guide

Step 1: Add a sub-business account [Click on ‘Manage Business Account’]

Step 2: Add a sub-business account [Click on Add]

6

Merchant Integration Guide

Step 3: Add a sub-business account [Enter your Information]

Step 4: Add a sub-business account [Click Submit]

7

Merchant Integration Guide Editing your Business Account
Editing Personal Pro Account: 1. 2. 3. 4. 5. Login to AlertPay Click on Business Tools tab. Click on Manage Personal Pro Account Enter any information that you need to update Click on the Update button

Step 1: Edit Personal Pro Account – [Click on Manage Personal pro Account]

Step 2: Edit Personal Pro Account – [Enter the updated Info.]

8

Merchant Integration Guide

Step 3: Edit Personal Pro Account – [Successfully updated]

Editing Business Account: 1. 2. 3. 4. Login to AlertPay Click on Business Tools tab. Click on Manage Business Account Click on the icon under Edit for the business account for which you want to update the profile. 5. Enter any information that you need to update 6. Click on the Submit button

9

Merchant Integration Guide

Step 1: Edit Business Account – [Click on Manage Business Account]

Step 2: Edit Business Account – [Click on Manage Business Account]

10

Merchant Integration Guide
Step 3: Edit Business Account – [Enter the details]

Step 4: Edit Business Account – [Click Submit]

11

Merchant Integration Guide

Set up your website with AlertPay
Prerequisites
You must be a Personal Pro or Business account holder. To setup your website with AlertPay: 1- Set up your Business Profile [if you haven't already] 2- Create Payment buttons [under Standard or Advanced Integration] 3- Paste the generated code to your website and you're good to go. Standard IntegrationStandard Integration is designed for merchants who want a quick and controlled setup for their customers to make purchases on their website. How it works: • There is no programming knowledge required to get started. • Setup and store your item with AlertPay • Customized payment links are created for you to add to your site. (Html code, link code, or email code). • Item information and pricing can be easily updated in real-time. Suggested Use: • After your website is live, changing your item details or pricing can be managed through AlertPay in real-time without requiring you to update or edit the links on your website. Advanced Integration Advanced Integration is designed for merchants who are currently managing their own data or want the traditional “Buy Now” button. Combined with the AlertPay Integration Guide, you can easily integrate AlertPay into your existing shopping cart or e-commerce application. How it works: • Basic knowledge of programming is required. • Create a product or service “Buy Now” or “Subscribe Now” button and AlertPay generates all the code you require for your website. • Your Items/Subscriptions are not stored at AlertPay IPN integration: IPN stands for Instant Payment Notification. By default, you will always get email notifications when your items are purchased. Additionally you can easily integrate IPN to take advantage of real time communication for items/ buttons created under either Standard or Advanced Integration. Please check the section on IPN
Note: Use of IPN (Instant Payment Notification) requires knowledge of a scripting language. (PHP, ASP, ASP.NET...)

12

Merchant Integration Guide

Create Payments Button
You can create payment buttons for either an Item or a Subscription

metI na etaerC
Introduction Item
An item is a single purchase item and does not reoccur. Item Payment Process Diagram 13

Merchant Integration Guide Create an item - Standard Integration
1. 2. 3. 4. Login to AlertPay Click on Business Tools tab Click on Manage Items Select the business account email for which you want to create the item [ For Business Account only] 5. Click on the Add button Under Item section a. Select the type of product you are selling. b. Enter in the name of the product. This is a required field. c. Enter in description. This is optional. d. Enter in product code. This is for your use and is optional. e. Select a button Graphic that suits your needs. Click Change Graphic to choose a button different then the default one. Under Pricing section f. Choose a currency type. g. Enter the amount for the item. This is a required field. h. In Advanced Options, you can enter additional amounts for shipping & handling, discount or tax amounts. This is optional. Under URL Setup section i. j. Enter in the return URL. This URL is where the buyer will be redirected to after completing a payment successfully. Cancel URL is where the buyer will be redirected to if the cancel button is pressed before payment is completed. This is optional.

Under Custom Field section k. Click on Add Additional Field to pass extra information about your item. You can add up to 6 custom fields. This is optional. This is not displayed on the Pay Process 6. Click on the Finish button 7. A copy of the generated code is ready for you to use. 8. Depending on your needs, select either the HTML code or Link code. Copy and paste on to your website and your button or link is ready for use.

14

Merchant Integration Guide

Step 1: Add an item - [Click on Manage Items]

Step 2: Add an Item – [Click on Add]

15

Merchant Integration Guide

Step 3: Add an Item – [Enter Item details and Click Finish]

16

Merchant Integration Guide

Step 4: Add an Item – [Generated code for your payment button/link]

17

Merchant Integration Guide Editing an Item – Standard Integration
Your item details are stored with AlertPay. If you need to update the details of your item, you do not need to generate new code, simply edit your existing item details: 1. 2. 3. 4. 5. 6. 7. Login to AlertPay Click on Business Tools tab. Click on Manage Items. Select the business account email profile [For Business Account only]. Click on the Edit icon for the respective item. Edit Item details Click on Finish

Step 1: Edit an Item – [Click on Manage Items]

18

Merchant Integration Guide

Step 2: Edit an Item – [Click on the Edit Icon]

Step 3: Edit an Item - [Edit item details]

19

Merchant Integration Guide

Step 4: Edit an Item [Updated Code]

20

Merchant Integration Guide Creating an Item – Advanced Integration
Advanced Integration is similar to Standard Integration except the item details are not stored with AlertPay. The HTML form code and text link code is all contained in the generated code. This option gives the flexibility to change values “on the fly” through a 3rd party application such as a shopping cart. If you change any item details, the code will need to be edited manually or you would need to add a new item to generate new code.

Step 1: Generate a Buy Now button – [Click on ‘Generate a Buy Now button’]

21

Merchant Integration Guide

Step 2: Generate a Buy Now button – [Enter Item details]

22

Merchant Integration Guide

Step 3: Generate a Buy Now button – [Generated Code for your payment button/link]

Note: To edit an item created under Advanced Integration, you will need to edit the code manually at your end or create a new Item.

23

Merchant Integration Guide

Payment fields for Item
AlertPay accepts the following fields depending on type of setup. Payment Fields for Standard Integration Payment fields for Standard Integration are same for subscription and item. Fields
ap_quantity

Product_id

Description The number of items that seller included in this purchase. It is a required field and must be a number. If empty is posted, quantity is equal to 1. An encrypted product id to find the product and a required field.

Payment Fields for Advanced Integration
Payment Fields for an Item

Fields
ap_purchasetype

ap_merchant

ap_itemname ap_description ap_quantity

ap_amount ap_additionalcharges

Description The type of purchase, it is a required field, and must have one of the following value. 1. Auction item 2. Service 3. Goods 4. Others Business email address associated with this purchase. It is required field. If email does not exist will be associated with default business account. The name Seller provided for the item, it’s an optional field. The description seller provides for this item. It’s an optional field The number of items that seller includes in this purchase. It is a required field and when it is empty, is considered as 1. The cost of each individual item and is a required field Any additional charges associated with the purchase, it is an optional field. An optional field for Shipping and handling charges if there are any.

ap_shippingcharges

24

Merchant Integration Guide
ap_taxamount ap_discountamount

Any tax amount if applicable and is an optional field Any special discount, this will be subtracted from the total amount, it is an optional field. The final amount paid by the buyer and transferred to your account. If quantity is more than 1 then this field is posted and it is required field. The required currency field the payment was made in.

ap_totalamount

ap_currency

ap_test

Deprecated. Only 0 is an acceptable value. All other values will result in an error and is no longer accepted for value=1

ap_itemcode apc_1 to apc_6

The product code, an optional field for seller to refer to the product. The optional values you entered for custom field 1 to field 6.

25

Merchant Integration Guide

noitpircsbuS a etaerC
Introduction Prerequisites
You must be a Personal Pro or Business account holder.

Subscription
A subscription is defined as a product or service that has a time, duration and recurrent billing; that a dollar amount is being charged on a daily, weekly, monthly or yearly basis. You can use the integration tools to add the “Subscribe Now” button to your website. A user can click on that button and fill out their subscription. Funds for the subscription are withdrawn from the user’s AlertPay account. How Payment Works: 1. 2. 3. 4. You set up a subscription details on the AlertPay website. Integrate the “Subscribe Now” button on your website. Buyer clicks on the button. Funds are withdrawn from the buyer’s AlertPay on the subscription due date. If there are insufficient funds in the account 5. User can add a secondary payment method of bank account or credit card to use when there are insufficient funds in their AlertPay account. If the user chooses a secondary payment method, that will apply to all subscriptions in their profile. Payment Types 1. Trial Duration Payment: • The buyer will see this as “Trial Amount”. This means that for their subscription, they are paying a certain price for the “trial period” 2. First Subscription Payment: • The buyer will see this as “Discount Amount”. Depending on the subscription the buyer has subscribed, they may pay an initial amount or a discount amount until the regular amount is charged. 3. Recurrent Subscription Payment: • The buyer will see this as 'Subscription Amount' and it is the recurring amount of the subscription

26

Merchant Integration Guide

Subscription Purchase Payment Process Diagram

27

Merchant Integration Guide

Create a subscription – Standard Integration
1. 2. 3. 4. Login to AlertPay Click on Business Tools tab. Click on Manage Subscriptions Select the business account email for which you want to create the subscription [For Business Account only] 5. Click on the Add button Under Item section a. Enter in the name of the product. b. Enter in description if there is any. c. Enter in product code. This is for your use and is optional. Under Pricing section d. Choose a currency type. e. Enter the amount for the item. This is a required field. f. In Advanced Options, you can enter additional amounts for setup, shipping & handling, discount or tax amounts. This is optional. g. Select a button Graphic that suits your needs. You can keep the default or click Change Graphic link to choose another. Under Subscription section h. Select billing cycle. The cycle can be in days, weeks, months or years. For example, if you select a day and enter 1 in the text box. This entry means that payments will be scheduled every day. i. Select reoccurs. You can choose until cancelled or number of reoccurrences. Until cancelled means until business owner is offering this service/product. j. Select the time unit for trial period. The trial period can be in days, weeks, months or years. Enter in the number that trial period will be valid up to and choose days/weeks/months/ or years. k. Enter the trial amount. Under Custom Field section l. Click on Add Additional Field to pass extra information about your item. You can add up to 6 custom fields. This is optional. Under URL Setup section m. Enter in the return URL. This URL is where the buyer will be redirected to after a subscription is purchased successfully. n. Cancel URL is where the buyer will be redirected to if the cancel button is pressed before payment is completed. 6. Click on the Finish button 28

Merchant Integration Guide
7. Depending on your needs, select either the HTML form code or text link code. Copy and paste on to your website page and your button or link is ready for use.

Step 1: Add a Subscription – [Click on Manage Subscriptions]

Step 2: Add a Subscription – [Click on Add]

29

Merchant Integration Guide

Step 3: Add a Subscription – [Enter Subscription details]

30

Merchant Integration Guide

Step 4: Add a Subscription – [Generated Code]

31

Merchant Integration Guide

Editing a Subscription – Standard Integration
Your subscription details are stored with AlertPay. If you need to update the details of your subscription, you do not need to generate new code, simply edit your existing details: 1. 2. 3. 4. 5. Login to AlertPay Click on the Business Tools tab Click on Manage Subscriptions Select the business account email profile [For Business Account only] Click on the Edit icon for the respective Subscription.

Step 1: Edit a Subscription – [Click on Manage Subscriptions]

Note: By removing a subscription, you will no longer be able to receive payments.

32

Merchant Integration Guide

Step 2: Edit a Subscription – [Click on the Edit icon]

Step 3: Edit a Subscription – [Edit the required info.]

33

Merchant Integration Guide

Step 4: Edit a Subscription – [Updated Code]

34

Merchant Integration Guide

Create a subscription - Advanced Integration
Advanced Integration process is similar to Standard Integration except the subscription details are not stored with AlertPay. The HTML form code and link code is all contained in the generated code. This option gives the flexibility to change values “on the fly” through a 3rd party application such as a shopping cart. If you change any subscription details, the code will need to be edited manually or you would need to add a new subscription to generate new code. Step 1: Create a Subscription [Click on ‘Generate a Subscribe Now Button’]

35

Merchant Integration Guide

Step 2: Create a Subscription [Enter Subscription details]

36

Merchant Integration Guide

Step 3: Create a Subscription [Generated Code]

Note: To edit an item, you can edit the code manually at your end or create a new subscription.

37

Merchant Integration Guide

Payment Fields for a subscription Fields
ap_purchasetype ap_merchant

ap_itemname ap_description ap_quantity

Description This is a required field and for subscription must always have value=”Subscription” Business email address associated with this purchase, it’s a required field and if email does not exist will be associated with default business account. The optional field, name Seller provides for the item The optional description seller provided for this item. The number of items that seller included in this purchase. It is a required field and if not entered will be considered as 1. The cost of each individual item. It is a required field. Any additional charges associated with the purchase, this is an optional field. Optional shipping and handling charges if there are any. Any tax amount if applicable. This field is optional. Any special discount, this will be subtracted from the total amount.it’s an optional field Deprecated. Only 0 is an acceptable value. All other values will result in an error. It is no longer supported for it’s value=1. The amount that is charged once and first time only. The final amount paid by the buyer and transferred to your account. If email does not exist will be associated with default business account. It is a required field. The required field Time unit used for billing cycle, must be any one of the following: Day, Week, Month, Year. The currency the payment was made in. Currently, the value will be ‘USD’ and is a required field. The next date when amount will be charged. It is a required field for payments that are run more than once and is optional for last payment or for the only one payment. The format is yyyy:mm:dd Same as ap_timeunit but for trial period, value must be one of the following 1. Day

ap_amount ap_additionalcharges ap_shippingcharges ap_taxamount ap_discountamount ap_test

ap_setupamount ap_totalamount

ap_timeunit

ap_currency ap_nextrundate

ap_trialtimeunit

38

Merchant Integration Guide
2. Weeks 3. Months 4. Years
ap_trialtimeunit ap_trialamount

Same as ap_periodlength value must be a number and it is an optional field The optional field and is an amount during trial period, must be number , if the trial period is 0 then trial is free. The optional product code, an optional field for seller to refer to the product. Six optional fields values you enter for custom field1 to custom field6

ap_item code apc_1 to apc_6

39

Merchant Integration Guide

Instant Payment Notification (IPN) and Payment Fields
Introduction
What is Instant Payment Notification?
IPN stands for Instant Payment Notification. If you enable this for your website then AlertPay notifies you as soon as the payment for a purchase has been successfully made and posts all the payment confirmation data on your website at a URL that you provide. Alert URL: Alert URL is where AlertPay posts the payment confirmation data for you. The data consists of information of the completed purchase and buyer shipping details. You can take this captured information for post-purchase processing and authenticate the purchase by checking your security code that is sent with the data. For security reasons, we take care to ensure your Alert URL will not be known to anyone but you and AlertPay. Your Alert URL will not be included in the form created for your Buy Now buttons. It is not necessary to submit the Alert URL since AlertPay has it listed in your account profile. Security code: Your security code provides a way of authenticating that the data was sent by AlertPay. You create your security code and it is immediately encrypted so only you know the code you entered. Your security code will not change unless you enter a new code to be encrypted. You can make this change at any time, by going to IPN Setup. This encrypted security code will be sent by AlertPay with all posts to your Alert URL. You may then compare the code sent with the one in your account to be sure that AlertPay did post the information captured.

40

Merchant Integration Guide

How is IPN set up?
1. Login to AlertPay 2. Click on Business Tools tab 3. Click on IPN Setup a. Check Enable IPN. b. Enter the Alert Url c. Enter Security Code [you can enter anything for security code; characters, numbers, or a combination of both, etc., which will be encrypted once you press the Submit button] 4. Press the Submit button 5. You will be given your Encrypted Security Code

Instant Payment Notification Process Diagram

41

Merchant Integration Guide

Step 1: Set up IPN – [Click on IPN Setup]

Step 2: Set up IPN – [Enter the details and click Submit]

42

Merchant Integration Guide
Step 3: Set up IPN – [Setup successful, Encrypted Security Code generated]

43

Merchant Integration Guide

Notification Fields
The following are the fields of the form that will be posted to the Alert URL associated with the purchase. You may then extract these values and use them in your own post-purchase processing. Authenticate the post by checking the submitted security code against the one in your AlertPay member area.
: metI

n a rof sdle iF noitacifitoN
Customer Values Fields
ap_custfirstname ap_custlastname ap_custaddress ap_custcity ap_custstate ap_custcountry ap_custzip ap_custemailaddress

IPN form fields for an item will only be sent when the payment is completed successfully. It is same for simple and advanced setup Business Account holders.

Description The buyer’s first name and is optional to capture. The buyer’s last name and is optional to capture. The buyer’s street address for shipping and is optional to capture.

The buyer’s address city and is optional to capture. The buyer’s state and is optional to capture. The buyer’s country and is optional to capture. The buyer’s zip or postal code and is optional to capture.

The buyer’s email address and is optional to capture.

44

Merchant Integration Guide

Purchase Values
Fields
ap_purchasetype

ap_merchant

ap_itemname ap_description ap_quantity

ap_amount ap_additionalcharges

ap_shippingcharges ap_taxamount ap_discountamount

ap_totalamount

ap_currency

ap_referencenumber

Description The type of purchase for example: Item and is optional to capture. Must have one of the following values: 1. Auction items 2. Service 3. Goods 4. Other Business email address associated with this purchase. If email does not exist will be associated with default business account and is optional to capture. The name Seller provided for the item and is optional to capture. The description seller provided for this item and is optional to capture. The number of items/services that seller included in this purchase and is optional to capture. The cost of each individual item and is optional to capture. Any additional charges associated with the purchase, this is an optional field and is optional to capture. Shipping and handling charges if there are any and is optional to capture. Any tax amount if applicable and is optional to capture. Any special discount, this will be subtracted from the total amount and is optional to capture. The final amount paid by the buyer and transferred to your account. If email does not exist will be associated with default business account and is optional to capture. The currency the payment was made in. Currently, the value will be ‘USD’ and is optional to capture. A unique number associated with the purchase. This is the same number given to the buyer for

45

Merchant Integration Guide
easy referencing and is optional to capture. If ap_test=1 means the business account used is in test mode and if ap_test=0 means it is live . default is 0 and is optional to capture. The status of the transaction. The value will be “Success” and is optional to capture. The product code, an optional field for seller to refer to the product. The value you entered for custom field 1 to customer field 6 and are optional to capture. Your encrypted security code that you should use to confirm this posted information came from AlertPay. Compare it to the encrypted code in your account and is optional to capture.

ap_test

ap_status

ap_item code apc_1 to apc_6

ap_securitycode

For a subscription purchase payment, the form fields will only be sent when the first subscription payment is completed successfully or in other words subscription is setup successfully. It is same for simple and advanced setup Business Account holders. Customer Values Fields
ap_custfirstname ap_custlastname ap_custaddress

Description The buyer’s first name and is optional to capture. The buyer’s last name and is optional to capture. The buyer’s street address for shipping and is optional to capture.

ap_custcity

The buyer’s address city and is optional to capture. The buyer’s state and is optional to capture. The buyer’s country and is optional to capture.

ap_custstate ap_custcountry

:

noit pircsbuS a rof sdle iF noitacifitoN

46

Merchant Integration Guide
ap_custzip

The buyer’s zip or postal code and is optional to capture.

ap_custemailaddress

The buyer’s email address and is optional to capture.

Subscription Values Fields
ap_purchasetype ap_merchant

ap_itemname ap_description ap_quantity ap_amount ap_additionalcharg es ap_shippingcharges ap_taxamount ap_discountamount ap_totalamount

ap_currency ap_referencenumber ap_subscriptionref erencenumber ap_status

Values This field has always default value which is “Subscription” and is optional to capture. Business email address associated with this purchase. If email does not exist will be associated with default business account and is optional to capture. The name Seller provided for the item and is optional to capture. The description seller provided for this item and is optional to capture. The number of items/services that seller included in this purchase and is optional to capture. The cost of each individual item in subscription and is optional to capture. Any additional charges associated with the purchase, this is an optional field and is optional to capture. Shipping and handling charges if there are any. Any tax amount if applicable and is optional to capture. Any special discount, this will be subtracted from the total amount and is optional to capture. The final amount paid by the buyer and transferred to seller’s account. If email does not exist will be associated with default business account and is optional to capture. The currency the payment was made in. Currently, the value will be ‘USD’ and is optional to capture. A unique number associated with the purchase. This is the same number given to the buyer for easy referencing. A unique number starts with “S” associated with the purchase. This is the same number given to the buyer for easy referencing and is optional to capture. The status of the subscription transaction and is optional to capture and must have one of the following value: 47

Merchant Integration Guide
1. 2. 3. 4. 5.
ap_item code

Success Subscription-Payment-Success Subscription-Payment-Expired Subscription-Payment-Success Subscription-Payment-Canceled

ap_timeunit

ap_periodlength

ap_periodcount

ap_nextrundate

ap_trialtimeunit ap_trialperiodleng th ap_trialamount

ap_test

apc_1 to apc_6

The product code, an optional field for seller to refer to the product when he has more than one product associated with same or different business accounts is an optional to capture. Time unit used for billing cycle, must be any one of the following: Day, Week, Month, Year This number is associated with ap_timeunit for subscription and is optional to capture. For example if you have ap_timeunit is Day and you ap_periodlength is 2, this means every 2 days the amount will be charged and is optional to capture. The number of times amount will be charged, in case of until the product is available this will have value=0 and is optional to capture The next date when amount will be charged and is optional to capture , there won’t be a date in case of last subscription payment or the first and the only subscription payment. Same as ap_timeunit but for trial period, value must be one of day, weeks, months, years Same as ap_periodlength value must be a number and is optional to capture. The amount during trial period, must be number , if the trial period is 0 then trial is free and it’s optional to capture. If ap_test=1 means the business account used is in test mode and if ap_test=0 means it is live . default is 0 and it’s optional to capture. The value you entered for custom field 1 to custom field 6 and are optional to capture. Your encrypted security code that you should use to confirm this posted information came from AlertPay. Compare it to the encrypted code in your account and is optional to capture.

ap_securitycode

48

Merchant Integration Guide

Payment States/Statuses 1. Success: • Subscriber has setup the subscription and paid the first payment successfully. 2. Subscription-Payment-Success: • Means subscription amount for this rundate is paid successfully. 3. Subscription-Payment-Expired: • Means total amount for the product for all the subscriptions are paid successfully. 4. Subscription-Payment-Failed: • Means after that buyer does not have enough funds for the subscription payment and run date will be rescheduled two times. 5. Subscription-Payment-Canceled: • Means seller explicitly cancels the subscription or AlertPay cancelled or it was cancelled since buyer didn’t have enough money after rescheduling two times.

49

Merchant Integration Guide

Testing your Purchase payment processes
AlertPay provides a feature that allows you to test the entire payment process including subscription payment - from clicking the button (as the buyer) to IPN receipt. No transaction is created during this testing phase; however you will be able to complete the entire process and receive test confirmation emails. Please note that AlertPay no longer supports the ap_test variable for enabling test mode for IPN.That is ap_test=1 but it won’t have effect for ap_test=0. In order to enable test mode on particular business account please follow these steps: To turn Test Mode on/off: [Personal Pro Account] 1. 2. 3. 4. Login to AlertPay Click on Business Tools Click on IPN Setup [under "Instant Payment Notification IPN" section] Check/Uncheck Test Mode

To turn Test Mode on/off: [Business Account] 1. 2. 3. 4. 5. Login to AlertPay Click on Business Tools Click on IPN Setup [under "Instant Payment Notification IPN" section] Choose the Business Account email for which you want to turn the Test mode on/off Check/Uncheck Test Mode

Note: AlertPay still posts ap_test=1 if the business account is in test mode and ap_test=0 for the account is live to the Alert URL of the business account setup for the specific item or subscription.

50

Merchant Integration Guide

)SOT( ecivreS fo smreT tnuoccA deruceS
Most online businesses will receive complaints from time to time. Some complaints can (and should) be resolved by you (the business owner) without requiring AlertPay to become involved. If AlertPay does have to become involved in the dispute, the AlertPay Secured Account helps to protect you against chargeback claims by allowing you to create a Terms of Service (also includes Refund Policy). AlertPay will use your Term of Sale to assist in resolving any disputes. Your Terms of Service ensures that customers are aware and understand your policies and agree to these terms and policies prior to completing a purchase. Your TOS will be shown to customers when they are about to pay for their purchase within AlertPay. They will be required to accept your TOS before the payment is completed and sent to you. This extra requirement step is the benefit of the Secure Account.

How AlertPay Implements TOS
If a customer files a complaint against a seller to AlertPay and requests a payment reversal or refund, the seller will be advised by AlertPay regarding the pending complaint. AlertPay will allow the buyer the time to settle this matter with the customer accordingly. AlertPay’s role is not to be involved in the buyer’s purchase dispute. Since AlertPay merely provides the means of payment, it is the buyer’s responsibility to resolve any complaints in a timely manner. If the complaint cannot be settled by the seller and the buyer, AlertPay’s Resolution department will become involved to help settle this dispute. AlertPay will analyze the complaint based upon the seller’s TOS pertaining to that transaction and decide the matter accordingly. If a seller has satisfactorily provided the complete service or product according to the TOS the buyer agreed to prior to completing the purchase, AlertPay will review the seller’s refund policy (stated in the applicable TOS) and apply it to the transaction. If a seller provides a service sufficiently, AlertPay will honor this policy. However if the purchase product or service is not as described, the refund policy will be waived and no longer honored, and the dispute will be settled by AlertPay accordingly. It is best to make a clear and honest TOS that a seller will fulfill accordingly when a dispute arises.

51

Merchant Integration Guide Setting up Term of Sale (TOS)
TOS can be setup for Personal Pro or Business Account types. TOS can be setup by following these steps. 1. Login to AlertPay 2. Click on Business Tools 3. Under Resources, click on Terms of Service 4. Select the email address and then click the Add button. 5. Enter the name of TOS and then enter in the details of the policy. 6. Click on the Add button and your TOS policy will be saved. Step 1: Adding TOS Policy – [Click on Terms of Service]

Step 2: Adding TOS Policy – [Choose Email and Click on Add]

52

Merchant Integration Guide

Step 3: Adding TOS Policy – [Enter details and click Add]

53

Merchant Integration Guide

Step 4: Adding TOS Policy – [Successfully Added]

54

Merchant Integration Guide

Error Resolution
Introduction
Errors that business account holder or buyer gets after clicking on the item /subscribe now buttons, all the errors are due to the issues or problems with the business account holder.

Error Resolutions
The following is a guide to troubleshooting in Business Tools Error Message: We're sorry; this email does not exist with AlertPay. Solution: The email address associated with the business account needs to be added by following these steps. 1. 2. 3. 4. 5. 6. Login to AlertPay Click on Profile Under Personal Section - Click on Email Addresses. Click on Add New Enter the email address and click on Save. You will receive a validation email from AlertPay on the email address you just added. Follow the instructions in the email to validate the email.

Error Message: We're sorry; this seller's account does not permit selling online. Account upgrade is required. Solution: The Seller needs to upgrade his account by following these steps. 1. Login to AlertPay 2. Under the Message Center section click on Upgrade your Account 3. Read the information given about Personal Pro Account, then click the Upgrade Your Account button at the bottom Note: To upgrade your account to Business, please contact customer support by submitting a ticket from http://helpdesk.alertpay.com Error Message: We're sorry, the business profile for this account has not been set up by this seller. Solution: The Seller may have this error because: 1. The seller may have removed merchant profile. 2. The seller does not have merchant profile. 55

Merchant Integration Guide
3. The seller email is empty or incorrect in HTML button Code. To resolve this issue go to Manage Personal Pro or Manage Business Account and check/update the email address associated to your merchant profile. For reasons 1 and 2, you might need to add a merchant profile, by following the procedure for Add a sub-Business account.

Error Message: We're sorry; this email has not been validated by seller. Solution: The Seller needs to validate the email address used in this product. The seller should retrieve the validation email sent by AlertPay and follow the instructions provided in the email. Error Message: Test mode deprecated, the posted field ap_test has been deprecated. To test your buttons turn on test mode in your business account Solution: To test your payments, you must not use ap_test=1 in your button/link/email code only ap_test=0 is acceptable, to setup your business account see how to setup test mode section. If you require any general help integrating your website with AlertPay, please contact us by submitting a ticket through http://helpdesk.alertpay.com or send an email to techdesk@alertpay.com. Please attach the HTML code which is causing errors or problems. We will be glad to assist you with your integration issues however we cannot help debug your integration code.

56

Sign up to vote on this title
UsefulNot useful