Boku

Who should use this guideThis guide is intended for merchants who:

Use Payrails as a payment orchestrator
Use Boku for mobile wallets such as Easypaisa, JazzCash and Egypt mobile wallets, or for UPI, NIBSS, Paga Wallet or direct carrier billing
Have an active Boku merchant account

Create a Boku integration in Payrails

Log in to the Payrails portal.
Go to Settings → Integrations.
Select Add instance to create a new integration configuration.
Select the workspaces where this integration should be available.

About workspacesWorkspaces 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.

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.

A screenshot showing Boku selected as the provider.

Step 3: Configure your Boku integration

What you’ll need from BokuBefore you begin, make sure you have your Boku merchant ID, key ID and API key. Boku provides them when it sets up your account.

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.

A screenshot showing the integration instance name field.

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.

A screenshot showing the Boku account details fields.

Credentials

In Payrails

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

A screenshot showing the Boku credential fields.

Payment methods

In Payrails

Select the methods you want to accept through Boku.

A screenshot showing the Boku payment method selection.

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

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

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

→ Continue to: Test a payment

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Create a Boku integration in Payrails

Step 1: Choose the integration type

Step 2: Choose the provider