Accept payments from Japanese convenience stores using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
To accept payments from Japanese convenience stores, you need to collect the shopper's full name, phone number, and email. When the shopper proceeds to pay, handle the transaction depending on which convenience store they selected.
- 7-Eleven: Redirect your shopper to a 7-Eleven page where they see the voucher.
- Other Japanese convenience stores: Present the voucher.
The shopper can then take note of the voucher reference or print the voucher, and pay in cash either at 7-Eleven or other convenience stores.
Requirements
| Requirement | Description |
|---|---|
| Integration type | Make sure that you have built an API-only integration. |
| Setup steps | Before you begin, add Japanese convenience stores and other Japanese convenience stores in your test Customer Area. |
Build your payment form for 7-Eleven and other Japanese convenience stores
To include 7-Eleven and other Japanese convenience stores in your payment form, you need to:
-
Show 7-Eleven and other Japanese convenience stores as an available payment method.
We provide a 7-Eleven and other Japanese convenience stores logo which you can use on your payment form. For more information, refer to Downloading logos.
-
After the shopper selects 7-Eleven or other Japanese convenience stores , collect the following details from the shopper:
Category Details to collect Shopper name The shopper's first name and last name. Email The shopper's email. Vouchers are sent to their email (except for 7-Eleven vouchers). Telephone number The shopper's telephone number.
You can also get the required shopper details from the /paymentMethods response, as explained in the API-only integration guide.
When you make a POST /paymentMethods request, specify:
- countryCode: JP
- amount.currency: JPY
- amount.value: The value of the payment, in minor units.
The required fields for 7-Eleven or other Japanese convenience stores are included in the object with the following type. You'll also use type to make a payment in the next step.
- econtext_seven_eleven: For 7-Eleven Japan.
- econtext_stores: For other Japanese convenience stores.
Make a payment
From your server, make a POST /payments request, specifying the following:
| Parameters | Required | Description |
|---|---|---|
paymentMethod |
 |
Object that contains the type, and the shopper's firstName, lastName, telephoneNumber, and shopperEmail. |
shopperLocale |
|
Language and country code to be used in the payment. For example, ja-JP. |
returnUrl |
|
The URL where the shopper will be redirected back to after they see the voucher. This URL can have a maximum of 1024 characters. |
Select a convenience store in the tabs below to see how to make a payment with a value of 1,000 JPY, and how to show the voucher to the shopper:
Present the payment result
Use the resultCode that you received in the /payments response to inform your shopper of the payment status.
The resultCode values you can receive for payments made through Japanese convenience stores are:
| resultCode | Action to take |
|---|---|
| RedirectShopper | After the shopper is redirected to 7-Eleven's page, reach out to the shopper and inform them that you are waiting for the payment to be completed. |
| PresentToShopper | After the voucher is presented to the shopper, inform the shopper that you are waiting for the payment to be completed. |
Wait for webhooks to know the outcome of the payment. The webhooks you can receive for Japanese convenience stores are:
| eventCode | success field | Description | Action to take |
|---|---|---|---|
| PENDING | true | The voucher reference is successfully created and the payment is pending. | Inform the shopper that you are waiting for the payment to be completed. |
| AUTHORISATION | false | The transaction failed. | Cancel the order and inform the shopper that the payment failed. |
| AUTHORISATION | true | The shopper successfully completed the payment. | Inform the shopper that the payment has been successful and proceed with the order. |
| OFFER_CLOSED | true | The shopper did not complete the payment before the offer expired. | Cancel the order and inform the shopper that the payment timed out. |
Test and go live
7-Eleven voucher payments can only be tested in the live environment. Contact our Support Team to set up 7-Eleven on the live environment for penny testing.
To test your integration, use the econtext simulator to complete voucher payments in Japanese convenience stores.
- Log in to the econtext Simulator using the following credentials:
- Username:
ectest - Password:
#Gwecn25
- Username:
- In the first box, provide 742001 as the shopID.
-
In the second box, provide the acquirer reference following the format below:
pspReference-262320-econtext_stores
For example, DZ4DPSHB4WD2WN82-262320-econtext_stores
Get the
pspReferencefrom the AUTHORISATION webhook.
- In the third box you select what you want to test.
- Leave as default for Convenience Stores
- Select "セブンイレブン" for 7-Eleven
- Select "Pay-easy(Bank Name)" for PayEasy ATM and PayEasy Online Banking
- Leave the fourth box 入金日時 (the time of payment) empty.
- Select 送信 (Submit).
- Wait for 15 minutes for the webhook.
Check the status of voucher payments in the test environment in your Customer Area:
- Vouchers that are pending or that have expired, are under Transactions > Offers.
- Vouchers that have been paid are under Transactions > Payments.
Before you can accept payments through Japanese convenience stores in live environment, you need to submit a request to add 7-Eleven or other Japanese convenience stores in your live Customer Area.