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

# PayU

> Connect PayU South Africa to Payrails for cards and EFT Pro, covering your PayU username, password and SafeKey.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **PayU South Africa** for cards or [EFT Pro](/docs/orchestration/payment-methods/eft-pro/payu)
  * Have an active PayU South Africa merchant account
</Note>

***

## Create a PayU 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 **Payu**.
* Continue to the next step.

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

***

## Step 3: Configure your PayU integration

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

  Before you begin, make sure you have your PayU API username, password and SafeKey. PayU provides them when it sets up your account. To add a payment method to your PayU account, contact PayU.
</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_payu`.

<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" />

***

### Account details

**In Payrails**

| Field | Value |
| :- | :- |
| **Username** | Your PayU API username |

<img src="https://mintcdn.com/payrails-42074109/gaRJ_PXlJkN8nlyV/images/docs/payu-image-02.png?fit=max&auto=format&n=gaRJ_PXlJkN8nlyV&q=85&s=71397d3d8176d66f84e0894060f08991" alt="A screenshot showing the PayU account details fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/payu-image-02.png" />

***

### Credentials

**In Payrails**

| Field | Value |
| :- | :- |
| **Password** | Your PayU API password |
| **Secret Key** | Your PayU SafeKey |

Payrails sends requests to the PayU staging 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/gaRJ_PXlJkN8nlyV/images/docs/payu-image-03.png?fit=max&auto=format&n=gaRJ_PXlJkN8nlyV&q=85&s=f343937873914830545b15d3501f844b" alt="A screenshot showing the PayU credential fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/payu-image-03.png" />

***

### Payment methods

**In Payrails**

* Select **Card**, **EFT Pro** or both.

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

***

### Webhooks or notifications

Payrails sends its notification URL to PayU with every payment, so you don't need to set one up in the PayU dashboard. Payrails confirms each notification by fetching the transaction from PayU with your credentials.

***

## Request fields for PayU

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

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to PayU in cents, with the currency. Use ZAR. |
| `holderReference` | Required | When you store the card. Sent as the merchant user ID. |
| `merchantReference` | Optional | Sent as the merchant reference. |
| `description` | Optional | Sent as the basket description. |
| `instrument.holderName` | Optional | Sent as the name on the card. |
| `meta.customer.name`, `lastName`, `email` | Optional | Sent as the customer's first name, last name and email. |
| `meta.customer.phone.number` | Optional | Sent as the customer's mobile number. |
| `meta.customer.birthDate` | Optional | Sent as the customer's date of birth. |
| `meta.risk.threeDSMode` | Optional | `Force` runs 3D Secure. `Skip` turns it off. |
| `returnInfo.cancelUrl` | Optional | Sent as the cancel URL. |
| `instrument.storeInstrument` | Optional | Asks PayU to store the card for later payments. |

PayU payments are captured straight away, so use instant capture in your workflow.

***

## Enable the integration

**In Payrails**

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

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

***

## Next steps

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

- [EFT Pro via PayU](/docs/orchestration/payment-methods/eft-pro/payu.md)
- [EFT Pro](/docs/orchestration/payment-methods/eft-pro.md)
- [Integrations](/docs/orchestration/integrations.md)


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