> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# Checkout.com

> Connect a Checkout.com account to Payrails: create the integration, configure API keys and webhooks, and enable raw card data processing.

<Note>
  **Who should use this guide**

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Checkout.com Payments**
  * Are approved to process **raw card data**

  *We use a server-to-server integration with Checkout.com, so your account must be enabled to process raw card data. If this isn't enabled, payments won't work in production. Please contact your Checkout.com account manager or support team to activate it.*
</Note>

## Create and configure a Checkout.com integration in Payrails

1. Log in to the **Payrails** portal.
2. Go to **Settings** → **Integrations**.
3. Select **Add instance** to create a new Checkout.com integration configuration.
4. Select the **Workspaces** where this integration should be available.

<Note>
  **About Workspaces**

  Workspaces determine where this integration is available. They let you isolate provider setups by region or business line, or share the same configuration across multiple Workspaces.
</Note>

***

## Step 1: Choose the integration type

* Select **Payment**.
* Continue to the next step.

<img src="https://mintcdn.com/payrails-42074109/To59SEkYYPq19nmx/images/docs/orchestration/integrations/shared/integration-type-selection.png?fit=max&auto=format&n=To59SEkYYPq19nmx&q=85&s=2a1afe79c3ac25f3a8437846a1d36ffb" alt="A screenshot showing the integration type selection form." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/orchestration/integrations/shared/integration-type-selection.png" />

***

## Step 2: Choose the provider

* Select **Checkout.com**.
* Continue to the next step.

<img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-image-01.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=939a5cf6e1242e01e5c597657b81b7fc" alt="A screenshot showing the Checkout.com integration selected." className="mx-auto block rounded-lg object-cover border border-gray-200" width="100%" data-path="images/docs/checkout-image-01.png" />

***

## Step 3: Configure your Checkout.com integration

<Tip>
  **What you'll need from Checkout.com**

  Before you begin, make sure you have access to:

  * Processing Channel ID (`pc_XXX`)
  * Checkout.com **Access Key ID**
  * Checkout.com **Access Key Secret**
  * Webhook signature key

  [Sign in](https://dashboard.checkout.com) to your Checkout.com dashboard to complete this step.
</Tip>

***

### Integration instance name

> An integration instance is a specific payment provider setup in Payrails. You can create multiple instances for each provider based on region, currency, or business needs. Choose a clear, consistent name, as it is used in routing.

**In Payrails**

* Enter an **Instance name** for your integration.

<img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/dlocal-basic-information.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=b9a43582acab50b93394ecc2898d5ecf" alt="A screenshot showing the Payrails integration instance name field." className="mx-auto block rounded-lg object-cover border border-gray-200" width="100%" data-path="images/docs/dlocal-basic-information.png" />

***

### Account details

**In Checkout.com**

1. [Sign in](https://dashboard.checkout.com) to the **Checkout.com Dashboard**.
2. Locate your **Processing Channel ID** in the account or processing channel settings.
3. Copy the Processing Channel ID (`pc_XXXX`).

**In Payrails**

* Paste the value into the **Processing Channel ID** field.

<img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-image-02.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=73f76002cac9e5040c702a0ee27d7cf2" alt="A screenshot showing the Checkout.com account fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/checkout-image-02.png" />

***

### API credentials

<img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-checkout-api-key.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=18405caf8139b4074e7ca4b7ea506b48" alt="Payrails Checkout.com API credentials section" className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/checkout-checkout-api-key.png" />

**In Checkout.com**

1. Go to **Developers**.
2. Select **Create new key**.

<img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-checkout-api-key-2.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=037e88756d6bb09fffa953e9658e3306" alt="Checkout.com dashboard page for creating a new API key" className="mx-auto block rounded-lg object-cover border border-gray-200" width="100%" data-path="images/docs/checkout-checkout-api-key-2.png" />

3. In **Key details**, select **Access key pair**.

4. Add a **Description** to help identify the key.

5. Under **Scopes** → **Customise** → **Custom scopes**, enable:

   * `disputes:accept`

   * `disputes:provide-evidence`

   * `disputes:view`

   * `files`

   * `gateway`

   * `sessions:app`

   * `sessions:browser`

   * `vault:instrument`
     <img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-image-11.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=03ea1888ecb45aeb385ef96567343b76" alt="Checkout.com custom scopes selection for API key permissions" className="mx-auto block rounded-lg object-cover" width="80%" data-path="images/docs/checkout-image-11.png" />
     <img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-image-05.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=61f8e225e34ca1e638e3742851b6639f" alt="Checkout.com key configuration options during API key setup" className="mx-auto block rounded-lg object-cover" width="40%" data-path="images/docs/checkout-image-05.png" />

   <img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-image-06.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=a1470619dc0e98a56493e3a657363621" alt="Checkout.com API key setup showing processing channel options" className="mx-auto block rounded-lg object-cover" width="80%" data-path="images/docs/checkout-image-06.png" />

6. Select **Allow any processing channel** (or restrict if required).

7. If needed, locate your Processing Channel ID here (`pc_XXX`).

8. Select **Create new key**.

<img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-checkout-api-key-4.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=caea1ad7fc356ac4d93b0c192477b29d" alt="Checkout.com newly created access key pair details" className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/checkout-checkout-api-key-4.png" />

9. Copy the **Access Key ID** and **Access Key Secret**.

**In Payrails**

* Paste the credentials into the corresponding fields.

<img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-image-08.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=49c2a5152685b750dd36be2a7f73fe33" alt="A screenshot showing the Checkout.com API credential fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/checkout-image-08.png" />

***

### Webhooks (notifications)

<Tip>
  Payrails uses Checkout.com webhooks to receive asynchronous payment status
  updates.
</Tip>

<Warning>
  Create the webhook in the same mode (test or live) as your Payrails
  integration.
</Warning>

**In Checkout.com**

1. Go to **Developers** → **Webhooks**.

2. Select **New webhook**.

3. Enter a name for the webhook.

4. Paste the **Notification URL** from Payrails.

   <img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/dlocal-basic-information.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=b9a43582acab50b93394ecc2898d5ecf" alt="A screenshot showing the Payrails integration instance name field." className="mx-auto block rounded-lg object-cover border border-gray-200" width="100%" data-path="images/docs/dlocal-basic-information.png" />

5. Generate a **Signature key**.

6. Select:
   * **All events**
   * **All entities**
   * **All processing channels**

7. Save the webhook.

**In Payrails**

* Paste the **Signature key** into the **HMAC key** field.

***

### Payment methods

**In Payrails**

* Select the payment methods that should be enabled for this integration.

<img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-image-09.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=0f05e6d2bede0f2117444ffa3823c84d" alt="A screenshot showing the Checkout.com payment methods." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/checkout-image-09.png" />

***

## Request fields for Checkout.com

Send these fields in the [authorize request](/reference/authorizeaction) for card payments, in addition to the standard authorize fields. **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to Checkout.com when you include them. For more about meta fields, refer to [Meta fields](/docs/orchestration/meta-fields).

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Checkout.com as the amount and currency. |
| `merchantReference` | Optional | Sent as the payment reference. |
| `instrument.holderName` | Optional | Sent as the card holder name. |
| `meta.customer.name`, `lastName`, `email`, `phone` | Optional | Sent as the customer details. |
| `meta.customer.createdAt` | Optional | Sent as the customer's registration date. |
| `meta.order.billingAddress` | Optional | Sent as the card's billing address and phone. |
| `meta.order.deliveryAddress` | Optional | Sent as the shipping address. |
| `meta.order.description` | Optional | Sent as the payment description. |
| `meta.order.softDescriptor`, `meta.order.softDescriptorCity` | Optional | Sent as the billing descriptor name and city, with `meta.order.reference`. Send both, together with a billing address. |
| `meta.order.accommodationData` | Optional | Sent as accommodation data. |
| `meta.order.fundsTransfer` | Optional | Account funding transactions only. When you send it, the sender needs `name` and `lastName` (individual) or `companyName` (corporate), and a recipient needs `account`, `receiver.name` and `receiver.lastName`. |
| `meta.risk.sessions` | Optional | An entry with `provider` set to `checkout` and the Risk.js device session ID as `sessionId`. Sent as the risk device session ID. The [Payrails Web Fraud SDK](/docs/orchestration/checkout-sdks/payrails-web-fraud-sdk#checkout-com) adds it for you. Payrails falls back to `meta.risk.sessionId` when there's no Checkout.com entry. |
| `meta.risk.threeDSMode`, `meta.risk.exemptionIndicator` | Optional | Set 3D Secure and the exemption to request. |
| `meta.clientContext` | Optional | Sent as device details for risk: browser fields, IP and device fingerprint. |
| `meta.tags` | Optional | Sent in a user-defined field when you choose `metaTag`. Refer to [User-defined fields](#user-defined-fields). |

***

## Configure Checkout.com settings

Some Checkout.com integration settings change how Payrails processes your payments. The portal shows the same description when you hover over each setting. You find them under **Account details**.

### User-defined fields

**UDF1** to **UDF4** choose what Payrails sends in each of the four Checkout.com user-defined fields. Payrails sends them in the payment `metadata` on authorize, capture, refund and void, so you can search and report on them in Checkout.com.

| Option | Value Payrails sends |
| :- | :- |
| `merchantName` | The **Merchant Name** you enter in the same form |
| `holderReference` | The `holderReference` of the payment |
| `merchantReference` | The `merchantReference` of the payment |
| `itemId` | The `id` of the first line in `meta.order.lines` |
| `metaTag` | The value of a key you choose in `meta.tags`. Enter the key in **UDF Meta Tag Key**. For example, enter `customField` and send `meta.tags.customField` in your request. |
| Blank | Nothing. The field isn't sent. |

For more about meta fields, refer to [Meta fields](/docs/orchestration/meta-fields).

### Mada CVV Patching

Turn on **Mada CVV Patching** if you process local mada cards and collect the CVV again when a customer pays with a saved card. Payrails then adds that CVV to the customer-initiated payment it sends with the stored Checkout.com card. Without a newly collected CVV, the setting has no effect.

### Enable Mada Previous Payment ID

On merchant-initiated payments, Payrails sends a previous payment ID that links the payment to the customer's earlier payment. By default it's the card's network transaction reference. Turn on **Enable Mada Previous Payment ID** to send the ID of the last successful Checkout.com payment on the card instead, for mada cards.

### Enable non-SCA compliant behavior

**Enable non-SCA compliant behavior** changes two things on card and Google Pay payments:

* When your request forces 3D Secure, Payrails asks Checkout.com for no challenge instead of a mandated challenge.
* On a first payment that saves the card for subscription or unscheduled payments, Payrails sends the payment type as regular.

<Warning>
  This behaviour doesn't meet strong customer authentication (SCA) rules for payments in Europe. Turn it on only after your compliance team confirms it for your processing.
</Warning>

***

## Enable the integration

**In Payrails**

* Select **Save account** to enable the integration.

The **Enabled** status indicates that the Checkout.com integration is active.

<img src="https://mintcdn.com/payrails-42074109/6ZmkK5ZUHpx1-EP_/images/docs/checkout-image-10.png?fit=max&auto=format&n=6ZmkK5ZUHpx1-EP_&q=85&s=e35ba591c9af0e4f6e7e4e5633b559a7" alt="A screenshot showing the enabled Checkout.com integration." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/checkout-image-10.png" />

Your Checkout.com integration is now ready to process payments.

***

## Next steps

1. Run a test payment using a supported Checkout.com [test card](https://www.checkout.com/docs/developer-resources/testing/test-cards).
2. Verify that:
   * The payment appears in Checkout.com.
   * The payment status updates correctly in Payrails.
3. Once verified in test mode, repeat the setup in live mode.

→ Continue to: [Test a payment](/docs/orchestration/payment-acceptance/test-payments)


## Related topics

- [Checkout](/docs/chargebacks/integrations/checkout.md)
- [Przelewy24 via Checkout.com](/docs/orchestration/payment-methods/przelewy24/checkout-com.md)
- [EPS via Checkout.com](/docs/orchestration/payment-methods/eps/checkout-com.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.