How to Set Up Checkout Templates
Before You Begin:
To use the Checkout feature, you will need to create and use an Access Token.
Follow these steps to generate your Access Token via Paydock's Merchant Dashboard:
- Log in to the Paydock Merchant Dashboard.
- Click on the ‘Access Tokens’ link in the navigation menu.
- Click ‘Create New’ and select the following permissions:
- checkouts:create-intent
- checkouts:search
- checkouts:get
- checkouts:get-versions
- checkouts-templates:get
- checkouts-templates:search
- checkouts-templates:create
- checkouts-templates:update
- checkouts-templates:get-schemas
- Click ‘Save’.
- Copy your Access Token and store it securely, as it cannot be accessed again once generated.
Make sure you have your Gateway IDs for the relevant payment methods, as you will need these during setup.
- Log in to the Paydock Merchant Dashboard.
- Navigate to the ‘Checkout’ section.
- Click ‘Create New’.
From here, you'll be presented with the following template options:
- Customisation: A template designed for adjusting the look and feel of your checkout process.
- Configuration: A template designed for selecting workflows and payment services for your checkout.
- Configuration & Customisation: A combined template that allows you to create both the configuration and customisation simultaneously.
For first-time setup, we recommend using the Configuration & Customisation option.
Creating a Configuration Template
The following steps will guide you through creating a configuration template, helping you to structure and optimise your checkout workflow for stability, clarity, and maximum control:
- Label: Give your template a clear, descriptive label. This helps you easily identify it later.
- Versioning: The latest template version will be pre-selected automatically to ensure you have access to the most recent features and functionality.
- Payment Method Options: Use the provided toggles to enable different payment methods and flows. The system will automatically show you a list of compatible gateways for each option.
- Card Payments: For card payment methods, Checkout provides multiple flow options to help you tailor payment processing to your business requirements.
- Direct Capture: This is the default and mandatory flow for card payments.
- Fraud Prevention: In the Fraud tab, you can enable integration with services like Forter or Accertify.
- 3D Secure (3DS): In the 3DS tab, you can enable authentication options:
- Gateway 3DS: Available for the MPGS gateway.
- Standalone 3DS: Compatible with all gateway types.
- Combined Security Flows: If you enable both a fraud and a 3DS option, the system will seamlessly combine them. The order of operations is:
- Fraud check
- 3DS authentication
- Financial charge
- Other Payment Methods: For all other payment methods, only the "direct capture" flow is currently supported.
Domain Whitelisting
To enhance security, you can restrict where your checkout widget can be embedded.
-
Enable Whitelisting: Go to the 'Security' tab and add the specific domains where your checkout will be accessed to the "Whitelist Domains" field.
-
Domain Format: You must enter the full domain name (e.g.,
test.test.com
nottest.com
). You can use various formats, such astest.com
orhttps://test.com
.
If you don't configure domain whitelisting, the checkout widget will be accessible from any domain by default.
Once you've selected your workflows and entered the necessary Service IDs, click ‘Save and Next.’
Creating a Customisation Template
When creating a customisation template, assign a clear label for easy identification. You can then tailor the following elements to align with your brand and user experience goals:
- Background colour
- Border colour
- Text colour
- Button colour
- Font family
- Font size
After finishing your adjustments, select ‘Save’ to apply your changes.
Customisation template is optional.
If you do not provide a customisation template in the intent API request, then the default settings will be applied.
Your created templates will now appear in the Templates list with an associated ID, which you can use in your integration.