Unlimit

Who should use this guideThis guide is intended for merchants who:

Use Payrails as a payment orchestrator
Use Unlimit for cards, wallets, UPI or PhonePe
Have access to the Unlimit merchant portal

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

A screenshot showing Unlimit selected as the provider.

Step 3: Configure your Unlimit integration

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

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.

A screenshot showing the integration instance name field.

Account details

In Payrails

Field	Value
Processing payments in India	Optional. Refer to Configure Unlimit settings.

A screenshot showing the Unlimit account details fields.

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.

A screenshot showing the Unlimit credential fields.

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.

A screenshot showing the Unlimit payment method selection.

Webhooks or notifications

Payrails uses provider webhooks or notifications to receive asynchronous payment status updates.

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

In Payrails

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

In Unlimit

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

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

Request fields for Unlimit

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 Unlimit when you include them. For more about meta fields, refer to 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

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

→ Continue to: Test a payment

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Create a Unlimit integration in Payrails

Step 1: Choose the integration type

Step 2: Choose the provider