> ## 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.

# Nuvei

> Connect Nuvei to Payrails for cards, wallets and local payment methods, covering credentials, DMNs and the Nuvei settings.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Nuvei** for card, wallet or local payment method processing
  * Have an active Nuvei account with a merchant ID and merchant site ID
</Note>

***

## Create a Nuvei integration in Payrails

1. Log in to the **Payrails** portal.
2. Go to **Settings** → **Integrations**.
3. Select **Add instance** to create a new 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.

***

## Step 2: Choose the provider

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

<img src="https://mintcdn.com/payrails-42074109/145W1v58K5wnDMNC/images/docs/nuvei-image-01.png?fit=max&auto=format&n=145W1v58K5wnDMNC&q=85&s=2e1832e2970828cbb7de98e6e1475dbe" alt="A screenshot showing Nuvei selected as the provider." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/nuvei-image-01.png" />

***

## Step 3: Configure your Nuvei integration

<Tip>
  **What you'll need from Nuvei**

  Before you begin, make sure you can log in to the Nuvei Control Panel. You'll copy your merchant ID, merchant site ID and merchant secret key from it.
</Tip>

***

### Integration instance name

> An integration instance is a specific payment provider setup in Payrails. You can create multiple instances for different regions, currencies, or business needs. Choose a clear, consistent name, as it is used in routing.

**In Payrails**

* Enter an **Instance name** for your integration, for example `merchant_nuvei`.

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

***

### Account details

**In Nuvei**

* In the Nuvei Control Panel, copy your **Merchant ID** and **Merchant Site ID**.

**In Payrails**

| Field | Value |
| :- | :- |
| **Merchant ID** | Your Nuvei merchant ID |
| **Merchant Site ID** | Your Nuvei merchant site ID |

<img src="https://mintcdn.com/payrails-42074109/145W1v58K5wnDMNC/images/docs/nuvei-image-02.png?fit=max&auto=format&n=145W1v58K5wnDMNC&q=85&s=8c8bdd4b96146ee267aa177ac39e6ece" alt="A screenshot showing the Nuvei account details fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/nuvei-image-02.png" />

***

### Credentials

**In Nuvei**

* Copy your **merchant secret key** from the Nuvei Control Panel.

**In Payrails**

| Field | Value |
| :- | :- |
| **API key** | Your Nuvei merchant secret key. Payrails signs every request with it and uses it to verify Nuvei's notifications (DMNs). |

Payrails sends requests to Nuvei's test environment in test mode and to Nuvei's live environment in live mode, so use the merchant secret key for the matching environment.

<img src="https://mintcdn.com/payrails-42074109/145W1v58K5wnDMNC/images/docs/nuvei-image-03.png?fit=max&auto=format&n=145W1v58K5wnDMNC&q=85&s=00087e9ac88032b7942d001146ccb87d" alt="A screenshot showing the Nuvei credential fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/nuvei-image-03.png" />

***

### Payment methods

**In Payrails**

* Select the payment methods to enable for this integration: **Card**, **Apple Pay**, **Google Pay**, [iDEAL](/docs/orchestration/payment-methods/ideal/nuvei), [Alipay](/docs/orchestration/payment-methods/alipay/nuvei), [WeChat Pay](/docs/orchestration/payment-methods/wechat-pay/nuvei) or [Bancontact](/docs/orchestration/payment-methods/bancontact/nuvei).

Card, Apple Pay and Google Pay have extra settings inside their card once you select them. Refer to [Configure Nuvei settings](#configure-nuvei-settings).

<img src="https://mintcdn.com/payrails-42074109/145W1v58K5wnDMNC/images/docs/nuvei-image-04.png?fit=max&auto=format&n=145W1v58K5wnDMNC&q=85&s=9e14a57b849a8801e67b273cd2c58d9a" alt="A screenshot showing the Nuvei payment method selection." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/nuvei-image-04.png" />

***

### Webhooks or notifications

Payrails sends its notification URL to Nuvei with every payment, capture, void and refund, so payment notifications (DMNs) need no setup in the Nuvei Control Panel. Payrails verifies each DMN with your merchant secret key.

To receive chargeback and fraud notifications, ask Nuvei to send chargeback DMNs to your Payrails notification URL. Copy it from **Notification URL** under **Account configuration** at the top of the integration form.

***

## Request fields for Nuvei

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 Nuvei when you include them. For more about meta fields, refer to [Meta fields](/docs/orchestration/meta-fields).

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Nuvei as the amount and currency. |
| `meta.customer.email` | Required | Sent as the billing email. |
| `meta.customer.country.code` | Required | Sent as the billing country. |
| `meta.clientContext.ipAddress` | Required | Sent as the device IP address. |
| `meta.clientContext.userAgent`, `acceptHeader`, `language`, `colorDepth` | Required | Payments with 3D Secure. Sent as browser details for authentication. |
| `meta.clientContext.javaEnabled`, `javaScriptEnabled`, `screenWidth`, `screenHeight`, `timeZoneOffset` | Optional | Sent as browser details for 3D Secure. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent as the billing first and last name. |
| `meta.customer.phone.number` | Optional | Sent as the billing phone, up to 18 characters. |
| `meta.order.billingAddress` | Optional | Sent as the billing address: `street` and `doorNumber`, `city`, `state`, `postalCode` and `area`. Its `name`, `lastName`, `email`, `country.code` and `phone` replace the customer's. |
| `meta.order.deliveryAddress` | Optional | Sent as the shipping address. |
| `meta.risk.threeDSMode` | Optional | Sets the 3D Secure challenge preference. |
| `meta.risk.exemptionIndicator` | Optional | `lowValue` or `transactionRiskAnalysis`. Sent as the exemption request reason. |
| `meta.subscription.chargeFrequency`, `meta.subscription.expiration` | Optional | First card payment of a subscription. Sent as the recurring billing frequency and expiry. |
| `meta.order.fundsTransfer` | Optional | Account funding transactions only. Refer to [Configure Nuvei settings](#configure-nuvei-settings). |
| `merchantReference` | Optional | Sent as the client unique ID. |
| `holderReference` | Optional | Sent as the user token ID that links saved cards to the customer. |

***

## Configure Nuvei settings

Some Nuvei integration settings change how Payrails processes your payments. The portal shows the same description when you hover over each setting.

### Account settings

These settings are under **Account details**.

| Setting | What it does |
| :- | :- |
| **Forward risk meta to 3DS** | Sends `meta.clientContext.origin` as the merchant URL and `meta.risk.score` as the external risk score on 3D Secure authentication requests. Issuers can use them in their challenge and exemption decisions. |
| **Fail payment on missing 3DS challenge response** | When a 3D Secure challenge returns without a challenge response, Payrails fails the payment as an abandoned authentication. With the setting off, Payrails returns an error and leaves the payment open. |
| **Support Account Funding Transactions (AFTs)** | Sends `meta.order.fundsTransfer` to Nuvei as recipient details, so you can process account funding transactions. Ask Nuvei to enable AFTs on your account first. |

### Payment method settings

Payment method settings appear in each method's card after you select it.

<img src="https://mintcdn.com/payrails-42074109/145W1v58K5wnDMNC/images/docs/nuvei-image-05.png?fit=max&auto=format&n=145W1v58K5wnDMNC&q=85&s=a2f7d660ef31dd89d129792e761e5017" alt="A screenshot showing the Nuvei Apple Pay settings." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/nuvei-image-05.png" />

| Setting | Payment methods | What it does |
| :- | :- | :- |
| **Skip initial rebilling indicator** | Card, Apple Pay, Google Pay | Sends the initial rebilling indicator only on payments that start a recurring series. Turn it on if you don't take recurring payments: the indicator can make the issuer treat a one-off payment as the start of a series and challenge it. |
| **Send MIT as card** | Apple Pay, Google Pay | Sends merchant-initiated wallet payments as plain card payments instead of wallet tokens, which can improve authorization rates on recurring charges. |
| **Enable Apple Pay 3DS** | Apple Pay | Runs Nuvei 3D Secure authentication on Apple Pay payments. Ask Nuvei to enable Apple Pay 3DS on your account first. Without it, Nuvei rejects Apple Pay payments. |
| **Enable Google Pay DPAN 3DS** | Google Pay | Sends 3D Secure authentication data on Google Pay network token payments. |

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

***

## Enable the integration

**In Payrails**

* Select **Save account** to enable the integration.
* Confirm the integration shows as **Enabled**.

Your **Nuvei** integration is now ready to process payments.

***

## Next steps

1. Run a test payment using a Nuvei [test card](https://docs.nuvei.com/documentation/integration/testing/testing-cards/).
2. Verify that:
   * The payment appears in the Nuvei Control Panel.
   * 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

- [Nuvei](/docs/chargebacks/integrations/nuvei.md)
- [iDEAL via Nuvei](/docs/orchestration/payment-methods/ideal/nuvei.md)
- [Bancontact via Nuvei](/docs/orchestration/payment-methods/bancontact/nuvei.md)


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