Unlimit

This guide explains how to connect Unlimit as a data source in Payrails. Payrails pulls your settlement reports from the Unlimit Reports API every day, and you configure the integration yourself in the Payrails portal.

Prerequisites

You need:

• An active Unlimit merchant account with at least one live wallet
• The terminal code and password of the terminal you process payments with. The terminal code is the Wallet ID shown in the Unlimit Merchant Account dashboard, and the password is under that wallet's Show credentials
• The Reports API enabled on that terminal (see Step 2)

  📘

  If Payrails already processes payments for you through Unlimit, the terminal code and password are the same ones stored in your Unlimit payment integration. No new credential is required.

Overview

Unlimit publishes one settlement report per wallet and settlement date. A single terminal code gives access to the reports of every wallet under your Unlimit client, so one integration instance covers your whole account. Payrails currently ingests the regular settlement report.

Step-by-step instructions

Step 1: Locate your terminal code and password

1. Log in to the Unlimit Merchant Account dashboard: production or sandbox.
2. Open the wallet you process payments with and note its Wallet ID. This is the terminal code.
3. Go to Settings → Wallet settings → Show credentials on that wallet to view the terminal password.

Step 2: Confirm the Reports API is enabled

The Reports API is a separate permission on the terminal, enabled by Unlimit. If it's missing, the first report request fails with 403 Missing required grant. Ask your Unlimit account manager to enable Reports API access for your terminal before you continue, or if Payrails reports the error after setup.

Step 3: Add the Unlimit integration in the Payrails portal (self-serve)

1. Log in to the Payrails portal and open Settings → Integrations → Data.
2. Click Add instance (top-right).
3. In New instance, select provider: Unlimit and click Continue.
4. On the Configure account screen, fill in:
   • Integration instance name: a unique label.
   • Description: a brief description of this integration instance.
   • Start Date: the date from which Payrails fetches reports. Use today's date. For earlier data, contact your Payrails account manager.
   • API host: the Unlimit environment your terminal belongs to: https://cardpay.com for the global platform, https://psp.in.unlimit.com for the India platform. Use the matching sandbox host for a test terminal.
   • Terminal Code: the Wallet ID from Step 1.
   • Password: the terminal password from Step 1.
   • (Optional) Additional data.
5. Click Save account. The instance appears in the Data integrations list and Payrails begins ingesting data on the next daily run.