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

# Unlimit

> Connect Unlimit to Payrails for cards, wallets, UPI and PhonePe, covering your terminal credentials, callbacks and India processing.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Unlimit** for cards, wallets, [UPI](/docs/orchestration/payment-methods/upi/unlimit) or [PhonePe](/docs/orchestration/payment-methods/phonepe/unlimit)
  * Have access to the Unlimit merchant portal
</Note>

***

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

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

***

## Step 3: Configure your Unlimit integration

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

  Before you begin, make sure you can log in to the Unlimit merchant portal. You'll copy your terminal code, terminal password and callback secret there, and set the callback URL.
</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_unlimit`.

<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 |
| :- | :- |
| **Processing payments in India** | Optional. Refer to [Configure Unlimit settings](#configure-unlimit-settings). |

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

***

### Credentials

**In Unlimit**

* In the Unlimit merchant portal, open your terminal settings and copy the terminal code, terminal password and callback secret.

**In Payrails**

| Field | Value |
| :- | :- |
| **Terminal Code** | Your Unlimit terminal code |
| **Password** | Your Unlimit terminal password |
| **Callback Secret** | Your Unlimit callback secret. Payrails uses it to verify callbacks from Unlimit. |

Payrails sends requests to the Unlimit sandbox in test mode and to the live environment in live mode, so use the terminal for the matching environment.

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

***

### Payment methods

**In Payrails**

* Select **Card**, **UPI**, **Apple Pay**, **Google Pay**, **PhonePe** or any combination. PhonePe needs an account with **Processing payments in India** turned on.

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

***

### Webhooks or notifications

<Info>
  Payrails uses provider webhooks or notifications to receive asynchronous
  payment status updates.
</Info>

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

**In Payrails**

* Copy the **Notification URL** shown under **Account configuration** at the top of the integration form.

**In Unlimit**

1. In the Unlimit merchant portal, open the settings of the same terminal.
2. Set the callback URL to the Payrails notification URL.
3. Save the changes.

Unlimit sends callbacks for payment status changes, refunds and chargebacks.

***

## Request fields for Unlimit

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

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Unlimit as the amount and currency. |
| `meta.order.description` | Required | Sent as the order description. |
| `meta.customer.email` | Required | Sent as the customer email. You can send `instrument.data.email` instead. |
| `meta.clientContext.ipAddress` | Required | Sent as the customer IP. |
| `meta.clientContext.userAgent` | Required | Sent as the customer's user agent. |
| `returnInfo.successUrl` | Required | Sent as the return URL when 3D Secure is skipped. |
| `meta.customer.phone.number` | Required | On accounts with **Processing payments in India**. Sent as the customer phone. |
| `meta.customer` | Required | Sent as the customer details. Include `reference` to send the customer ID. |
| `merchantReference` | Optional | Sent as the merchant order ID. |
| `meta.clientContext.acceptHeader`, `language`, `colorDepth`, `screenHeight`, `screenWidth`, `timeZoneOffset`, `javaEnabled`, `javaScriptEnabled` | Optional | Sent as browser details for 3D Secure. |
| `meta.customer.language` | Optional | Sent as the customer locale. |
| `instrument.holderName` | Optional | Sent as the card holder, when it's 2 to 50 characters. |
| `meta.risk.threeDSMode` | Optional | `Force` asks for a 3D Secure challenge. `Skip` turns 3D Secure off. |
| `returnInfo.errorUrl`, `pendingUrl`, `cancelUrl` | Optional | Sent as the decline, in-process and cancel URLs when 3D Secure is skipped. |

***

## Configure Unlimit settings

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

| Setting | What it does |
| :- | :- |
| **Processing payments in India** | Turn this on if this Unlimit account processes payments in India. Payrails then sends requests to Unlimit's India environment, sends the customer's phone number with every payment, and requires it on customer-initiated payments. PhonePe works only with this setting on. |

***

## Enable the integration

**In Payrails**

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

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

***

## Next steps

1. Run a test card payment in the Unlimit sandbox.
2. Verify that:
   * The payment appears in the Unlimit merchant portal.
   * The payment status updates correctly in Payrails.
3. Once verified in test mode, repeat the setup with your live terminal.

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


## Related topics

- [Unlimit](/docs/analytics-and-reporting/getting-started/connect-your-data-sources/unlimit.md)
- [UPI via Unlimit](/docs/orchestration/payment-methods/upi/unlimit.md)
- [PhonePe via Unlimit](/docs/orchestration/payment-methods/phonepe/unlimit.md)


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