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

# Ecommpay

> Connect Ecommpay to Payrails for cards, Apple Pay and Google Pay, covering your project ID, secret key and authorize polling.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Ecommpay** for card and wallet processing
  * Have an active Ecommpay project
</Note>

***

## Create a Ecommpay 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 **Ecommpay**.
* Continue to the next step.

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

***

## Step 3: Configure your Ecommpay integration

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

  Before you begin, make sure you have your Ecommpay project ID and secret key. Ecommpay gives you a test project first and sends the live secret key when your account goes live.
</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_ecommpay`.

<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 Payrails**

| Field | Value |
| :- | :- |
| **Project ID** | Your Ecommpay project ID |
| **Enable polling for authorize operations** | Optional. Refer to [Configure Ecommpay settings](#configure-ecommpay-settings). |

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

***

### Credentials

**In Payrails**

| Field | Value |
| :- | :- |
| **Secret Key** | Your Ecommpay project secret key. Payrails signs every request with it and verifies notifications from Ecommpay. |

Payments go to the test or live project that your project ID and secret key belong to, so use the ones that match the mode of your Payrails integration.

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

***

### Payment methods

**In Payrails**

* Select **Card**, **Apple Pay**, **Google Pay** or any combination.

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

***

### Webhooks or notifications

Payrails sends its notification URL to Ecommpay with every payment, so you don't need to set one up in the Ecommpay dashboard. Payrails verifies each notification with your secret key.

***

## Request fields for Ecommpay

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

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Ecommpay in minor units, with the currency. An amount of `0` runs an account verification. |
| `meta.customer.email` | Required | Sent as the customer email. |
| `meta.clientContext.ipAddress` | Required | Sent as the customer IP. |
| `meta.clientContext.screenWidth`, `screenHeight` | Required | Customer-initiated payments only. Sent as the screen resolution. |
| `instrument.holderName` | Optional | Sent as the card holder. |
| `merchantReference` | Optional | Sent in the merchant data. |
| `meta.customer.name`, `lastName`, `phone`, `country`, `birthDate`, `identityCardNumber` | Optional | Sent as the customer details. |
| `meta.order.billingAddress`, `meta.order.deliveryAddress` | Optional | Sent as the billing and shipping addresses. |
| `meta.risk.threeDSMode` | Optional | `Skip` sends the payment without 3D Secure. |

***

## Configure Ecommpay settings

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

| Setting | What it does |
| :- | :- |
| **Enable polling for authorize operations** | Ecommpay processes payments asynchronously. By default, Payrails gets the payment result and any 3D Secure challenge from Ecommpay's notifications. When you turn this on, Payrails also checks the payment status with Ecommpay for up to one hour after the authorize request, and takes the 3D Secure challenge from those checks. Notifications still update the payment status. |

***

## Enable the integration

**In Payrails**

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

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

***

## Next steps

1. Run a test card payment on your Ecommpay test project.
2. Verify that:
   * The payment appears in the Ecommpay dashboard.
   * The payment status updates correctly in Payrails.
3. Once verified in test mode, repeat the setup with your live project.

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


## Related topics

- [Integrations](/docs/orchestration/integrations.md)


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