Checkout

This guide will help you to obtain your Checkout API credentials to ingest settlement and payment data from Checkout into your Payrails account.

Prerequisites

A Checkout.com account & Developer or Admin permissions.

Step-by-step instructions

We recommend that you create a limited access set of API keys for Payrails reporting.

Step 1: Log into Checkout live environment

Step 2: Create API keys

1. Follow the instructions in the Checkout documentation to create a set of secret API keys.
2. Use “Customize“ option to limit the scopes to the following: reports , reports:view, financial-actions, financial-actions:view.
3. Under processing channels, select "Allow any processing channel" and select all entities to which would like to allow Payrails to pull data from. Keep this list of entities IDs to later share.
4. After creating the key, validate its the correct by making sure the key type is "SECRET" and the key value starts with "sk_".

Step 3: Add a new data integration on Payrails portal

1. Log in to Payrails portal and navigate to the workspace for which you want to configure the data sources.
2. Under Merchant configurations select Integrations.
3. Click on + Add instance.
4. Select Data as the integration type.
5. Select Checkout.com as provider.
6. Create a unique integration instance name and insert your Checkout Entity ID and API key. You will need to create one integration per Checkout Entity. If you want to create one instance covering all entities, please contact support.
7. Select a Start Date to display data in dashboards. To include historical data, choose a date in the past. Data will be retrieved starting from your selected date.