Skip to main content
This guide explains how to enable Console API access in HiPay and connect HiPay as a data source in Payrails to ingest settlement, processing activity, payout, and dispute data. With the self-serve flow, you configure the integration yourself in the Payrails portal.

​
Prerequisites

  • An active HiPay merchant account
  • A point of contact who can provision Console API access, such as your HiPay account manager

​
Overview

Payrails ingests HiPay data through the Console API using a username and password login. HiPay exchanges this login for a short-lived access token on each request, so it does not store a static API key.

​
Step-by-step instructions

​
Step 1: Request Console API credentials from HiPay

  1. Contact your HiPay account manager.
  2. Request a Console API login with read access to the Transaction and Financial Report exports. Ask for these two values:
    1. Username (typically an email address)
    2. Password
  3. Store the credentials securely after HiPay provisions them. Treat the password like any other login credential.

​
Step 2: Add the HiPay integration in the Payrails portal (self-serve)

  1. Log in to the Payrails dashboard and open Settings → Integrations → Data.
  2. Click Add instance.
  3. In New instance, select HiPay as the provider and click Continue.
  4. On the Configure account screen, fill in:
    • Integration instance name: a unique label.
    • Start Date: today. Payrails cannot backfill data through the self-serve flow. Contact your Payrails account manager if you need historical data.
    • Username: your HiPay Console API username.
    • Password: your HiPay Console API password. Payrails stores this value masked.
  5. Click Save account. The instance appears in the Data integrations list, and Payrails begins ingesting data the next day.
Last modified on September 24, 2026