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

# Flutterwave

> Connect Flutterwave to Payrails for cards, bank transfers and local methods in Africa, covering your API keys and webhook.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Flutterwave** for cards, [bank transfers](/docs/orchestration/payment-methods/bank-transfers/flutterwave), [Mono](/docs/orchestration/payment-methods/mono/flutterwave), [OPay](/docs/orchestration/payment-methods/opay/flutterwave), [1Voucher](/docs/orchestration/payment-methods/1voucher/flutterwave) or [FawryPay](/docs/orchestration/payment-methods/fawrypay/flutterwave)
  * Have access to the Flutterwave dashboard
</Note>

***

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

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

***

## Step 3: Configure your Flutterwave integration

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

  Before you begin, make sure you can log in to the Flutterwave dashboard. You'll copy your API keys and set up a webhook there.
</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_flutterwave`.

<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 Flutterwave**

1. In the Flutterwave dashboard, go to **Settings** → **API Keys**.
2. Copy the secret key, public key and encryption key.

**In Payrails**

| Field | Value |
| :- | :- |
| **API key** | Your Flutterwave secret key |
| **Encryption key** | Your Flutterwave encryption key. Payrails encrypts card details with it. |
| **Notification Secret Hash** | The secret hash of your Flutterwave webhook. Fill it in after you set up the webhook in the next section. |
| **Public key** | Your Flutterwave public key |

Payments go to Flutterwave's test or live mode depending on your keys, so use the keys that match the mode of your Payrails integration.

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

***

### Payment methods

**In Flutterwave**

* To add a payment method to your Flutterwave account, go to **Settings** → **Business Preferences** → **Payment Methods** and select **Enable** next to it.

**In Payrails**

* Select **Card**, **Bank Transfer**, **Direct Debit Via Mono**, **Opay**, **1Voucher**, **FawryPay** or any combination.

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

***

### Webhooks or notifications

<Info>
  Payrails uses provider webhooks or notifications to receive asynchronous
  payment status updates.
</Info>

<Warning>
  Create webhooks in the same mode (test or live) as your Payrails integration.
</Warning>

**In Payrails**

* Copy the **Notification URL** shown under **Account configuration** at the top of the integration form.

**In Flutterwave**

1. In the Flutterwave dashboard, go to **Settings** → **Webhooks**.
2. Paste the Payrails notification URL as the webhook URL.
3. Enter a secret hash and save the changes.
4. Enter the same secret hash in the **Notification Secret Hash** field in Payrails.

***

## Request fields for Flutterwave

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 Flutterwave when you include them. For more about meta fields, refer to [Meta fields](/docs/orchestration/meta-fields).

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Flutterwave as the amount and currency. |
| `meta.customer.email` | Required | Sent as the customer email. |
| `merchantReference` | Optional | Sent as the transaction reference. |
| `instrument.holderName` | Optional | Sent as the card holder name. |
| `meta.risk.threeDSMode` | Optional | `Force` asks Flutterwave to run 3D Secure. |
| `instrument.storeInstrument` | Optional | Stores the card with Flutterwave for later payments. |

***

## Enable the integration

**In Payrails**

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

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

***

## Next steps

1. Run a test card payment with your Flutterwave test keys.
2. Verify that:
   * The payment appears in the Flutterwave dashboard.
   * The payment status updates correctly in Payrails.
3. Once verified in test mode, repeat the setup with your live keys.

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


## Related topics

- [Mono via Flutterwave](/docs/orchestration/payment-methods/mono/flutterwave.md)
- [Opay via Flutterwave](/docs/orchestration/payment-methods/opay/flutterwave.md)
- [1Voucher via Flutterwave](/docs/orchestration/payment-methods/1voucher/flutterwave.md)


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