Payrails

Last updated: November 19, 2025

You can use Checkout.com as a payment processor using our certified partner Payrails.

Checkout.com has tested and verified the following actions for this payment method.

See our Postman collection for examples of each use case.

Payment option	Supported actions
Card payments Apple Pay Google Pay	Authorize Authorize initial and subsequent recurring payments Authorize unscheduled payments Authorize with American Express enhanced authorization Authorize with device session record (`deviceSessionId`) Combined authorize and capture MOTO authorizations Partial and multiple capture Partial and multiple refund Refund Reverse Verify a card Void
Integrated 3DS	3DS with redirect 3DS exemption

You must set up your accounts with both Checkout.com and Payrails, and create a private key to configure the integration.

Request a test account with Checkout.com.
Request a Payrails trial.

Sign in to the sandbox environment in the Dashboard.
Select the Developers icon in the top navigation bar and open the Keys tab.
Select Create a new key.
Under Type of key, select Secret API key.
Enter a description for the API key to help you identify what it's used for.
Under Scopes, select Default.
Turn off the Allow any processing channel setting.
Select the processing channel you want to use for Payrails payments from the list.
Select Create key.
Copy your private API key securely. You need it to configure the plugin.

Note

For security reasons, you cannot view the private API key again after you've left the Create a new key page. Ensure you copy the value securely before you exit or close the window.

In your Payrails dashboard:

Create a new connection to Checkout.com.
Under Authentication mode, select:
- Default – To connect to Checkout.com using the private API key you generated in the Dashboard, prefixed with Bearer. For example, Bearer <SECRET_KEY>.
- OAuth – To connect using OAuth authentication
If you're connecting to the Checkout.com sandbox environment, select the Sandbox checkbox.
Create a Composer Workflow to direct traffic to the Checkout.com connection.

See the Payrails API documentation for testing your connection to Checkout.com.

Optionally, you can use our Postman collection to test payment actions.

Ensure you set up your Postman environment with the following data:
- From Payrails, you need:
  - Environment key
  - Environment access secret
  - Checkout.com gateway token
  - Workflow key
- From Checkout.com, you need:
  - Processing channel
  - Currency account – if processing card payments

See the Postman collection for the actions to test in sandbox.

To move your integration into production, generate a private key for your production environment and use those credentials instead.

Payrails

Certified payment options

Before you begin

Create a private API key

Note

Configure the gateway integration

Test your integration

Test using Postman

Migrate to production