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

# Konbini via Worldpay

> Set up Konbini payments through Worldpay in Payrails, including the billing phone and email Worldpay needs for the voucher.

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

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

Accept [Konbini](https://docs.payrails.com/docs/integrations/payment-methods/konbini) payments from customers in Japan with Worldpay as the payment service provider (PSP). The customer selects Konbini, gets a payment reference from Worldpay and pays at a convenience store.

## 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 Konbini payment through Worldpay:

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

## Request fields for Worldpay

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 |
| - | - | - |
| `amount.currency` | Required | Use `JPY`. |
| `meta.order.billingAddress.country.code` | Required | Must be `JP`. Sent to Worldpay as the payment instrument country. |
| `meta.order.billingAddress.lastName` | Required | Sent to Worldpay as the customer's last name. |
| `meta.order.billingAddress.email` | Required | Sent to Worldpay as the customer's email. |
| `meta.order.billingAddress.phone.number` | Required | Sent to Worldpay as the customer's phone number. |
| `meta.order.softDescriptor` | Required | Sent as the payment narrative, shown to the customer. |
| `meta.order.reference` | Optional | Sent to Worldpay as the order reference. |

## Authorize a Konbini payment

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

```json Authorize request theme={null}
{
  "amount": {
    "value": "2000",
    "currency": "JPY"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "konbini",
      "amount": {
        "value": "2000",
        "currency": "JPY"
      }
    }
  ],
  "meta": {
    "order": {
      "reference": "order-1234",
      "softDescriptor": "Example Store",
      "billingAddress": {
        "lastName": "Tanaka",
        "email": "yuki.tanaka@example.com",
        "phone": {
          "number": "0312345678"
        },
        "country": {
          "code": "JP"
        }
      }
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

The customer pays later at a convenience store. Confirm the result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status before you ship the order.

## How Worldpay handles Konbini

* Payrails reads the customer details from `meta.order.billingAddress`, not from `meta.customer`.
* When the customer leaves the Worldpay page, the payment stays pending. Payrails completes it from the Worldpay notification after the customer pays at the store.
* Each Konbini payment is a new customer-initiated payment.


## Related topics

- [Konbini](https://docs.payrails.com/docs/integrations/payment-methods/konbini.md)
- [Bancontact via Worldpay](https://docs.payrails.com/docs/integrations/payment-methods/bancontact/worldpay.md)
- [Alipay via Worldpay](https://docs.payrails.com/docs/integrations/payment-methods/alipay/worldpay.md)


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