Nuvei

Who should use this guideThis 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

Create a Nuvei integration in Payrails

Log in to the Payrails portal.
Go to Settings → Integrations.
Select Add instance to create a new integration configuration.
Select the workspaces where this integration should be available.

About workspacesWorkspaces 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.

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.

A screenshot showing Nuvei selected as the provider.

Step 3: Configure your Nuvei integration

What you’ll need from NuveiBefore 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.

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.

A screenshot showing the integration instance name field.

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

A screenshot showing the Nuvei account details fields.

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.

A screenshot showing the Nuvei credential fields.

Payment methods

In Payrails

Select the payment methods to enable for this integration: Card, Apple Pay, Google Pay, iDEAL, Alipay, WeChat Pay or Bancontact.

Card, Apple Pay and Google Pay have extra settings inside their card once you select them. Refer to Configure Nuvei settings.

A screenshot showing the Nuvei payment method selection.

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

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

A screenshot showing the Nuvei Apple Pay settings.

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.

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

Run a test payment using a Nuvei test card.
Verify that:
- The payment appears in the Nuvei Control Panel.
- The payment status updates correctly in Payrails.
Once verified in test mode, repeat the setup in live mode.

→ Continue to: Test a payment

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Create a Nuvei integration in Payrails

Step 1: Choose the integration type

Step 2: Choose the provider