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

# Boku

> Connect Boku to Payrails for mobile wallets, UPI, NIBSS and direct carrier billing, covering your merchant ID, key ID and API key.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Boku** for mobile wallets such as [Easypaisa](/docs/orchestration/payment-methods/easypaisa/boku), [JazzCash](/docs/orchestration/payment-methods/jazzcash/boku) and [Egypt mobile wallets](/docs/orchestration/payment-methods/egypt-mobile-wallets/boku), or for [UPI](/docs/orchestration/payment-methods/upi/boku), [NIBSS](/docs/orchestration/payment-methods/nibss/boku), [Paga Wallet](/docs/orchestration/payment-methods/paga-wallet/boku) or [direct carrier billing](/docs/orchestration/payment-methods/direct-carrier-billing/boku)
  * Have an active Boku merchant account
</Note>

***

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

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

***

## Step 3: Configure your Boku integration

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

  Before you begin, make sure you have your Boku merchant ID, key ID and API key. Boku provides them when it sets up your 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_boku`.

<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 |
| :- | :- |
| **Merchant ID** | Your Boku merchant ID |
| **Key ID** | The key ID of your Boku API key |
| **If true, use this config on Boku's merchant test environment** | Refer to [Configure Boku settings](#configure-boku-settings). |

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

***

### Credentials

**In Payrails**

| Field | Value |
| :- | :- |
| **API key** | Your Boku API key. Payrails signs every request with it and verifies notifications from Boku. |

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

***

### Payment methods

**In Payrails**

* Select the methods you want to accept through Boku.

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

***

### Webhooks or notifications

Payrails sends its notification URL to Boku with every payment, so you don't need to set one up in the Boku dashboard. Payrails verifies each notification with your API key.

***

## Request fields for Boku

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

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Boku as the total amount and currency. |
| `meta.customer.country.code` | Required | Sent as the country. Payrails also uses it to pick the Boku region. |
| `meta.order.description` | Required | Up to 255 characters. Sent as the item description. |
| `meta.clientContext.osType`, `meta.clientContext.userAgent` | Required | Payrails uses them to show Boku's mobile flow to customers on mobile devices. |
| `meta.customer.phone.number` | Required | Direct carrier billing only, on the customer's first payment. Sent as the mobile number that receives the one-time password. |
| `meta.customer.reference` | Optional | Sent as the consumer ID. |
| `meta.clientContext.ipAddress` | Optional | Sent as the consumer IP. |
| `merchantReference` | Optional | Sent as the merchant transaction ID. |

***

## Configure Boku settings

Some Boku integration settings change how Payrails processes your payments. The portal shows the same description when you hover over each setting.

| Setting | What it does |
| :- | :- |
| **If true, use this config on Boku's merchant test environment** | Turn this on for a Boku test account. When the Payrails integration is in test mode and this is on, Payrails sends requests to Boku's merchant test environment. Otherwise Payrails sends them to Boku's live environment. |

***

## Enable the integration

**In Payrails**

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

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

***

## Next steps

1. With the setting above turned on, run a test payment in test mode.
2. Verify that:
   * Your customer is redirected to Boku and back to your site.
   * The payment status updates correctly in Payrails.
3. Once verified, repeat the setup with your live Boku account.

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


## Related topics

- [UPI via Boku](/docs/orchestration/payment-methods/upi/boku.md)
- [NIBSS via Boku](/docs/orchestration/payment-methods/nibss/boku.md)
- [Paga Wallet via Boku](/docs/orchestration/payment-methods/paga-wallet/boku.md)


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