Configure payment gateways

📝 Note: If the AppDirect logo appears in the upper-left corner of the page, when Manage > Marketplace appears in this topic, click the grid icon > Switch to | Store, instead.

Marketplace Managers can configure several payment gateways without AppDirect technical support assistance. One payment gateway can be active in production. The PayPal Express Checkout payment gateway is an exception: it can be the only active payment gateway, or it can be active in addition to one other payment gateway.

❗ Important: Do not attempt to switch or delete gateways. Doing so can result in missed payments or lost customer billing information. Contact your AppDirect technical representative if you have questions.

This topic includes:

• Prerequisites that must be complete before you configure a payment gateway in AppDirect.
• A glossary of payment processing terms.
• Procedures to configure each self-service payment gateway.

Prerequisites

The following off-platform prerequisites must be complete before you configure a payment gateway in AppDirect. Marketplace Managers, or other representatives from the organization to which they belong, may complete them. A glossary of the italicized terms follows the prerequisites.

1. Register with a merchant services provider. A merchant services provider offers several merchant services:

   • A merchant account to temporarily hold sales proceeds until they are released to the bank account that belongs to you, the merchant. The provider gives you text strings that identify your merchant account. By default, AppDirect returns these mandatory values to the payment gateway with every transaction.
   • The settlement of funds between the receiving bank (your bank), the paying bank, the credit card company, and your merchant service provider, for each transaction.
   • A payment processor to transfer credit card data between all the parties involved in each transaction such as the banks and credit card company.

2. Register with a payment gateway services provider. A payment gateway provider manages secure authorizations for payments and formats the payment information so that it can be transmitted by a payment processor. The payment gateways that AppDirect supports by default appear on this page: Manage > Marketplace > Settings > Payment Gateway. For more information about each gateway, see Select payment gateways.

3. Give your merchant services provider account information and identifiers to your payment gateway provider so that they can link the gateway and payment processor. The payment gateway provider gives you your payment gateway account information, which you use to configure the payment gateway in AppDirect.

   ❗ Important: Confirm with the merchant services and payment gateway providers that their services are compatible with each other.

Glossary of payment processing terms

Merchant—The seller of products and services. It is the organization that owns the AppDirect marketplace . To support payment processing, the marketplace owner registers for a merchant account from a merchant services provider and registers as a merchant with a payment gateway provider.

Merchant account—An online funds account that a merchant services provider offers and assigns to the merchant. After a sale, the funds are sent to the merchant account and the merchant services provider holds them until fund settlement completes (usually a few days). Then, the merchant services provider transfers the proceeds from the merchant account to the merchant's bank account.

Merchant services—The services that merchant service providers offer vary but often include the following:

• Merchant accounts
• Credit card authorization
• Settlement of funds

Merchant services provider—A company that offers merchant services. (Some payment gateway providers also offer merchant services.)

Payment gateway—A payment gateway manages secure transactions. For credit card transactions, it puts transaction information into a format that a payment processor can transmit.

Payment gateway provider—A company that offers payment gateway services. It may also provide some merchant services.

Payment processor—A service offered by merchant services providers. It enables credit card transactions by transmitting payment data between the parties involved. For example, the point of sale, the bank that issued the credit card, and the acquiring bank (the merchant's bank).

Settlement of Funds—The management and disbursal of funds between the parties involved in a transaction. Parties that can potentially be involved include the following:

• A merchant service provider
• An issuing bank (the bank that issued the card or provides the bank account to the purchaser)
• A credit card company
• An acquiring bank (the merchant's bank—it acquires the funds from the payment)

Payment gateway configuration procedures

For information from PayPal that augments this documentation, see PayPal Developer - PayPal Payflow Pro.

1. Go to Manage > Marketplace > Settings >BILLING SETTINGS |Payment Gateway. The Payment Gateways page opens. It displays the payment gateways that Marketplace Managers can configure without AppDirect Support assistance.
2. Click Activate beside PayPal Payflow Pro. The Payment Gateways configuration page for PayPal Payflow Pro opens.
3. (Required) Enter the Developer login—PayPal Payflow Merchant Login, also known as Payflow Merchant Login, Payflow Services Merchant Login, Login ID and Vendor, for the Payflow account. It was created during PayPal Payflow Pro account registration and is the same one that the account administrator uses to log on to the Paypal Manager using Payflow credentials on the Paypal website.
4. (Might be required) Enter the User login—User Name for the user that the PayPal Payflow Pro account administrator authorized to process transactions through this account. It is optional for your company’s PayPal Payflow Pro account administrator to create and authorize a user to process transactions. To do so, he or she completes the authorization in PayPal Manager on the PayPal website. The following are valid entries:
   • Blank (default)—If the administrator did not authorize a specific user, leave this field blank.
   • User name for the authorized user—If the administrator authorized a specific user, enter the PayPal Payflow Pro user name with which the authorized user logs on to the Paypal Manager using Payflow credentials on the Paypal website.
5. (Required) Enter the Password—PayPal Payflow Pro account credential with which the account administrator, or the authorized user, logs on to the Paypal Manager on the Paypal website. Enter one of the following:
   • If there is a User Login for you to enter in the previous field, enter that user's password in this field.
   • If there is not a User Login for you to enter in the previous field, enter the administrator's PayPal Payflow Pro account password.
6. (Required) Enter the Partner—ID for the entity through which your organization purchased PayPal Payflow Pro. The ID is in the welcome email sent after you purchased PayPal Payflow Pro. Enter one of the following:
   • PayPal as the ID if your organization purchased PayPal Payflow Pro through Paypal.
   • The ID provided by the authorized PayPal reseller who sold your organization PayPal Payflow Pro, if your organization purchased it through a reseller.
7. (Optional) Complete Test mode—Process transactions in test mode as test, not real, transactions. The following are valid entries:
   • False or blank (default)—Test mode is off. AppDirect sends transaction requests to a production endpoint and the payment gateway processes them. Use this setting for production.
   • True—Test mode is on. AppDirect sends transaction requests to a test endpoint and flags them as test transactions. Do not use this setting for production.
8. (Optional) Complete Environment—User-defined name to identify the environment from which the Paypal Payflow Pro transactions originate. The following are valid entries:
   • Blank (default)—If only one environment for the same marketplace is integrated with the Paypal Payflow Pro account, there is no need to identify the environment from which the Paypal Payflow Pro transactions originate. No environment name appears on Paypal Payflow Pro transaction reports in the column with Header Name name X-VPS-VIT-INTEGRATION PRODUCT.
   • Name of the environment—If more than one environment for the same marketplace is integrated with the Paypal Payflow Pro account, enter a name that you choose to identify the environment from which these payment requests originate. The name appears on Paypal Payflow Pro transaction reports in the column with Header Name name X-VPS-VIT-INTEGRATION PRODUCT.
9. (Optional) Complete AVS enabled—Address Verification System (AVS) validates the address and security code that customers enter for credit card transactions against the ones on file with the customers' bank. The following are valid entries:
   • True or blank (default)—AVS is on. AppDirect accepts payments on behalf of the marketplace when Paypal Payflow Pro confirms that they are approved by the payment processor, and the address and credit card security code that the customers enter match those on file with the customer’s bank.
   • False—AVS is off. AppDirect accepts payments when Paypal Payflow Pro confirms that they are approved by the payment processor, without validation that the address and credit card security code that the customers enter match those on file with the customer’s bank.
10. (Optional) Enter Merchant description—Marketplace Manager-defined description or name of your organization or marketplace. The following are valid entries:
    • Blank (default)—No merchant description to identify the vendor from which customers purchased the product or service appears on the customers' transaction statement.
    • Your organization's description or name—Appears on the customers' transaction statements to identify the vendor from which they purchased the product or service. Maximum 22 characters unless overridden by an entry in the Maximum description length field (see later step in this procedure).
11. (Optional) Complete Merchant contact—Contact information for the merchant (your organization or marketplace). The following are valid entries:

• Blank (default)—No merchant contact information appears on the customer's transaction statement.
• Your organization's contact information—Appears on the customer's transaction statement so that they can contact the merchant from which they purchased the product or service.

11. (Optional) Complete AppNameIn description—Whether or not to include the name of the product that the customer purchased in the merchant description. The following are valid entries:

• Blank (default)—Product name does not appear in the merchant description section of the customer’s transaction statement.
• True—Product name appears in the Merchant Description section of the customer’s transaction statement.

12. (Optional) Complete Maximum description length—Maximum allowable number of characters for the Merchant Description on the customer’s transaction statement. The following are valid entries:

• False or blank (default)—Default value for the maximum number of characters for the merchant description remains 22.
• Greater or less than 22—Overrides the default maximum number of 22 characters for the merchant description.

13. Click Activate when you save the configuration the first time, or Save Settings when you save it subsequently. The Payment Gateways page opens and displays PayPal Payflow Pro with the status Activated.

Configure Authorize.net payment gateway

For information from Authorize.net that augments this documentation, see Developer.Authorize.Net.

1. Go to Manage > Marketplace > Settings > BILLING SETTINGS | Payment Gateway. The Payment Gateways page opens. It displays the payment gateways that Marketplace Managers can configure without AppDirect Support assistance.
2. Click Activate beside Authorize.net. The Payment Gateways configuration page for Authorize.net opens.
3. (Required) Enter the Login—API Login ID from Authorize.net. The account administrator logs on to the Authorize.net Merchant Interface and from within it, generates the API Login ID once.
4. (Required) Enter the Transaction key—Transaction key from Authorize.net. The account administrator logs on to the Authorize.net Merchant Interface and from within it, generates the Transaction key. If the key is lost, the account administrator logs on to the Authorize.net Merchant Interface and from within it, finds and uses the Secret Question and Answer to generate a new transaction key.
5. (Optional) Complete Test—Process transactions in test mode as test, not real, transactions. The following are valid entries:
   • False or blank (default)—Test mode is off. Transactions are sent to the Authorize.net live API endpoint. Use for production.
   • True—Test mode is on. Transactions are sent to Authorize.net test API endpoint (https://apitest.authorize.net). Do not use for production.
6. (Optional) Complete Customer email—Identify customers and their associated Authorize.net customer profile (account) with either their email address or the default of merchantCustomerId. The following are valid entries:
   • False or blank (default)—Identify customers and their associated Authorize.net customer profile (account) with the merchantCustomerId in all transaction messages.
   • True—Identify customers and their associated Authorize.net customer profile (account) with their email address in all transaction messages.
7. Do not edit AUTHORIZE_NET.uselso3CountryCode—AppDirect use only for custom integrations.
8. Click Activate when you save the configuration the first time, or Save Settings when you save it subsequently. The Payment Gateways page opens and displays Authorize.net with the status Activated.

Configure PayPal Express Checkout payment gateway

Off-platform prerequisite: The merchant services provider must enable reference transactions for the merchant account.

1. Go to Manage > Marketplace > Settings > BILLING SETTINGS | Payment Gateway. The Payment Gateways page opens. It displays the payment gateways that Marketplace Managers can configure without AppDirect Support assistance.
2. Click Edit beside PayPal Express Checkout. The Payment Gateways page appears in edit mode.
3. Edit the fields.
4. Click Activate when you save the configuration the first time, or Save Settings when you save it subsequently. The Payment Gateways page opens and displays PayPal Express Checkout with the status Activated.

Configure Authorize.Net payment gateway

1. Go to Manage > Marketplace > Settings > BILLING SETTINGS | Payment Gateway. The Payment Gateways page opens. It displays the payment gateways that Marketplace Managers can configure without AppDirect Support assistance.
2. Click Edit beside Authorize.Net. The Payment Gateways page appears in edit mode.
3. Edit the fields.
4. Click Activate when you save the configuration the first time, or Save Settings when you save it subsequently. The Payment Gateways page opens and displays Authorize.net with the status Activated.

Configure BlueSnap payment gateway

1. Go to Manage > Marketplace > Settings > BILLING SETTINGS | Payment Gateway. The Payment Gateways page opens. It displays the payment gateways that Marketplace Managers can configure without AppDirect Support assistance.
2. Click Edit. The Payment Gateways page appears in edit mode.
3. Enter your BlueSnap API Username and Password for production (or sandbox for testing purposes).
4. (Optional) Turn on Add ACH Payment to accept ACH payments. This toggle appears when BlueSnap is your payment gateway and AppDirect has enabled ACH for the marketplace. BlueSnap must also enable your account for ACH transactions.
5. Edit the fields.
6. Click Activate when you save the configuration the first time, or Save Settings when you save it subsequently. The Payment Gateways page opens and displays BlueSnap with the status Activated.

Configure WorldPay payment gateway

1. Go to Manage > Marketplace > Settings > BILLING SETTINGS | Payment Gateway. The Payment Gateways page opens. It displays the payment gateways that Marketplace Managers can configure without AppDirect Support assistance.
2. Click Edit beside WorldPay. The Payment Gateways page appears in edit mode.
3. Edit the fields.
4. Click Activate when you save the configuration the first time, or Save Settings when you save it subsequently. The Payment Gateways page opens and displays WorldPay with the status Activated.