Konbini, Pay-easy, and Online Banking

Enable your customers to pay from a wide variety of Konbinis (convenience stores), ATMs, banks, and post offices in Japan with our Konbini, Pay-easy, and Online Banking payment method.

This method currently supports payments at the following konbinis: Lawson, Mini Stop, Seico Mart, and Family Mart.

Individual business owners cannot use Konbini, Pay-easy, and Online Banking payments.

How to enable

  • Supported Countries: Japan
  • Minimum API version: 2017-11-02

To enable Konbini, Pay-easy, and Online Banking, send an email requesting this feature to support@omise.co. You will need to review and accept new terms and conditions.

Payment flow

At checkout, the customer selects Konbini, Pay-easy, and Online Banking as their payment method and enters their name, email address, and telephone number. They are then given a link with instructions for completing the payment.

Convenience Store payment flow

The customer will need to pay at a konbini, payment kiosk, or cashier using the link provided.

Convenience Store payment flow

Upon payment, Omise will send a webhook event (if enabled) indicating that the charge is complete.

Implementation

To create a charge using Konbini, Pay-easy, and Online Banking, make the following API requests.

  1. Create a new payment source (type: econtext) using Omise.js or one of the mobile SDKs (iOS and Android)
  2. Create a new charge using the identifier of the source created in Step 1.
  3. After receiving the charge completion webhook event, retrieve the charge to verify its status (optional, but recommended).

Use your public key to create the Konbini, Pay-easy, and Online Banking source on the client (a customer's browser or mobile phone). Use your secret key to create the Konbini, Pay-easy, and Online Banking charge on the server.

If both the creation and charge of a source must happen server-side, you can create and charge the source in a single API request using your secret key.

Creating a source

Konbini, Pay-easy, and Online Banking payments are implemented as sources. When the customer confirms that they wish to pay with this payment method, create a new source specifying the following parameters.

Name Type Attribute
amount integer (required) An integer between 200 and 49999 JPY.
currency string (required) JPY
type string (required) econtext
name string (required) A maximum of 10 characters of alphanumeric, hiragana, katakana, or kanji. This may appear on konbini kiosks or receipts depending on the payment method
email string (required) A minimum of 6 and maximum of 50 characters in length
phone_number integer (required) A minimum of 10 and maximum of 11 digits in length

The following examples demonstrate the creation of a new Konbini, Pay-easy, and Online Banking source for ¥300. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with your test public key found on the dashboard: https://dashboard.omise.co/test/keys

Using Omise.js, the type parameter is supplied as the first argument to the createSource method.

Omise.setPublicKey(omise_public_key);

Omise.createSource('econtext', {
  "amount": 300,
  "currency": "JPY",
  "name": "ヤマダタロウ",
  "email": "taro.yamada@example.com",
  "phone_number": "01234567891"
}, function(statusCode, response) {
  console.log(response)
});

For testing, you can create the same request using curl.

curl https://api.omise.co/sources \
  -u $OMISE_PUBLIC_KEY: \
  -d "amount=300" \
  -d "currency=JPY" \
  -d "type=econtext" \
  -d "name=ヤマダタロウ" \
  -d "email=taro.yamada@example.com" \
  -d "phone_number=01234567891"
{
  "object": "source",
  "id": "src_test_5il9fb4hynkoh8yjlug",
  "livemode": false,
  "location": "/sources/src_test_5il9fb4hynkoh8yjlug",
  "created_at": "2020-01-17T09:07:41Z",
  "type": "econtext",
  "flow": "offline",
  "amount": 300,
  "currency": "JPY",
  "mobile_number": "01234567891",
  "phone_number": "01234567891",
  "references": null,
  "name": "ヤマダタロウ",
  "email": "taro.yamada@example.com",
  "barcode": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "installment_term": null,
  "zero_interest_installments": null,
  "scannable_code": null
}

The id attribute is the source identifier (begins with src).

Creating a charge

Create a charge specifying the parameters source, amount, and currency.

  • source specifies the source identifier.
  • amount and currency must match amount and currency of the source.

The following example demonstrates how to create a new charge using curl. Replace $OMISE_SECRET_KEY with your test secret key found on the dashboard: https://dashboard.omise.co/test/keys. Replace $SOURCE_ID with the id of the source.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=300" \
  -d "currency=JPY" \
  -d "source=$SOURCE_ID"
{
  "object": "charge",
  "id": "chrg_test_5il9fb7jybw6rwf3wfz",
  "livemode": false,
  "location": "/charges/chrg_test_5il9fb7jybw6rwf3wfz",
  "created_at": "2020-01-17T09:07:41Z",
  "amount": 300,
  "currency": "JPY",
  "funding_amount": 300,
  "funding_currency": "JPY",
  "fee": 152,
  "fee_vat": 15,
  "interest": 0,
  "interest_vat": 0,
  "net": 133,
  "description": null,
  "metadata": {},
  "status": "pending",
  "capture": true,
  "authorized": false,
  "schedule": null,
  "reversed": false,
  "reversed_at": null,
  "expires_at": "2020-02-16T09:07:41Z",
  "expired": false,
  "expired_at": null,
  "voided": false,
  "paid": false,
  "paid_at": null,
  "transaction": null,
  "refunded_amount": 0,
  "refunds": {
    "object": "list",
    "from": "1970-01-01T00:00:00Z",
    "to": "2020-01-17T09:07:41Z",
    "offset": 0,
    "limit": 20,
    "total": 0,
    "order": "chronological",
    "location": "/charges/chrg_test_5il9fb7jybw6rwf3wfz/refunds",
    "data": []
  },
  "link": null,
  "return_uri": null,
  "failure_code": null,
  "failure_message": null,
  "card": null,
  "customer": null,
  "ip": null,
  "dispute": null,
  "source": {
    "object": "source",
    "id": "src_test_5il9faz0kmd9nsqtj9g",
    "livemode": false,
    "location": "/sources/src_test_5il9faz0kmd9nsqtj9g",
    "created_at": "2020-01-17T09:07:40Z",
    "type": "econtext",
    "flow": "offline",
    "amount": 300,
    "currency": "JPY",
    "mobile_number": "01234567891",
    "phone_number": "01234567891",
    "references": {
      "expires_at": "2020-02-16T09:07:41Z",
      "device_id": null,
      "customer_amount": null,
      "customer_currency": null,
      "customer_exchange_rate": null,
      "omise_tax_id": null,
      "reference_number_1": null,
      "reference_number_2": null,
      "barcode": null,
      "payment_code": "217799",
      "va_code": null
    },
    "name": "ヤマダタロウ",
    "email": "taro.yamada@example.com",
    "barcode": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "installment_term": null,
    "zero_interest_installments": null,
    "scannable_code": null
  },
  "platform_fee": {
    "percentage": null,
    "fixed": null,
    "amount": null
  },
  "disputable": false,
  "capturable": false,
  "reversible": false,
  "refundable": false,
  "zero_interest_installments": false,
  "authorize_uri": "https://pay.omise.co/offlines/econtext/instructions/oflp_test_5il9fb7pep1eatdoqyg"
}

Setting the charge to expire

This payment method also allows an optional expires_at parameter.
By default, the charge will expire in one day. If another expiration date is preferred, specify the expires_at parameter and set its value as an ISO 8601 date in the UTC timezone. Since Japan's timezone is UTC+9, to set a charge to expire midnight on July 1st, 2020 Japan time, the value would be: 2020-07-01T15:00:00Z.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "description=Charge for order 3947" \
  -d "amount=300" \
  -d "currency=JPY" \
  -d "source=$SOURCE_ID" \
  -d "expires_at=2020-07-01T15:00:00Z"

Creating a source and charge

Alternatively, you can create and charge a source in a single API request.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=300" \
  -d "currency=JPY" \
  -d "source[type]=econtext" \
  -d "source[name]=ヤマダタロウ" \
  -d "source[email]=taro.yamada@example.com" \
  -d "source[phone_number]=01234567891"

Completing the charge

At this point, you have created a new charge with its status set to pending. Other possible values for charge status are successful, failed, and expired.

The following sections detail how to authorize a charge, receive its completion webhook event, and update its status.

Authorizing the charge

Present the customer with location specified in authorize_uri within the charge object. To authorize the charge, the customer follows the payment instructions at that location.

You can simulate this authorization phase in test mode by visiting the authorize_uri to manually mark the charge as Successful or Failed.

Receiving the charge completion event

The best way for you to be notified of the completion of a charge is using webhook events. Set up a location on your server to receive webhook events, and add this location as a webhook endpoint on the dashboard.

Once a charge is completed, a POST request will be sent to this endpoint with the charge response embedded.

The key attribute for the event object contains charge.complete and the data attribute contains the charge object. See Events API for event object structure.

Checking the charge status

After receiving this event, retrieve the charge using its id and confirm that its status matches the status of the charge contained in the event.

If the value of status has updated to successful, you got paid. If the value of status has updated to failed, check the failure_code and failure_message in the charge object for an explanation.

Possible failure codes are listed below.

Failure Code Description
failed_processing General payment processing failure.
payment_cancelled Payment cancelled by payer.
timeout Payer did not take action before charge expiration.

Voids and refunds

Konbini, Pay-easy, and Online Banking charges cannot be voided or refunded through Omise.

Limits

  • Minimum: 200 (¥200)
  • Maximum: 49999 (¥49,999)

Next steps