Getting Started

Prerequisites

User and Access Token Permissions

These are the names of the permissions that are required when using the checkout feature and should be assigned when creating your access token:

Permission name	API endpoint	Explanation
`checkouts:create-intent`	`POST {{url}}/checkouts/intent`	Is required to create the intent_id required to render the master widget
`checkouts:search`	`GET {{url}}/checkouts`	Is required if the user wants to search all checkout sessions + hides/displays the checkout 'history' UI tab
`checkouts:get`	`GET {{url}}/v1/checkouts/:id`	Is required to get further details about a specific intent_id + hides/displays the 'actions' drop down from the 'history' tab. This is used to get more detailed information for an intent_id
`checkouts:get-versions`	`GET {{url}}/v1/checkouts/versions`	Is required to get the versions associated with the templates. If disabled, the feature will be available in a read-only context on the UI
`checkouts-templates:get`	`GET {{url}}/checkouts/templates/:id`	Is required to get specific details about a template. If disabled, the 'get actions' dropdown next to each template in the 'templates' screen will be hidden, meaning existing templates cannot be updated
`checkouts-templates:search`	`GET {{url}}/checkouts/templates`	Is required to view templates. If disabled, the list of created templates will be hidden from the UI
`checkouts-templates:create`	`POST {{url}}/checkouts/templates`	Is required to create new templates. If disabled, the 'create new' template button will be hidden from the UI
`checkouts-templates:update`	`PUT {{url}}/checkouts/template/:id`	Is required to update an existing template. If disabled, the 'get actions' dropdown next to each template in the 'templates' screen will be hidden, meaning existing templates cannot be updated
`checkouts-templates:get-schemas`	`GET {{url}}//v1/checkouts/templates/schemas/:type/:version`	Is required to get the checkout template(s) schema by type and version. If disabled, the feature will be available in a read-only context on the UI

Integration Overview

The PowerBoard Checkout integration follows a simple 3-step process:

Step 1: Create Templates

Before rendering the Master Widget, you need to create Configuration and Customisation templates. These templates define the behaviour and appearance of your checkout process.

Configuration Template: Specifies which payment methods and flows are available
Customisation Template: Defines the styling and appearance (optional)

Step 2: Generate Intent

Generate an Intent using the API. The Intent encapsulates the payment context for the transaction and includes customer information.

Step 3: Initialise Widget

Use the intent token to initialise and render the Master Widget on your website.

Quick Start

Set up permissions: Ensure your access token has the required permissions listed above
Create templates: Set up your Configuration Templates and optionally Customisation Templates
Generate intent: Use the Create Intent API to create a payment intent
Implement widget: Follow the Master Widget Implementation guide to add the widget to your site
Handle events: Set up Widget Events to manage payment outcomes

Important Notes

Each intent token is active for 15 minutes. Users must complete their payment within this timeframe.
If you modify the payment amount during checkout (e.g., applying coupon codes), you must regenerate the intent and reinitialise the widget.