Konbini

Understand the delayed Konbini payment reminder event.

The significance of the Konbini payload in the delayed_payment.reminder request lies in its role to facilitate the identification and reminder process for pending or expired payments made through the Konbini payment method. Specifically, the Konbini payload includes critical details such as:

• konbini: This main object contains the details specific to the Konbini payment method.

  • storeId: This is the identifier for the store where the payment is processed. In the example, the store ID is "010".

  • receiptNumber: Represents the receipt number for the transaction. The example receipt number is "7231852091080".

  • printableInvoiceUrl: This URL points to the printable version of the invoice for the transaction. It's represented as "{invoiceUrl}" in the example, indicating a placeholder for the actual URL.

  • storeName: The name of the store in a language that is easily understood internationally, in this case, "Seven Eleven".

  • localizedStoreName: This represents the store's name in the local language or script, which for this example is "セブン‐イレブン", the Japanese name for "Seven Eleven".

  • storeLogoUrl: The URL for the store's logo. Similar to the printable invoice URL, it's represented here as "{storeLogoUrl}", a placeholder for the actual URL.

This payload demonstrates how detailed and localized information regarding a Konbini payment is captured, from basic transaction details to specific identifiers useful for international understanding and local specificity.

Konbinie payload example

"konbini": {
  "storeId": "010",
  "receiptNumber": "7231852091080",
  "printableInvoiceUrl": "{invoiceUrl}",
  "storeName": "Seven Eleven",
  "localizedStoreName": "セブン‐イレブン",
  "storeLogoUrl": "{storeLogoUrl}"
}

A delayed_payment.reminder request for the Konbini payment method is a notification triggered to remind customers of pending payments for their orders. This request is specifically tailored for purchases made using the Konbini payment option, which allows customers to make payments at convenience stores across Japan.

Key components of the request:

The request contains detailed information about the pending transaction, including:

• Order Details: Includes order ID, placement date, and purchased product list.

• Customer Information: Details about the billing and shipping addresses of the customer.

• Purchase Summary: Provides a breakdown of the order total, including discounts, subtotals, taxes, and shipping costs.

• Konbini Payment Details: Specifics regarding the Konbini payment, such as the store ID, receipt number, and URLs for a printable invoice and the store's logo.

• Additional Metadata: Information like the shopper's ID, the site ID where the purchase was made, and the locale.

This request helps ensure that customers know their outstanding payments, reducing the chances of overdue payments and enhancing the overall transaction process.

When a delayed payment reminder is triggered for a Konbini payment method, the webhook payload sent is structured as follows:

Webhook payload

{
  "type": "delayed_payment.reminder",
  "data": {
    "object": {
      "orderId": "1087747290080",
      "placedOnDate": "2022-05-31T15:58:16.963Z",
      "products": [
        {
          "id": "308180500",
          "displayName": "BP Digital",
          "sku": "BP123"
        }
      ],
      "billToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "companyName": "DR",
        "line1": "6-chome-22 Kagurazaka",
        "line2": "Shinjuku City",
        "city": "Tokyo-to",
        "postalCode": "162-0825",
        "state": "Tokyo",
        "country": "JP",
        "countryName": "Japan",
        "phoneNumber": "555-234-56789",
        "emailAddress": "[e-mail]",
        "countyName": "Eastwood"
      },
      "shipToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "companyName": "DR",
        "line1": "6-chome-22 Kagurazaka",
        "line2": "Shinjuku City",
        "city": "Tokyo-to",
        "postalCode": "162-0825",
        "state": "Tokyo",
        "country": "JP",
        "countryName": "Japan",
        "phoneNumber": "555-234-56789",
        "emailAddress": "[e-mail]",
        "countyName": "Eastwood"
      },
      "shopperId": "506960950289",
      "locale": "ja_JP",
      "siteId": "paytest2",
      "orderTotal": 281,
      "currency": "JPY",
      "orderDiscount": 0,
      "subTotal": 256,
      "tax": 25,
      "shippingTotal": 0,
      "businessEntity": "Digital River Ireland Ltd.",
      "expirationDate": "2022-06-30T15:58:01.000Z",
      "paymentSourceType": "konbini",
      "konbini": {
        "storeId": "010",
        "receiptNumber": "7232251882965",
        "printableInvoiceUrl": "{printableInvoiceUrl}",
        "storeName": "Seven Eleven",
        "localizedStoreName": "セブン‐イレブン",
        "storeLogoUrl": "{storeLogoUrl}"
      }
    }
  },
  "clientIds": {
    "site_id": "paytest2"
  },
  "searchableData": {
    "orderId": "1087747290080"
  }
}

This payload provides detailed information regarding the order, the customer's billing and shipping addresses, the overall purchase summary, and the specific Konbini payment data.