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"
4. After creating the key, validate its the correct by making sure the key type is "SECRET" and the key value starts with "sk_".
5. Create API keys for each of the entities you would like Payrails to have access to.

Step 3: Enable scheduled reports download

1. Select reports, go to Schedules and click on Create schedule

2. Select the following input and click on Create
   1. Delivery Type = SFTP
   2. Report Type: all reports, each report needs to be set up separately, so you have to redo Step 3 multiple times to enable all reports.
   3. Time zone = UTC
   4. Report details
      1. Frequency = Daily
      2. Schedule name: can stay as proposed from the system
      3. customize included fields = Select all

Step 4: Share credentials with Payrails

1. Share your API credentials in a secured way with Payrails.
   You can use your preferred secrets manager or vault tool like 1Password Shared Vaults, AWS Secrets Manager or GCP Secrets Manager.
2. If a shared vault is not possible, you can also share credentials over PGP-encrypted file.