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

# JazzCash via Boku

> Set up JazzCash payments through Boku in Payrails, and see the country, order description and client context Boku requires.

<picture noZoom>
  ![JazzCash logo](https://assets.payrails.io/img/logos/jazzcash/logo.svg)
</picture>

<picture noZoom>
  ![Boku logo](https://assets.payrails.io/img/logos/boku/logo-full-bleed.svg)
</picture>

Accept [JazzCash](https://docs.payrails.com/docs/integrations/payment-methods/jazzcash) payments from customers in Pakistan with Boku as the payment service provider (PSP). The customer selects JazzCash, confirms the payment on the Boku payment page and returns to your site.

## Supported workflows

<table>
  <thead>
    <tr><th>Workflow</th><th>Supported</th></tr>
  </thead>

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td></tr>
    <tr><td>Payrails API</td><td>✔</td></tr>
    <tr><td>[Delayed / Manual Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✖</td></tr>
    <tr><td>[Instant Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✔</td></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</td><td>✖</td></tr>
    <tr><td>[Refund / Reverse](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md)</td><td>✔</td></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</td><td>✖</td></tr>
    <tr><td>[Merchant Initiated Transaction (MIT)](https://docs.payrails.com/docs/resources/payments/authorization-flags.md)</td><td>✖</td></tr>
  </tbody>
</table>

## Before you begin

Complete these steps before you send your first JazzCash payment through Boku:

1. Set up a Boku integration in your workspace. Follow the [Boku integration setup guide](https://docs.payrails.com/docs/integrations/payment-providers/boku.md) if you don't have one yet.
2. Ask Boku to enable JazzCash on your Boku merchant account.
3. In the Payrails Portal, go to **Settings → Integrations**, open your Boku integration, select **JazzCash** under **Payment methods**, and save.
4. Add JazzCash as a [payment option](https://docs.payrails.com/docs/integrations/payment-methods/set-up-payment-methods.md) in your workflow.

## Request fields for Boku

Send these fields in the authorize request, in addition to the standard [authorize fields](https://docs.payrails.com/reference/authorizeaction.md). **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to the PSP when you include them.

| Field | Status | Description |
| - | - | - |
| `meta.customer.country.code` | Required | Send `PK`. Payrails uses it to pick the Boku endpoint for the country and sends it to Boku as the payment country. |
| `meta.order.description` | Required | Between one and 255 characters. Sent to Boku as the item description. |
| `meta.clientContext` | Required | Payrails reads `osType`, `userAgent` and `screenWidth` to choose the mobile or desktop Boku page. |
| `meta.clientContext.ipAddress` | Optional | Sent to Boku as the customer's IP address. |
| `meta.customer.reference` | Optional | Sent to Boku as your customer ID. |

## Authorize a JazzCash payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `jazzCash` as the `paymentMethodCode`. The response includes the redirect to the Boku payment page.

```json Authorize request theme={null}
{
  "amount": {
    "value": "1500.00",
    "currency": "PKR"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "jazzCash",
      "amount": {
        "value": "1500.00",
        "currency": "PKR"
      }
    }
  ],
  "meta": {
    "customer": {
      "reference": "customer-1234",
      "country": {
        "code": "PK"
      }
    },
    "order": {
      "description": "Example Store order"
    },
    "clientContext": {
      "ipAddress": "203.0.113.10",
      "osType": "android",
      "userAgent": "Mozilla/5.0 (Linux; Android 14) Mobile"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

After the customer confirms the payment, Boku returns them to your `success` or `error` URL. Confirm the result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status before you fulfill the order.

## How Boku handles JazzCash

* Boku notifies Payrails of the final result. Payrails also checks the payment status with Boku for up to 12 hours.
* To refund a JazzCash payment, send `meta.customer.country.code` on the refund request too. Payrails uses it to reach the Boku endpoint for the country.


## Related topics

- [JazzCash](https://docs.payrails.com/docs/integrations/payment-methods/jazzcash.md)
- [JazzCash via Thunes](https://docs.payrails.com/docs/integrations/payment-methods/jazzcash/thunes.md)
- [JazzCash via dLocal](https://docs.payrails.com/docs/integrations/payment-methods/jazzcash/dlocal.md)


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