Search…
Konbini
Konbini is a payment method that requires a user to complete an order by making a payment at a store using a receipt number or a bank.
Konbini is a set of small convenience stores from different brands like Seven Eleven, FamilyMart, Lawson, etc. These stores are very popular in Japan because they are nearly on every corner, so everybody can pay for everything very quickly without the need to have a credit card or other electronic-enabled payment options. Konbini is a delayed fulfillment payment method, meaning fulfillment occurs after authorization and settlement.
Additional setup required: If you are interested in using Konbini, contact your Account Manager. The Account Manager will send instructions to file an application form to obtain a client unique ship ID from a local payment gateway and will assist in completing the form in Japanese.

Configuring Konbini for DigitalRiver.js

Create a Konbini payment method for your app or website in four easy steps:

Step 1: Build a Kobini source request object

Build a Kobini Source Request object. A Konbini Source Request object requires the following fields.
Field
Value
type
konbini
sessionId
The payment session identifier.
owner
An Owner object. When the storeId is040 (Lawson), use double-byte Kanji without whitespace for the owner.firstName and owner.lastName to ensure successful payment source creation. You also need to ensure that the lastName precedes the firstName. Example:
{ "lastName": "山田", "firstName": "太郎", "email": } If you use a single-byte string, the payment source creation will fail.

Konbini Source Details object

Source Details object
1
{
2
"storeId": "010"
3
}
Copied!
Field
Required/Optional
Description
storeId
Required
The identifier of the store where the Customer chose to pay. If you use the DigitalRiver.js Konbini Element, Digital River automatically populates the value for you. If you construct the request yourself, this is a required field.

Step 2: Create a Konbini source using DigitalRiver.js

Use the DigitalRiver.js library to create and mount elements to the HTML container. If you are using the DigitalRiver.js element (option 1), the storeId value is automatically populated based on the customer's selected store. If you are not using the DigitalRiver.js element (option 2), you must construct the request to include the storeId parameter.

Option 1: Create a Konbini element using DigitalRiver.js functionality

The pattern for creating the Konbini element follows the same pattern as other elements and exposes the same customization and events. You can customize the look and feel through options and then place it on the page.
Example
1
var konbiniOptions = {
2
classes: {
3
base: "DRElement",
4
complete: "konbini-complete",
5
empty: "konbini-empty",
6
focus: "konbini-focus"
7
},
8
style: {
9
base: {
10
color: '#495057',
11
height: '35px',
12
fontSize: '1rem',
13
fontFamily: 'apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,sans-serif',
14
':hover': {
15
color: '#ccc',
16
},
17
'::placeholder': {
18
color: '#495057'
19
}
20
},
21
focus: {
22
':hover': {
23
color: '#495057',
24
},
25
},
26
empty: {
27
':hover': {
28
color: '#495057',
29
},
30
},
31
complete: {
32
':hover': {
33
color: '#495057',
34
},
35
}
36
}
37
};
38
39
//Create the element
40
var konbiniElement = digitalriver.createElement('konbini', konbiniOptions);
41
42
43
//Place it on the page
44
konbiniElement .mount('konbini-selector');
Copied!
DigitalRiver.js will create and render a select element which populates with the store logo and localized store name of the available stores where the customer can pay using this payment method.
The same events and structures appear in the Konbini element, and you should listen to the Change event to determine when the user has made a selection. When the change event response contains "complete": true, the shopper has selected a store.
Example
1
konbiniElement.on('blur', function (event) {
2
console.log('konbini blur', event);
3
});
4
5
konbiniElement.on('focus', function (event) {
6
console.log('konbini focus', event);
7
});
8
9
konbiniElement.on('ready', function (event) {
10
console.log('konbini ready', event);
11
});
12
13
konbiniElement.on('change', function (event) {
14
console.log('konbini change', event);
15
16
if (event.complete) {
17
//the user has selected a store, you may create the source
18
} else if(event.error) {
19
//do something with the error message
20
}
21
});
Copied!
To create a Konbini source, reference the created element and the supplemental data in your createSource request. DigitalRiver.js will retrieve and assemble the request on your behalf.
Example
1
var data = {
2
"type": "konbini",
3
"sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f",
4
"owner": {
5
"firstName": "John",
6
"lastName": "Doe",
7
"email": "[email protected]",
8
"phoneNumber": "000-000-0000",
9
"address": {
10
"line1": "6 Chome-10-1 Roppongi, Minato",
11
"state": "Tokyo",
12
"postalCode": "106-0032",
13
"country": "JP"
14
}
15
},
16
"konbini": {
17
"storeId": "010"
18
}
19
}
20
21
22
digitalriver.createSource(data).then(function(result) {
23
if (result.error) {
24
//handle errors
25
} else {
26
var source = result.source;
27
//send source to back end
28
sendToBackend(source);
29
}
30
});
Copied!

Option 2. Using DigitalRiver.js to create your own Konbini display

If you decide that you do not want to use the out of the box functionality provided with the Konbini element, you may also use the digitalriver.retrieveKonbiniStores() method which will allow you to build your own experience.

Retrieving available stores

DigitalRiver.js exposes a method that allows you to retrieve the available stores where Konbini is accepted. If stores are available, the response returns an array of objects. If stores are not available, the response returns an empty array.
Example
1
digitalriver.retrieveKonbiniStores().then(function(response) {
2
//use the returned values to create your own display
3
});
Copied!

Retrieved stores

Example
1
[{
2
"storeId": "010",
3
"storeName": "Seven Eleven",
4
"localizedStoreName": "セブン‐イレブン",
5
"storeLogoUrl": "https://ui1.img.digitalrivercontent.net/Storefront/images/Konbini/pmt_seven11.gif"
6
}, {
7
"storeId": "030",
8
"storeName": "Family Mart",
9
"localizedStoreName": "ファミリーマート",
10
"storeLogoUrl": "https://ui1.img.digitalrivercontent.net/Storefront/images/Konbini/pmt_familymart.gif"
11
}, {
12
"storeId": "060",
13
"storeName": "Lawson",
14
"localizedStoreName": "ローソン/ミニストップ",
15
"storeLogoUrl": "https://ui1.img.digitalrivercontent.net/Storefront/images/Konbini/pmt_lawson3.gif"
16
}, {
17
"storeId": "080",
18
"storeName": "Daily Store",
19
"localizedStoreName": "デイリーヤマザキ/ヤマザキデイリーストアー",
20
"storeLogoUrl": "https://ui1.img.digitalrivercontent.net/Storefront/images/Konbini/pmt_dailystore4.gif"
21
}]
Copied!
You can use the retrieved stores to build an experience suitable for your needs.
Example
1
<select>
2
<option value="010">セブン‐イレブン</option>
3
<option value="030">ファミリーマート</option>
4
<option value="060">ローソン/ミニストップ</option>
5
<option value="080">デイリーヤマザキ/ヤマザキデイリーストアー</option>
6
</select>
Copied!
Once you reached a point in your flow where the customer has selected a store, you can use the createSource function to assemble and pass the data to Digital River to create your payment.
Additional Fields Required: If you are creating a Konbini source without using the DigitalRiver.js Konbini element, you are required to pass an additional field storeId.
Key
Value Description
storeId
The identifier of the store where the customer will submit their payment.
Example
1
var sourceData = {
2
"type": "konbini",
3
"sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f",
4
"owner": {
5
"firstName": "John",
6
"lastName": "Doe",
7
"email": "[email protected]",
8
"phoneNumber": "000-000-0000",
9
"address": {
10
"line1": "6 Chome-10-1 Roppongi, Minato",
11
"state": "Tokyo",
12
"postalCode": "106-0032",
13
"country": "JP"
14
}
15
},
16
"konbini": {
17
"storeId": "010"
18
}
19
20
digitalriver.createSource(sourceData).then(function(result) {
21
if (result.error) {
22
//handle errors
23
} else {
24
var source = result.source;
25
//send source to back end
26
sendToBackend(source);
27
}
28
});
Copied!
Source example
1
{
2
"clientId": "gc",
3
"channelId": "drdod15",
4
"liveMode": false,
5
"id": "6900dc7e-1860-46bf-a353-0a6c82092ee9",
6
"sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f",
7
"clientSecret": "6900dc7e-1860-46bf-a353-0a6c82092ee9_4ddc9a11-fd91-46e4-b572-d5727ffb5e2a",
8
"type": "konbini",
9
"reusable": false,
10
"owner": {
11
"firstName": "John",
12
"lastName": "Doe",
13
"email": "[email protected]",
14
"phoneNumber": "000-000-0000",
15
"address": {
16
"line1": "6 Chome-10-1 Roppongi, Minato",
17
"state": "Tokyo",
18
"country": "JP",
19
"postalCode": "106-0032"
20
}
21
},
22
"amount": "217.72",
23
"currency": "JPY",
24
"state": "pending_funds",
25
"creationIp": "209.87.180.5",
26
"createdTime": "2020-01-08T17:37:04.562Z",
27
"updatedTime": "2020-01-08T17:37:04.64Z",
28
"expirationTime": "2020-02-07T17:37:04.562Z",
29
"flow": "receiver",
30
"konbini": {
31
"storeId": "010",
32
"receiptNumber": "7210246313380",
33
"printableInvoiceUrl": "http://payment.sej.co.jp:580/od/hi.asp?50100210246313380cf550a4fde12162",
34
"storeName": "Seven Eleven",
35
"localizedStoreName": "セブン‐イレブン",
36
"storeLogoUrl": "https://ui1.img.digitalrivercontent.net/Storefront/images/Konbini/pmt_seven11.gif"
37
}
38
}
Copied!

Step 3: Use the Konbini source

Once created, the Konbini source will be in a pending_funds state. Attach the source to a cart. Once attached, you may submit your order.
The following example shows how to attach a payment method to an order or cart.
POST /v1/shoppers/me/carts/active/apply-payment-method
1
{
2
"paymentMethod": {
3
"sourceId": "e7ba0595-059c-460c-bad8-2812123b9313"
4
}
5
}
Copied!

Step 4: After submitting the order

Once the order has been submitted, the source remains in a pending_funds state. At this point, direct your customer to go to the store they chose and pay the invoice. These details are reflected in the konbini block of the payment source.
Field
Description
receiptNumber
The customer's receipt number.
printableInvoiceUrl
A URL that links to a printable invoice that can be brought into the store while paying.
storeName
The name of the store where the customer will submit their payment.
localizedStoreName
The localized name of the store where the customer will submit their payment.
storeLogoUrl
The logo of the store where the customer will submit their payment.

Supported markets

For information on supported markets and currencies for Drop-in and DigitalRiver.js, go to:
Last modified 28d ago