Configuring Konbini
Learn how to configure Konbini for DigitalRiver.js with Elements.
Last updated
Learn how to configure Konbini for DigitalRiver.js with Elements.
Last updated
If you're using , you can create a payment method for your app or website in four easy steps:
Build a Konbini source request object. A Konbini source request object requires the following fields.
type
konbini
sessionId
The payment session identifier.
owner
konbini
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.
DigitalRiver.js will create and render a select element that populates with the store logo and localized store name of the available stores where the customer can pay using this payment method.
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.
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.
You can use the retrieved stores to build an experience suitable for your needs.
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.
storeId
The identifier of the store where the customer will submit their payment.
The following example shows how to attach a payment method to checkout.
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.
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.
An . When the storeId
is 040
(Lawson), use double-byte Kanji without for the owner.lastName
and owner.firstName
to ensure successful payment source creation.
Example:
{
"lastName": "山田",
"firstName": "太郎"
}
If you use a single-byte string, the payment source creation will fail.
The address
object must contain and data that .
A .
Use the DigitalRiver.js library to create and mount elements to the HTML container. If you are using the DigitalRiver.js element (), the storeId
value is automatically populated based on the customer's selected store. If you are not using the DigitalRiver.js element (), you must construct the request to include the storeId
parameter.
The pattern for creating the Konbini element follows the same pattern as other elements and exposes the same . You can customize the look and feel through and then place it on the page.
The same appear in the Konbini element, and you should listen to the to determine when the user has made a selection. When the change event response contains "complete": true
, the shopper has selected a store.
To create a Konbini source, reference the created element and the supplemental data in your request. DigitalRiver.js will retrieve and assemble the request on your behalf.
The address
object must contain and data that .
Once created, the Konbini source will be in a pending_funds
state. Attach the . Once attached, you may submit your order.