BigCommerce
Introduction
Our BigCommerce plug-in comes with regular updates and full integration support, offering a versatile out-of-the-box solution to accept online payments easily:
- Supports both Hosted Checkout Page and Hosted Tokenization Page integration methods
- Offers the following payment methods on our platform:
Alipay+
American Express
Diners Club
Google Pay
MasterCard
PayPal
Visa
WeChat Pay
- Accepts payment operations (Refunds, authorizations, captures etc.) directly from your PAYONE E-Payment account.
Keep an eye on our Release Notes to stay informed about updates and new features (i.e. payment methods, features, integration methods) we have added to this plugin!
Download plugin
Konto erstellen
Um Transaktionen mit diesem Plugin zu verarbeiten, benötigen Sie ein Konto auf unserer Plattform.
Dieses Plugin funktioniert sowohl in unserer Test- als auch Live-Umgebung. Mit einem Testkonto können Sie sich mit dem Plugin und unserer Plattform vertraut machen. Wenn Sie dann live gehen möchten, erstellen Sie ein Produktionskonto oder kontaktieren uns.
Plugin installieren
The first step to use the plugin is the installation process. Before you proceed, make sure your infrastructure meets these system requirements:
Item | Description |
---|---|
Plugin package | |
PAYONE E-Payment credentials |
|
BigCommerce | No specific requirements, compatible with every store |
PCI compliancy |
SAQ A |
Once done, follow these steps:
- Go to Apps > Marketplace. Click on the “BIGCOMMERCE.COM/APPS” button to access our app store. Search for "Worldline Online Payments Connector" and click on the "GET THIS APP" button.
- Login to the BigCommerce Back Office. Go to Apps > Marketplace. Click on the “Install” button and follow the installation instructions.
Plugin konfigurieren
After the installation, you need to configure the plugin to link your store to our platform.
Configure Basic settings
- Login to the BigCommerce Back Office. Go to Apps > My apps > Worldline > My Account to configure the following settings:
Property Description/Actions Modes Select between "Sandbox Mode” or "Live Mode” to link your shop to the respective environment and to configure the respective test/live credentials. Depending on your selection, the shop module will send the transaction requests to the test or production environment.
Make sure to:
- Not to mix up credential from test with live and vice versa when configuring fields PSPID/API and webhooks credentials.
- To switch to "Live Mode" as soon as you have finalised your tests.
Test/Live PSPID Enter your test/live PSPID from our platform that you want to use for transaction processing.
Test/Live API Key Enter the API Key of your test or live PSPID. Read our dedicated guide to learn how to generate one.
Test/Live API Secret Enter the API Secret of your test or live PSPID. Read our dedicated guide to learn how to generate one.
Test/Live Webhooks Key Enter the Webhooks Key of your test/live PSPID from the Merchant Portal as described in our dedicated guide.
Test/Live Webhooks Secret Enter the Webhooks Secret of your test/live PSPID from the Merchant Portal as described in our dedicated guide.
Webhooks URL Copy this URL into the Endpoint URLs fields in the Merchant Portal as described in our dedicated guide.
Redirection Payment Page URL - Test/Live The URL we redirect your customers to after the test/live payment has been finalized.
Applies only to Redirect Mode A / B
- Click on "Connect” to confirm and validate your settings by establishing a test connection between the plugin and our platform. Check that the screen displays “Welcome! Enable your Complete Checkout Solution here!”. If the text does not appear, contact your system administrator for troubleshooting to check:
a. You are using the correct credentials
b. Whether your PSPID is active
c. You send the request to the correct PSPID/environment (Test vs Production)
Configure payment methods
- Login to the BigCommerce Back Office. Go to Apps > My apps > Worldline > Payment Methods to configure the following settings:
Property Description/Actions On Site Mode: Card Payments Only Configure/Enable/Disable card payments via Hosted Tokenization Page integration method
Your customers stay in your webshop checkout page while entering their card details in an iframe hosted on our server. The iframe presents a single payment method as defined in property "Pay Button Title". It autodetects the card brand based on card number input.
If you disable this feature, make sure enable in the "Redirect Mode A" or "Redirect Mode B" to ensure card payments are possible.
Redirect Mode A: Payment Method selection before redirection Configure/Enable/Disable both card and non-card payment methods via Hosted Checkout Page integration method.
Your customers select a payment method and confirm the order in your webshop checkout page by clicking on the "Custom Payment” button. The plugin then redirects your customers either:
> To a version of our Hosted Checkout Page that is branded according to the selected payment method.
> The third party provider offering the selected payment method.Redirect Mode B: Payment Method selection after redirection Configure/Enable/Disable both card and non-card payment methods via Hosted Checkout Page mode:
Your customers confirm the order in your webshop checkout page by clicking on the "Custom Payment" button. The plugin then redirects your customers to our Hosted Checkout Page to allow them selecting their preferred payment method.
Custom Payment Button Customise the payment button text/color on your webshop checkout page. - Configure the following properties in "On Site Mode: Card Payments Only":
a. Pay Button Title: Customise the heading of the iframe.
b. Payment Option: Define whether to process the transactions as authorisation mode ("Capture on Shipment") or as direct sale ("Capture on order placed").
If you select "Capture on Shipment", beware of the following: Make sure that you capture authorised transaction later. Only then will the transaction have status "9 - Captured".
c. Template File Name: Enter the file name of your template to adapt the iframe to the look and feel of your shop. To learn how to create templates, see our dedicated chapter in the Hosted Tokenization Page guide.
d. Display Logo for Accepted Card Brands: Add logos for available card payment methods to the iframe. Make sure to check add only logos for payment methods active in your account. - Configure the following properties in "Redirect Mode A: Payment Method selection after redirection":
a. Send Order Data: Send order line items details in your transaction request.
b. Payment Option: Define whether to process the transactions in authorisation mode ("Capture on Shipment") or in direct sale mode ("Capture on order placed").
If you select "Capture on Shipment", beware of the following: Make sure that you capture authorised transaction later. Only then will the transaction have status "9 - Captured".
c. Template File Name: Enter the file name of your template to adapt the Hosted Checkout Page to the look and feel of your shop. To learn how to create templates, see our dedicated chapter in the Hosted Checkout Page guide. - Configure the following properties in "Redirect Mode B: Payment Method selection after redirection":
a. Send Order Data: Send order line items details in your transaction request.
b. Generic Logo Displayed on Your Payment Page: Add a logo to the Hosted Checkout Page that matches the the look and feel of your shop.
c. Pay Button Title: Customise the radio button text in your webshop checkout page for the payment methods processed via the Hosted Checkout Page.
d. Template File Name: Enter the file name of your template to adapt the Hosted Checkout Page to the look and feel of your shop. To learn how to create templates, see our dedicated chapter in the Hosted Checkout Page guide.
e. Group Cards: Group all cards payment methods under one single button on the Hosted Checkout Page.
f. Payment Option: Define whether to process the transactions in authorisation mode ("Capture on Shipment") or in direct sale mode ("Capture on order placed").
If you select "Capture on Shipment", beware of the following: Make sure that you capture authorised transaction later. Only then will the transaction have status "9 - Captured" - Configure the following properties in "Custom Payment Button":
a. Place Order: Customise the button text of order confirmation button in your webshop checkout page.
b. Background/Text/Outline: Customise the coloring of order confirmation button in your webshop checkout page. - Click on "Save Changes" to confirm your settings.
- Click on "Enable Worldline Checkout" to enable the plugin.
Manage payments
We have designed the plugin to follow-up on your orders automatically and autonomously, freeing you from the administration involved. Learn here how to use our plugin effectively to make your business thrive!
Perform Maintenance Operations
Captures and refunds of authorisations are standard processes (maintenance operations) in your everyday business logic. Learn here how to perform these operations directly in the BigCommerce Back Office:
- Login to the BigCommerce Back Office. Go to Apps > My apps > Worldline > Order Details
- In the order overview, depending on "Worldline Payment Response", the following buttons are available in the "Actions":
9 – Captured: Reimburse the funds for the order via the "Refund" button. You can adapt the amount in the subsequent screen for a partial refund
Mind that our plugin allows only one refund operation for every transaction
5 - Pending_capture: Capture the authorised amount to receive the funds for the order via the "Capture"
Testtransaktionen durchführen
Verwenden Sie die Test-Umgebung unserer Plattform, um sicher zu gehen, dass Ihr Plugin wie gewünscht funktioniert. Wir bieten Testdaten auf unserer eigens dafür eingerichteten Testszenarios-Seite. Steuern Sie unsere Test-Umgebung wie im Kapitel "Plugin konfigurieren" beschrieben an.
Sorgen Sie dafür, auf die LIVE-Umgebung zu wechseln, sobald Sie Ihre Tests abgeschlossen haben.