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

# HiPay

> Request Console API credentials from your HiPay account manager, then add the HiPay integration in the Portal.

<picture noZoom>
  ![HiPay logo](https://assets.payrails.io/img/logos/hipay/logo-full-bleed.svg)
</picture>

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.


## Related topics

- [HiPay](https://docs.payrails.com/docs/integrations/payment-providers/hipay.md)
- [Payrails Web Fraud SDK](https://docs.payrails.com/docs/sdks/fraud-sdk.md)
- [Connect your data sources](https://docs.payrails.com/docs/integrations/data-sources.md)


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