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

# Payabl.

> A step-by-step guide for setting up your payabl. integration in the Payrails portal.

<Note>
  **Who should use this guide**

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **payabl.** to accept **card, Apple Pay, and Google Pay** payments

  payabl. is a server-to-server connector with no hosted payment page and no redirect flow for cards. Your shopper enters card details directly in your checkout through the Payrails SDK's secure fields, or pays with Apple Pay or Google Pay, and payment details go directly to payabl.'s API.
</Note>

## Create and configure a payabl. integration in Payrails

Follow these steps to set up payabl.:

1. Log in to the **Payrails** portal.
2. Go to **Settings → Integrations → Payments**.
3. Select **Add instance** to create a new payabl. integration configuration.
4. Select the **workspaces** where this integration should be available.

<Note>
  **About workspaces**

  Workspaces determine where this integration is available. They let you isolate provider setups by region or business line, or share the same configuration across multiple workspaces.
</Note>

## Step 2: Choose the provider

Select **payabl.** and continue to the next step.

<img src="https://mintcdn.com/payrails-42074109/yf-DMcCRiMaVxlBA/images/docs/integrations/orchestration/payabl-image-01.png?fit=max&auto=format&n=yf-DMcCRiMaVxlBA&q=85&s=cf96a4de3cae9dc6f7a171a69f9c17dd" alt="Payrails provider selection set to payabl." className="mx-auto block rounded-lg object-cover border border-gray-200" width="100%" data-path="images/docs/integrations/orchestration/payabl-image-01.png" />

## Step 3: Configure your payabl. integration

<Tip>
  **What you'll need from payabl.**

  Before you begin, make sure you have access to your **payabl. dashboard** and the following:

  * **Merchant ID**—your payabl. merchant/account identifier, used to authenticate every request
  * **Shared Secret**—used to sign every request and to verify that notifications genuinely come from payabl.
</Tip>

### Integration instance name

> An integration instance is a specific payment provider setup in Payrails. You can create multiple instances for each provider based on region, currency, or business needs. Choose a clear, consistent name, since it's used in routing.

**In Payrails**

* Enter an **Instance name** for your integration.

<img src="https://mintcdn.com/payrails-42074109/yf-DMcCRiMaVxlBA/images/docs/integrations/orchestration/payabl-image-02.png?fit=max&auto=format&n=yf-DMcCRiMaVxlBA&q=85&s=252827169731610aa410e26f6c5c50f5" alt="Payrails integration instance name field for payabl." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/integrations/orchestration/payabl-image-02.png" />

### Account details—Merchant ID & Shared Secret

**In payabl.**

* Log in to your payabl. dashboard and locate your **Merchant ID & Shared Secret**.

**In Payrails**

* Enter the **Merchant ID & Shared Secret** fields with the value from your payabl. account.

<img src="https://mintcdn.com/payrails-42074109/yf-DMcCRiMaVxlBA/images/docs/integrations/orchestration/payabl-image-03.png?fit=max&auto=format&n=yf-DMcCRiMaVxlBA&q=85&s=4ad77a26112c34b8832cbfda9b2ae484" alt="Payrails Merchant ID and Shared Secret fields for payabl." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/integrations/orchestration/payabl-image-03.png" />

Store your Shared Secret securely. Payrails uses it to sign every request sent to payabl. and to verify that notifications genuinely come from payabl.

### Payment methods

**In Payrails**

* Under **Payment methods**, enable **Card**, **Apple Pay**, and/or **Google Pay** as needed. Each has its own configuration block.

<Warning>
  **Apple Pay requires additional setup**

  Enabling Apple Pay on the payabl. provider config alone is not enough—you also need a valid **Apple Pay configuration** (certificate or merchant identity) set up on the Payrails side under Apple Pay settings for your workspace.
</Warning>

## Meta fields

payabl. requires the following fields on every request. Make sure your checkout collects them and maps them into the corresponding Payrails fields.

| Payrails field | payabl. field | Requirement | Notes |
| - | - | - | - |
| `customer.email` | `email` | Required | RFC 822, max 50 |
| `clientContext.ipAddress` | `customerip` | Required | IPv4/IPv6, max 39 |
| Cardholder name (instrument's `holderName` wins over meta when both present) | `cardholder_name` | Required | max 50 |
| `customer.name` | `firstname` | Required | max 30 |
| `customer.lastName` | `lastname` | Required | max 30 |
| `order.billingAddress.street` | `street` | Required | max 100; mandatory for AFT |
| `order.billingAddress.postalCode` | `zip` | Required | max 10; mandatory for AFT |
| `order.billingAddress.city` | `city` | Required | max 40; mandatory for AFT |
| `order.billingAddress.country` | `country` | Required | ISO 3166-1 alpha-3, max 3; mandatory for AFT |
| `order.billingAddress.state` | `state` | Required for USA/Canada only | max 30 |

## Enable the integration

**In Payrails**

* Select **Save account** to save the configuration and enable the integration.
* The **Enabled** status confirms that the payabl. integration is active.

Your payabl. integration is now ready to process payments.

## Next steps

1. Run a test payment in **test mode** using payabl.'s sandbox testing credentials:
   * Non-3DS test cards: see payabl.'s [testing credentials](https://docs.payabl.com/docs/testing-credentials).
   * 3DS test cards: see payabl.'s [3D Secure testing credentials](https://docs.payabl.com/docs/3d-secure-testing-credentials).
2. Verify that:
   * The payment appears in your **payabl. dashboard**.
   * The payment status updates correctly in **Payrails**.
3. Once verified in test mode, repeat the setup in **live mode**.

Continue to: [Test a payment](/docs/orchestration/payment-acceptance/test-payments)


## Related topics

- [Integrations](/docs/orchestration/integrations/index.md)