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

# Payflex

> Connect Payflex to Payrails to offer buy now, pay later in South Africa, covering your Payflex client ID and client secret.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Payflex** to offer [buy now, pay later](/docs/orchestration/payment-methods/payflex) in South Africa
  * Have an active Payflex merchant account with API credentials
</Note>

***

## Create a Payflex integration in Payrails

1. Log in to the **Payrails** portal.
2. Go to **Settings** → **Integrations**.
3. Select **Add instance** to create a new 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 1: Choose the integration type

* Select **Payment**.
* Continue to the next step.

***

## Step 2: Choose the provider

* Select **Payflex**.
* Continue to the next step.

<img src="https://mintcdn.com/payrails-42074109/5bgwNQYa4BxIPDBd/images/docs/payflex-image-01.png?fit=max&auto=format&n=5bgwNQYa4BxIPDBd&q=85&s=c86ccd53418882895b3d56aed7075351" alt="A screenshot showing Payflex selected as the provider." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/payflex-image-01.png" />

***

## Step 3: Configure your Payflex integration

<Tip>
  **What you'll need from Payflex**

  Before you begin, make sure you have your Payflex client ID and client secret. Payflex provides them when it sets up your merchant account.
</Tip>

***

### Integration instance name

> An integration instance is a specific payment provider setup in Payrails. You can create multiple instances for different regions, currencies, or business needs. Choose a clear, consistent name, as it is used in routing.

**In Payrails**

* Enter an **Instance name** for your integration, for example `merchant_payflex`.

<img src="https://mintcdn.com/payrails-42074109/145W1v58K5wnDMNC/images/docs/orchestration/integrations/shared/integration-instance-name.png?fit=max&auto=format&n=145W1v58K5wnDMNC&q=85&s=470be58979509680650b0cbf8b5eecc4" alt="A screenshot showing the integration instance name field." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/orchestration/integrations/shared/integration-instance-name.png" />

***

### Credentials

**In Payrails**

| Field | Value |
| :- | :- |
| **Client ID** | Your Payflex client ID |
| **Client Secret** | Your Payflex client secret |

Payrails exchanges these for an access token with every request. It sends requests to the Payflex UAT environment in test mode and to the live environment in live mode, so use the credentials for the matching environment.

<img src="https://mintcdn.com/payrails-42074109/5bgwNQYa4BxIPDBd/images/docs/payflex-image-02.png?fit=max&auto=format&n=5bgwNQYa4BxIPDBd&q=85&s=32feb6634ebc99eabe01c6051675785e" alt="A screenshot showing the Payflex credential fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/payflex-image-02.png" />

***

### Payment methods

**In Payrails**

* Select **Payflex**.

<img src="https://mintcdn.com/payrails-42074109/5bgwNQYa4BxIPDBd/images/docs/payflex-image-03.png?fit=max&auto=format&n=5bgwNQYa4BxIPDBd&q=85&s=d14ca5ef39623af00ed35eac39c7e7df" alt="A screenshot showing the Payflex payment method selection." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/payflex-image-03.png" />

***

### Webhooks or notifications

Payrails sends its notification URL to Payflex with every payment, so you don't need to set one up in the Payflex dashboard. Payrails confirms each notification by checking the order with Payflex.

***

## Request fields for Payflex

Send these fields in the [authorize request](/reference/authorizeaction), in addition to the standard authorize fields. **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to Payflex when you include them. For more about meta fields, refer to [Meta fields](/docs/orchestration/meta-fields).

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Payflex as the order amount. Use ZAR. |
| `merchantReference` | Optional | Sent as the order's merchant reference. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent as the consumer's given names and surname. |
| `meta.customer.email` | Optional | Sent as the consumer's email. |
| `meta.customer.phone` | Optional | Sent as the consumer's phone number, country code first. |
| `meta.order.lines` | Optional | Sent as the order items, with `name`, `description`, `quantity` and `unitPrice`, or `total`. Discount lines reduce the price. |
| `meta.order.shipping` | Optional | Sent as the shipping amount. |
| `meta.order.totalTax` | Optional | Sent as the tax amount. |

When you send `meta.order`, the order lines, shipping, tax and discounts must add up to `amount`.

***

## Enable the integration

**In Payrails**

* Select **Save account** to enable the integration.
* Confirm the integration shows as **Enabled**.

Your **Payflex** integration is now ready to process payments.

***

## Next steps

1. Run a test Payflex payment in ZAR in the Payflex UAT environment.
2. Verify that:
   * The order appears in Payflex.
   * 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

- [Payflex](/docs/orchestration/payment-methods/payflex.md)
- [Payflex direct integration](/docs/orchestration/payment-methods/payflex/payflex.md)
- [Payflex via dLocal](/docs/orchestration/payment-methods/payflex/dlocal.md)


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