JazzCash via Boku

Accept 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

Before you begin

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

Set up a Boku integration in your workspace. Contact your Payrails account team if Boku isn’t listed in your Payrails Portal yet.
Ask Boku to enable JazzCash on your Boku merchant account.
In the Payrails Portal, go to Settings → Integrations, open your Boku integration, select JazzCash under Payment methods, and save.
Add JazzCash as a payment option in your workflow.

Request fields for Boku

Send these fields in the authorize request, in addition to the standard authorize fields. Payrails checks Required fields and returns an error when one is missing. Fields required by the PSP pass the Payrails checks but the PSP can decline the payment without 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`	Recommended	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 with jazzCash as the paymentMethodCode. The response includes the redirect to the Boku payment page.

Authorize request

{
  "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 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.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for Boku

Authorize a JazzCash payment

How Boku handles JazzCash

​Supported workflows

​Before you begin

​Request fields for Boku

​Authorize a JazzCash payment

​How Boku handles JazzCash

Supported workflows

Before you begin

Request fields for Boku

Authorize a JazzCash payment

How Boku handles JazzCash