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

# Connect your data sources

> Add your payment providers as data sources in the Payrails Portal to power analytics, reporting, and fee monitoring.

> [!NOTE]
>
> To power Analytics & Reporting in Payrails (specifically as standalone product
> and for fee monitoring), connect your payment providers as **data sources**.
> With **self-serve data integrations**, you create and configure each
> integration yourself in the Payrails portal - no manual setup or intervention
> from Payrails teams is required. You can add a data source in the Payrails
> Portal by following the setup guides below.

Each setup guide walks you through how to connect a provider as a data source in Payrails. It includes:

* Required prerequisites
* Provider-side steps to generate API credentials or gather SFTP details
* How to add and configure the integration in the Payrails portal (self-serve)

Use these guides when adding a new data source or reviewing an existing setup.

***

## How the self-serve flow works

After gathering the required credentials from your provider (see each provider guide), connect the data source in Payrails:

1. Log in to the **Payrails portal**.
2. Open **Settings → Integrations → Data**.
3. Click **Add instance** in the top-right corner of the Data integrations list.
4. On the **Select provider** screen, choose your provider and click **Continue**.
5. On the **Configure account** screen, enter the **Integration instance name**, the provider's **settings and credentials**, and *(optionally)* **Additional data**.
6. Click **Save account**.

The new instance appears in the **Data integrations** list with its status, and Payrails begins ingesting data automatically.

***

## Edit or disable an integration instance

You can manage an existing integration at any time from **Settings → Integrations → Data**:

* **Edit:** open the instance from the Data integrations list to update its name, settings, or credentials, then click **Save account**. Use this to rotate an API key, add a merchant account, or adjust the start date.
* **Disable / enable:** change the instance's status. Disabling stops Payrails from pulling new data for that instance without deleting its configuration — you can re-enable it again later.

## What to expect after enabling

* **First run:** once you save and enable an instance, it is picked up on the next scheduled pipeline run.
* **Freshness:** the pipeline pulls from each provider on a **daily** basis. Data is expected to be available in Payrails within **\~3 hours** of the pipeline run completing.
* **Where data lands:** ingested data feeds **Analytics & Reporting** — it appears in the reports and dashboards (Unified Analytics) for the configured workspace.

## Backfilling historical data

> [!WARNING]
>
> Self-serve backfilling is **not available yet**. If you need historical data
> ingested (for a period before your start date), reach out to your **Payrails
> account manager** to arrange it. Self-serve backfilling is in progress and
> will be enabled over self-serve in a future release.

***

## Data integration setup guides

> [!TIP]
>
> These providers are configured exclusively through the self-serve flow, with
> new providers added regularly.

> [card]
>
> Adyen logo
>
> AdyenData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/adyen.md)

> [card]
>
> Amex logo
>
> AmexData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/amex.md)

> [card]
>
> Braintree logo
>
> BraintreeData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/braintree.md)

> [card]
>
> Checkout.com logo
>
> Checkout.comData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/checkout.md)

> [card]
>
> dLocal logo
>
> dLocalData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/dlocal.md)

> [card]
>
> HiPay logo
>
> HiPayData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/hipay.md)

> [card]
>
> J.P.Morgan logo
>
> J.P.MorganData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/jp-morgan.md)

> [card]
>
> Klarna logo
>
> KlarnaData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/klarna.md)

> [card]
>
> MangoPay logo
>
> MangoPayData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/mangopay.md)

> [card]
>
> Nuvei logo
>
> NuveiData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/nuvei.md)

> [card]
>
> PayPal logo
>
> PayPalData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/paypal.md)

> [card]
>
> Payplug logo
>
> PayplugData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/payplug.md)

> [card]
>
> Stripe logo
>
> StripeData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/stripe.md)

> [card]
>
> TAP logo
>
> TAPData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/tap.md)

> [card]
>
> Unlimit logo
>
> UnlimitData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/unlimit.md)

> [card]
>
> Vipps/MobilePay logo
>
> Vipps/MobilePayData integration
>
> [Open](https://docs.payrails.com/docs/integrations/data-sources/vippsmobilepay.md)


## Related topics

- [Analytics & Reporting](https://docs.payrails.com/docs/analytics-and-reporting.md)
- [Unlimit](https://docs.payrails.com/docs/integrations/data-sources/unlimit.md)
- [Checkout](https://docs.payrails.com/docs/integrations/data-sources/checkout.md)


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