Payment Plugin Configuration Parameters
Demo Payment
Demo Payment is a dummy payment plug-in shipped with Billing. Accepting transactions, it processes them as real ones, but does not pass them on to the financial institutions. Demo Payment is also a sample for building custom payment plug-ins. Refer to the CloudBlue Commerce Payment SDK Guide for details. The plug-in can operate both in redirect and tokenized modes.
Enable Tokenization Mode. The option defines the operating mode of Demo Payment plug-in:
- When the tokenzation mode is enabled, Demo Payment plug-in allows the customer to save payment method details for future payments, in which case Billing stores a token that represent this payment method in Billing. For the subsequent payments the customer may choose to use the saved payment method or get redirected to the Demo Payment page to use another payment method.
- When the tokenzation mode is disabled, Demo Payment plug-in operates in the redirect mode: for every payment the customer is redirected to the Demo payment page.
For recurring payments to be processed by Demo Payment plug-in, it is required that the plug-in operate in tokenized mode.
Logging errors
By default, responses from the processing center are written to /var/log/httpd/payment-sdk.log
.
2Checkout
2Checkout is an online payment processing center that accepts transactions via API. For information, visit their official site (https://www.2checkout.com). The plug-in operates in modal mode.
Publishable Key. The API key to identify your account with 2Checkout; can be safely passed within browser. Publishable key can be used when creating tokens.
Private Key. The API key that can perform any API request to 2Checkout without restriction. Should be kept confidential and only stored on your own servers. Private Key and Publishable Key can be found under API tab in your 2Checkout account.
Seller ID. Your 2Checkout account ID.
Secret Word. The secret word which is set at 2Checkout account.
Sandbox Mode. The option indicates whether the transactions are processed in test mode:
- In the Sandbox mode, all transactions appear to be processed as real transactions. The gateway accepts the transactions, but does not pass them on to the financial institutions.
- For production environment, this option should be disabled.
Username and Password – the credentials to authenticate with 2Checkout; generated at 2Checkout account page.
Logging errors
If enabled, responses from processing center will be written to /var/log/httpd/payment-sdk.log
ASSIST
ASSIST processing center is of the redirect processing type. On purchase attempt, a customer is redirected to the processing center web gate where they are prompted to confirm the payment. On approval, the payment is processed online. On successful response from the processing center, Billing releases the payment and starts provisioning services. For more information about ASSIST, visit their official site (http://www.assist.ru).
Assist Shop ID. The unique identification number that you received from ASSIST.
Login and Password. The unique login identification information that you received from ASSIST.
Shared Secret. The secret word should be stated if synchronous notifications are enabled for ASSIST payment system. See the Configuring Synchronous Notifications section for details.
Demo mode. The option sets up ASSIST plug-in to function in a testing or working mode.
- If the Demo mode is turned On, the plug-in functions in a testing mode. The authorizations are not sent to the payment center, ASSIST sends back the response of the type you have chosen from the Response Code list.
- When you turn Off the mode, the plug-in starts functioning in the working mode, authorizations are sent to the payment center and the transactions are being processed.
Authorize.Net
AuthorizeNet is an online payment processing center that accepts transactions via API. For information, visit their official site (http://www.authorize.net/). The plug-in can operate both in redirect and tokenized modes.
API Login ID and Transaction Key. The login credentials obtained from AuthorizeNet when subscribing to their services.
Test Mode. The option indicates whether the transactions are processed in test mode:
- In the Test mode, all transactions appear to be processed as real transactions. The gateway accepts the transactions, but does not pass them on to the financial institutions.
- For production environment, this option must be disabled.
Logging errors
By default, responses from the processing center are written to /var/log/httpd/payment-sdk.log
.
BankGIRO
BankGiro (http://www.bgc.se) is a payment system of an offline type that generally works as follows: when a customer uses it to pay for ordered services, a payment is created in Billing. Based on the payment, the OCR number containing information about the payment amount and checksum is composed using the Mod10 method. The customer is sent a specially configured notification with provider account information in the processing center and the OCR number. Then the customer pays for the order with a reference to the OCR number in a bank or a post office. The processing center processes the payment, puts information about it into a text file of a special format and sends the file to Billing. Payments from the file are then to be imported to Billing (Operations > BankGiro/PostGiro Import).
Account. The identifier and name of the plug-in settings owner.
Path to Archive Directory. The path to the archive directory on the Billing server where payments files received from processing center are stored.
eWAY
eWAY is a global omnichannel payment provider, processing secure credit card payments for merchants around the world. For more information, visit their official site https://eway.io/. The payment gateway operates both in redirect and tokenized modes.
API Key and API Key Password. The login credentials obtained from eWAY when subscribing to their services.
Allow Tokenization. The option defines the operating mode of the plug-in:
- When the tokenzation mode is enabled, the plug-in allows the customer to save payment method details for future payments, in which case Billing stores a token that represent this payment method in Billing. For the subsequent payments, the customer may choose whether to use the saved payment method or get redirected to the payment page to use another payment method.
- When the tokenzation mode is disabled, the plug-in operates in the redirect mode: for every payment the customer is redirected to the payment page.
For recurring payments, the plug-in must operate in tokenized mode.
Approve CHALLENGED Transactions. eWAY checks every transaction against fraud, and suspicious (challenged) transactions are refused. Enable the option to approve such transactions.
Verify Customer Phone. When enabled, the customer's phone will be verified at the payment page.
Verify Customer Email. When enabled, the customer's email will be verified at the payment page.
Responsive Shared Page Theme. The theme of the payment page where customers are redirected to.
Test Mode. The option indicates whether the transactions are processed in test mode:
- In the Test mode, all transactions appear to be processed as real transactions. The gateway accepts the transactions, but does not pass them on to the financial institutions.
- For production environment, this option should be disabled.
Debug Mode
If enabled, responses from processing center will be written to /var/log/httpd/payment-sdk.log
Paymentech
Paymentech is the payment processing and merchant acquiring business of JPMorgan Chase. Paymentech payment platforms support businesses of all sizes to process payments, including credit, debit, and digital, alternative, mobile payment options. For more information about PaymenTech, visit their official site (http://www.chasepaymentech.com).
Account. The identifier and name of the plug-in settings owner.
Merchant ID. The merchant ID given to the account holder by the processing center.
Test Mode. The option defines whether the production server (the option is disabled) or the certification server (the option is enabled) is used for on-line payments.
PayPal Express Checkout
PayPal Express Checkout is a payment option of the PayPal online payment processing center. Checkout Express supports handling recurring payments automatically. For information, visit their official site https://www.paypal.com/webapps/mpp/express-checkout. The plug-in can operate both in redirect and tokenized modes.
PayPal API Username and PayPal API Password. Credentials identifying you as a PayPal account holder.
PayPal API Signature. The signature to be sent in your API requests.
PayPal Sandbox (test mode). The option indicates whether the transactions are processed in test mode:
- In the Test mode, all transactions appear to be processed as real transactions. The gateway accepts the transactions, but does not pass them on to the financial institutions.
- For production environment, this option should be disabled.
Debug PayPal response to file
If enabled, responses from processing center will be written to /var/log/httpd/payment-sdk.log
PayPal Standard
PayPal an international e-commerce business offering different payment services and allowing merchants to process payments online or to redirect their customers to secure PayPal pages. For more information about PayPal, please, visit their official site. The plug-in operates in redirect mode.
PayPal Email Address, PayPal Username and PayPal Password – Credentials identifying you as a PayPal account holder.
PayPal API Signature. The signature to be sent in your API requests.
Test Mode. The option indicates whether the transactions are processed in test mode:
- In the Test mode, all transactions appear to be processed as real transactions. The gateway accepts the transactions, but does not pass them on to the financial institutions.
- For production environment, this option should be disabled.
Debug Mode
If enabled, responses from processing center will be written to /var/log/httpd/payment-sdk.log
PayPalPro (Verisign)
Verisign Payflow Pro is a payment service gateway for direct processing of credit and debit cards. The service is operated by PayPal under the name PayPal Payflow Pro.
Partner, Vendor, Merchant Login Account and Password – Partner name, vendor name, merchant login account and password you received from the processing center.
Host Address, Port Number and Link – The URL, port number and folder name of the server where to post credit/debit card transactions You receive these parameters from PayPal upon registering merchant account.
Cardholder's billing street address (used for AVS and reporting) and Account holder's 5- to 9-digit postal code (used for AVS and reporting). The options that enable performing respective checks from the processing center.
SagePay
A global payment provider that processes secure credit card payments for merchants around the world. For more information, visit their official site http://www.sagepay.co.uk/. The payment gateway can operate both in redirect and tokenized modes.
Username, Password and Vendor Name – Credentials obtained from SagePay when subscribing to their services.
Sandbox (Test Mode). The option indicates whether the transactions are processed in test mode:
- IIn the Test mode, all transactions appear to be processed as real transactions. The gateway accepts the transactions, but does not pass them on to the financial institutions.
- For production environment, this option should be disabled.
Debug API Connection
If enabled, responses from processing center will be written to /var/log/httpd/payment-sdk.log
SEPA Processing Center
The Single Euro Payments Area (SEPA) is an initiative of the EU governments, the European Commission and the European Central Bank (ECB), to create an integrated payments market across Europe for any organization or individual making or receiving payments in euro. With a single set of SEPA standards, organizations and individuals are able to make payments to anyone within the area through their existing bank account using standardized payment instruments.
The plug-in processes direct debit payments. For information about setting up SEPA Processing center, refer to the respective section.
Stripe
Stripe Checkout is an embeddable payment form of the Stripe online payment processing center. For information, visit their official site https://stripe.com/checkout. The payment gateway can operate both in modal-form and tokenized modes.
Live Settings
Publishable Key. The API key to identify your account with Stripe; can be safely passed within browser. Publishable key can be used when creating tokens.
Secret Key. The API key that can perform any API request to Stripe without restriction. Should be kept confidential and only stored on your own servers.
Test Settings
Publishable Key and Secret Key – API keys for the test mode. The meaning and purpose of the values is similar to the ones described above.
Test Mode. The option indicates whether the transactions are processed in test mode:
- In the Test mode, all transactions appear to be processed as real transactions. The gateway accepts the transactions, but does not pass them on to the financial institutions.
- For production environment, this option should be disabled.
Debug Mode
If enabled, responses from processing center will be written to /var/log/httpd/payment-sdk.log
Note: To use MOTO (Mail Order/Telephone Order) payment transactions that do not require SCA (Strong Customer Authentication) in CloudBlue Commerce a provider must explicitly enable this ability for their account in Stripe.
WorldPay
A global payment provider that processes secure credit card payments for merchants around the world. For more information, visit their official site https://online.worldpay.com/. The payment gateway can operate both in modal-from and tokenized modes.
Service Key and Client Key – The API keys used to identify your account with WorldPay.
- The service key is used for all server-to-server calls. It is important you keep this key secret.
- The client key is used for API calls made directly from your customer's browser.
Debug Mode
If enabled, responses from processing center will be written to /var/log/httpd/payment-sdk.log
Note: To process payments through WorldPay, it is required that ZIP / Postal Code field in company account details is filled in (Billing panel > Settings > Company Account). If left empty, processing of payments will fail.