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

# Explore Payrails

> Browse the Payrails product suite, from payment orchestration and checkout SDKs to Token Vault, chargebacks, and analytics.

export const MaterialIcon = ({name, className = ""}) => {
  const paths = {
    account_tree: "M600-200v-40h-80q-33 0-56.5-23.5T440-320v-320h-80v40q0 33-23.5 56.5T280-520H160q-33 0-56.5-23.5T80-600v-160q0-33 23.5-56.5T160-840h120q33 0 56.5 23.5T360-760v40h240v-40q0-33 23.5-56.5T680-840h120q33 0 56.5 23.5T880-760v160q0 33-23.5 56.5T800-520H680q-33 0-56.5-23.5T600-600v-40h-80v320h80v-40q0-33 23.5-56.5T680-440h120q33 0 56.5 23.5T880-360v160q0 33-23.5 56.5T800-120H680q-33 0-56.5-23.5T600-200ZM160-760v160-160Zm520 400v160-160Zm0-400v160-160Zm0 160h120v-160H680v160Zm0 400h120v-160H680v160ZM160-600h120v-160H160v160Z",
    article: "M200-120q-33 0-56.5-23.5T120-200v-560q0-33 23.5-56.5T200-840h560q33 0 56.5 23.5T840-760v560q0 33-23.5 56.5T760-120H200Zm0-80h560v-560H200v560Zm0-560v560-560Zm120 480h200q17 0 28.5-11.5T560-320q0-17-11.5-28.5T520-360H320q-17 0-28.5 11.5T280-320q0 17 11.5 28.5T320-280Zm0-160h320q17 0 28.5-11.5T680-480q0-17-11.5-28.5T640-520H320q-17 0-28.5 11.5T280-480q0 17 11.5 28.5T320-440Zm0-160h320q17 0 28.5-11.5T680-640q0-17-11.5-28.5T640-680H320q-17 0-28.5 11.5T280-640q0 17 11.5 28.5T320-600Z",
    bar_chart: "M680-160q-17 0-28.5-11.5T640-200v-200q0-17 11.5-28.5T680-440h80q17 0 28.5 11.5T800-400v200q0 17-11.5 28.5T760-160h-80Zm-240 0q-17 0-28.5-11.5T400-200v-560q0-17 11.5-28.5T440-800h80q17 0 28.5 11.5T560-760v560q0 17-11.5 28.5T520-160h-80Zm-240 0q-17 0-28.5-11.5T160-200v-360q0-17 11.5-28.5T200-600h80q17 0 28.5 11.5T320-560v360q0 17-11.5 28.5T280-160h-80Z",
    brush: "M240-120q-45 0-89-22t-71-58q26 0 53-20.5t27-59.5q0-50 35-85t85-35q50 0 85 35t35 85q0 66-47 113t-113 47Zm0-80q33 0 56.5-23.5T320-280q0-17-11.5-28.5T280-320q-17 0-28.5 11.5T240-280q0 23-5.5 42T220-202q5 2 10 2h10Zm230-160L360-470l358-358q11-11 27.5-11.5T774-828l54 54q12 12 12 28t-12 28L470-360Zm-190 80Z",
    charger: "m471-197 166-324q5-10-1-19.5t-17-9.5H512v-209q0-8-7.5-9.5T493-763L327-439q-5 10 1 19.5t17 9.5h107v209q0 8 7.5 9.5T471-197Zm9 117q-83 0-156-31.5T197-197q-54-54-85.5-127T80-480q0-83 31.5-156T197-763q54-54 127-85.5T480-880q83 0 156 31.5T763-763q54 54 85.5 127T880-480q0 83-31.5 156T763-197q-54 54-127 85.5T480-80Zm0-400Zm226.5 226.5Q800-347 800-480t-93.5-226.5Q613-800 480-800t-226.5 93.5Q160-613 160-480t93.5 226.5Q347-160 480-160t226.5-93.5Z",
    chevron_right: "M504-480 348-636q-11-11-11-28t11-28q11-11 28-11t28 11l184 184q6 6 8.5 13t2.5 15q0 8-2.5 15t-8.5 13L404-268q-11 11-28 11t-28-11q-11-11-11-28t11-28l156-156Z",
    credit_card: "M880-720v480q0 33-23.5 56.5T800-160H160q-33 0-56.5-23.5T80-240v-480q0-33 23.5-56.5T160-800h640q33 0 56.5 23.5T880-720Zm-720 80h640v-80H160v80Zm0 160v240h640v-240H160Zm0 240v-480 480Z",
    notifications: "M200-200q-17 0-28.5-11.5T160-240q0-17 11.5-28.5T200-280h40v-280q0-83 50-147.5T420-792v-28q0-25 17.5-42.5T480-880q25 0 42.5 17.5T540-820v28q80 20 130 84.5T720-560v280h40q17 0 28.5 11.5T800-240q0 17-11.5 28.5T760-200H200Zm280-300Zm0 420q-33 0-56.5-23.5T400-160h160q0 33-23.5 56.5T480-80ZM320-280h320v-280q0-66-47-113t-113-47q-66 0-113 47t-47 113v280Z",
    payments: "M560-440q-50 0-85-35t-35-85q0-50 35-85t85-35q50 0 85 35t35 85q0 50-35 85t-85 35ZM280-320q-33 0-56.5-23.5T200-400v-320q0-33 23.5-56.5T280-800h560q33 0 56.5 23.5T920-720v320q0 33-23.5 56.5T840-320H280Zm80-80h400q0-33 23.5-56.5T840-480v-160q-33 0-56.5-23.5T760-720H360q0 33-23.5 56.5T280-640v160q33 0 56.5 23.5T360-400Zm400 240H120q-33 0-56.5-23.5T40-240v-400q0-17 11.5-28.5T80-680q17 0 28.5 11.5T120-640v400h640q17 0 28.5 11.5T800-200q0 17-11.5 28.5T760-160ZM280-400v-320 320Z",
    shield_person: "M380.5-480.5Q340-521 340-580t40.5-99.5Q421-720 480-720t99.5 40.5Q620-639 620-580t-40.5 99.5Q539-440 480-440t-99.5-40.5ZM523-537q17-17 17-43t-17-43q-17-17-43-17t-43 17q-17 17-17 43t17 43q17 17 43 17t43-17Zm-43 57Zm0-315-240 90v189q0 54 15 105t41 96q42-21 88-33t96-12q50 0 96 12t88 33q26-45 41-96t15-105v-189l-240-90Zm-70 523q-34 8-65 22 29 30 63 52t72 34q38-12 72-34t63-52q-31-14-65-22t-70-8q-36 0-70 8Zm57 187q-6-1-12-3-135-45-215-166.5T160-516v-189q0-25 14.5-45t37.5-29l240-90q14-5 28-5t28 5l240 90q23 9 37.5 29t14.5 45v189q0 140-80 261.5T505-88q-6 2-12 3t-13 1q-7 0-13-1Z",
    show_chart: "M97-280q0-17 13-30l213-213q23-23 57-23t57 23l103 103 256-289q11-13 28.5-13t29.5 12q11 11 11.5 26.5T855-656L596-364q-23 26-57 27.5T480-360L380-460 170-250q-13 13-30 13t-30-13q-13-13-13-30Z",
    warning: "M109-120q-11 0-20-5.5T75-140q-5-9-5.5-19.5T75-180l370-640q6-10 15.5-15t19.5-5q10 0 19.5 5t15.5 15l370 640q6 10 5.5 20.5T885-140q-5 9-14 14.5t-20 5.5H109Zm69-80h604L480-720 178-200Zm330.5-51.5Q520-263 520-280t-11.5-28.5Q497-320 480-320t-28.5 11.5Q440-297 440-280t11.5 28.5Q463-240 480-240t28.5-11.5Zm0-120Q520-383 520-400v-120q0-17-11.5-28.5T480-560q-17 0-28.5 11.5T440-520v120q0 17 11.5 28.5T480-360q17 0 28.5-11.5ZM480-460Z",
    link: "M280-280q-83 0-141.5-58.5T80-480q0-83 58.5-141.5T280-680h120q17 0 28.5 11.5T440-640q0 17-11.5 28.5T400-600H280q-50 0-85 35t-35 85q0 50 35 85t85 35h120q17 0 28.5 11.5T440-320q0 17-11.5 28.5T400-280H280Zm80-160q-17 0-28.5-11.5T320-480q0-17 11.5-28.5T360-520h240q17 0 28.5 11.5T640-480q0 17-11.5 28.5T600-440H360Zm200 160q-17 0-28.5-11.5T520-320q0-17 11.5-28.5T560-360h120q50 0 85-35t35-85q0-50-35-85t-85-35H560q-17 0-28.5-11.5T520-640q0-17 11.5-28.5T560-680h120q83 0 141.5 58.5T880-480q0 83-58.5 141.5T680-280H560Z",
    delete: "M280-120q-33 0-56.5-23.5T200-200v-520h-40q-17 0-28.5-11.5T120-760q0-17 11.5-28.5T160-800h160q0-17 11.5-28.5T360-840h240q17 0 28.5 11.5T640-800h160q17 0 28.5 11.5T840-760q0 17-11.5 28.5T800-720h-40v520q0 33-23.5 56.5T680-120H280Zm80-200q0 17 11.5 28.5T400-280q17 0 28.5-11.5T440-320v-320q0-17-11.5-28.5T400-680q-17 0-28.5 11.5T360-640v320Zm160 0q0 17 11.5 28.5T560-280q17 0 28.5-11.5T600-320v-320q0-17-11.5-28.5T560-680q-17 0-28.5 11.5T520-640v320Z",
    deselect: "M792-56 56-792q-11-11-11-28t11-28q11-11 28-11t28 11l736 736q11 11 11 28t-11 28q-11 11-28 11t-28-11ZM680-320H488l-80-80h272v-272l-80-80v432Zm160-240v-80h-80v80h80Zm0-160v-80h-80v80h80ZM680-800v80h80q0-33-23.5-56.5T680-800ZM520-800v80h80v-80h-80ZM360-800v80h80v-80h-80ZM200-800q-33 0-56.5 23.5T120-720h80v-80Zm0 160h-80v80h80v-80Zm0 160h-80v80h80v-80Zm0 160h-80q0 33 23.5 56.5T200-240v-80Z",
    select_all: "M200-120q-33 0-56.5-23.5T120-200v-80h80v80h80v-80h80v80h-80Zm240 0v-80h80v80h-80Zm160 0v-80h80v80h-80Zm160 0v-80h80q0 33-23.5 56.5T800-120h-80ZM120-360v-80h80v80h-80Zm680 0v-80h80v80h-80ZM120-520v-80h80v80h-80Zm680 0v-80h80v80h-80ZM120-680q0-33 23.5-56.5T200-800h80v80h-80v80h-80Zm240-120v-80h80v80h-80Zm160 0v-80h80v80h-80Zm160 0v-80h80q33 0 56.5 23.5T840-720h-80v-80h-80ZM280-280v-400h400v400H280Zm80-80h240v-240H360v240Z"
  };
  const d = paths[name.replace(/-/g, "_")];
  if (!d) return null;
  return <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960" width="24" height="24" fill="currentColor" aria-hidden="true" className={[className, 'pr-icon'].join(' ')} style={{
    flexShrink: 0
  }}>
      <path d={d} />
    </svg>;
};

## Products

<div class="not-prose pr-card-group pr-card-group--cols-3">
  <a href="/docs/overview/workflows" class="pr-card">
    <div class="pr-card__body">
      <div class="pr-card__header">
        <div class="pr-card__icon">
          <MaterialIcon name="account-tree" />
        </div>

        <span class="pr-card__title">Payment Orchestration</span>
      </div>

      <p class="pr-card__text">Build your payment workflows and unlock new integrations no-code</p>
    </div>
  </a>

  <a href="/docs/orchestration/checkout-sdks" class="pr-card">
    <div class="pr-card__body">
      <div class="pr-card__header">
        <div class="pr-card__icon">
          <MaterialIcon name="brush" />
        </div>

        <span class="pr-card__title">Checkout SDKs</span>
      </div>

      <p class="pr-card__text">Customizable and configurable SDKs to optimize your checkout experience</p>
    </div>
  </a>

  <a href="/docs/token-vault/getting-started" class="pr-card">
    <div class="pr-card__body">
      <div class="pr-card__header">
        <div class="pr-card__icon">
          <MaterialIcon name="credit-card" />
        </div>

        <span class="pr-card__title">Token Vault</span>
      </div>

      <p class="pr-card__text">Provider agnostic PCI-certified vault that connects you to any third party</p>
    </div>
  </a>

  <a href="/docs/analytics-and-reporting/unified-analytics" class="pr-card">
    <div class="pr-card__body">
      <div class="pr-card__header">
        <div class="pr-card__icon">
          <MaterialIcon name="show-chart" />
        </div>

        <span class="pr-card__title">Analytics & Reporting</span>
      </div>

      <p class="pr-card__text">Unified analytics of Payrails and non-Payrails data for insights about your payment performance</p>
    </div>
  </a>

  <a href="/docs/fraud-management/fraud-score" class="pr-card">
    <div class="pr-card__body">
      <div class="pr-card__header">
        <div class="pr-card__icon">
          <MaterialIcon name="shield-person" />
        </div>

        <span class="pr-card__title">Fraud Management</span>
      </div>

      <p class="pr-card__text">Anti-fraud solutions for scoring and connecting to a range of providers</p>
    </div>
  </a>

  <a href="/docs/orchestration/payment-links" class="pr-card">
    <div class="pr-card__body">
      <div class="pr-card__header">
        <div class="pr-card__icon">
          <MaterialIcon name="link" />
        </div>

        <span class="pr-card__title">Payment Links</span>
      </div>

      <p class="pr-card__text">Shareable, no-code links to collect payments without a full integration</p>
    </div>
  </a>

  <a href="/docs/monitoring/configure-alerts" class="pr-card">
    <div class="pr-card__body">
      <div class="pr-card__header">
        <div class="pr-card__icon">
          <MaterialIcon name="notifications" />
        </div>

        <span class="pr-card__title">Monitoring</span>
      </div>

      <p class="pr-card__text">Monitoring for better visibility around payment performance</p>
    </div>
  </a>

  <a href="/docs/chargebacks/getting-started" class="pr-card">
    <div class="pr-card__body">
      <div class="pr-card__header">
        <div class="pr-card__icon">
          <MaterialIcon name="warning" />
        </div>

        <span class="pr-card__title">Chargebacks</span>
      </div>

      <p class="pr-card__text">Manage your chargebacks and unlock new integrations no-code</p>
    </div>
  </a>
</div>

***

## Integration Steps

From the start of the integration until the first transaction on live, there are **5 steps to complete**.

Our **onboarding team**, consisting of onboarding managers and technical solution engineers, will support you during all integration steps.

### 1. Explore the products and modules for your business needs

Payrails offers modular components that enable merchants to tailor their own payment infrastructure and needs, such as payment orchestration, PCI token vault, network tokenization, payment data analytics, in-person payments, fraud management, and alternative payment methods.

### 2. Set up your account and environments

The first step involves configuring your Payrails environment. This includes setting up your staging and production environments, configuring your settings, and performing tests to ensure integration is functioning as expected.

### 3. Integrate Payrails APIs

Depending on your desired setup, the APIs that you will need to integrate and the configuration to be set up will be defined during the integration phase. Payrails provides multiple ways to integrate with your existing systems. You can use our SDKs for a more seamless integration experience or build server-to-server integration.

[PSP integration setup guides](/docs/orchestration/integrations)

### 4. Configure your merchant settings

Once you've integrated Payrails, the next step is to customize your settings. Depending on the products you are using, you will navigate to our Portal or use the API reference to configure your setup flexibly.

### 5. Test on staging and going live

Once the environment setup, integration, and configurations are completed, you can use our testing features in our Portal, such as testing workflow configurations by simulating your customized payment requests, creating test payment instruments, and reviewing the API logs. After confirmation of all scenarios on staging, you can move to the production environment to go live.


## Related topics

- [Quick Start Guide](/docs/orchestration/workflow-studio/quick-start.md)
- [Unified Analytics](/docs/analytics-and-reporting/unified-analytics.md)


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