# Payrails

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

---

## Certified payment options

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

See our [Postman collection](http://postman.com/checkoutdotcom/payrails-checkout-com) for examples of each use case.

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

---

## Before you start

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

1. Request a [test account](https://www.checkout.com/get-test-account) with Checkout.com.
2. Request a [Payrails trial](https://www.payrails.com/contact).

### Create a private API key

1. Sign in to the sandbox environment in the [Dashboard](https://dashboard.sandbox.checkout.com/).
2. Select _Developers_ in the left navigation bar and open the _Keys_ tab.
3. Select _Create a new key_.
4. Under _Type of key_, select _Secret API key_.
5. Enter a description for the API key to help you identify what it's used for.
6. Under _Scopes_, select _Default_.
7. Turn off the _Allow any processing channel_ setting.
8. Select the processing channel you want to use for Payrails payments from the list.
9. Select _Create key_.
10. 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.

---

## Configure the gateway integration

In your Payrails dashboard:

1. Create a new connection to Checkout.com.
2. 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
3. If you're connecting to the Checkout.com sandbox environment, select the *Sandbox* checkbox.
4. Create a Composer Workflow to direct traffic to the Checkout.com connection.

---

## Test your integration

See the [Payrails API documentation](https://docs.payrails.com/) for testing your connection to Checkout.com.

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

### Test using Postman

1. 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](http://postman.com/checkoutdotcom/payrails-checkout-com) for the actions to test in sandbox.

---

## Migrate to production

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