Konbini via Worldpay

Accept 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

Before you begin

Complete these steps before you send your first Konbini payment through Worldpay:

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

Request fields for Worldpay

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

Authorize a Konbini payment

Call authorize a payment with konbini as the paymentMethodCode. The response includes the redirect to the Worldpay payment reference page.

Authorize request

{
  "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 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.
Refunds aren’t available for Konbini payments through Worldpay.
Saving the instrument and merchant-initiated transactions (MIT) aren’t available.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for Worldpay

Authorize a Konbini payment

How Worldpay handles Konbini

​Supported workflows

​Before you begin

​Request fields for Worldpay

​Authorize a Konbini payment

​How Worldpay handles Konbini

Supported workflows

Before you begin

Request fields for Worldpay

Authorize a Konbini payment

How Worldpay handles Konbini