Get started

As a "Platform Merchant (Platform Business)" merchant, you'll need to register a "Seller Merchant" account for each seller/user via our APIs to adopt Platform Use Case.

To register a Seller Merchant account, you should check the following prerequisites:

1. We only accept Japanese entities (both Corporation and Sole Proprietorship) to register a Seller Merchant account.
2. Seller Merchant must have a Japanese Bank Account to receive payouts in JPY from KOMOJU.

1. Create a Seller Merchant account

Request Merchant: Create API to create a Seller Merchant account with platform_role set to seller.

curl -X POST https://komoju.com/api/v1/merchants \
-u <platform merchant secret key>: \
-d name='New Seller Merchant 1' \
-d platform_role="seller"

2. Query the seller merchant’s live_application for required fields

Request Liveapplication: Show API with seller merchant's uuid you received from the previous step.

curl -X GET https://komoju.com/api/v1/live_application/{id}?locale=en \
-u platform_merchant_secret_key:

Response example

{
    "merchant_id": "5td723eoi9txn8sj545ww2mv1",
    "status": "incomplete",
    "payments_enabled": false,
    "payouts_enabled": false,
    "required_fields": [
        {
            "field": "company_information.company_phone",
            "field_name": "Company Phone",
            "field_type": "phone_number",
            "field_properties": {
                "minLength": 1,
                "pattern": "^([() \\-_+]*[0-9]){10}[() \\-_+0-9]*$"
            }
        },
				...
    ],
    "newly_required_fields": [],
    "errored_fields": []
}

Within required_fieldsarray, you'll able to see what kinds of information are required to proceed Seller Merchant registration. Following is the breakdown of each field property.

"field": "company_information.company_phone",
"field_name": "Company Phone",
"field_type": "phone_number",
"field_properties": {
  "minLength": 1,
  "pattern": "^([() \\-_+]*[0-9]){10}[() \\-_+0-9]*$"
}

• field is the property name that should be used when submitting information for that field.
• field_name is the localized name for the field that should be shown to the user.
• field_type is the type of component that should be displayed.
• field_properties includes information about restrictions on the value of the field.

(1) field_types

Different field_types are meant to help direct the types of form components shown to the user to help differentiate and format expected values.

(2) field_properties

field_properties provide information on the properties of the field.

3. Uploading files for merchants

Some field_types (single_file_upload, file_upload) require that files be uploaded via our merchant file API first, then the UUID(s) submitted as the value for the live_application.

Request File: Create API to upload the files for Seller Merchant onboarding.

We only accept jpg, png, and pdf formats. Besides, each file size should be smaller than 10MB.

curl -X POST https://komoju.com/api/v1/merchants/{id}/files \
  -u platform_merchant_secret_key: \
  -F "paper=/path/to/file"

The response will look like:

{
    "id": "6ssx1zxovw3fgmdsdd1zuzr5u",
    "resource": "file",
    "filename": "blank.png",
    "size": 998,
    "mime_type": "image/png",
    "created_at": "2023-01-10T12:16:00.819+09:00",
    "updated_at": "2023-01-10T12:16:01.085+09:00"
}

4. Submitting fields

Based on the required_fields received in step 2, information can now be submitted for the Seller Merchant via Live Application: Update API.

Here’s an example of submitting company_information.company_name

curl -X PATCH https://komoju.com/api/v1/live_application/{id} \
  -u platform_merchant_secret_key: \
  -d "company_information.company_name=My Company"

If successful, the response will include any additional required fields based on what was just submitted. In the case of company_name, newly_required_fields will be blank as no additional fields rely on the value company_name.

An example of newly_required_fields

If you submit sole_proprietor as the company_information.corporation_type

curl -X PATCH https://komoju.com/api/v1/live_application/{id} \
  -u platform_merchant_secret_key: \
  -d "company_information.corporation_type=sole_proprietor"

In the response, see that newly_required_fields now includes sole_proprietor_proofs.

"newly_required_fields": [
      {
          "field": "company_information.sole_proprietor_proofs",
          "field_name": "Sole proprietor proofs",
          "field_type": "file_upload",
          "field_properties": {}
      }
  ]

newly_required_fields are only shown upon update and return new fields that should be added to the form as a result of the last update to live_application.

5. Completing the live_application

Since the required information can be different based on your user's conditions (eg: corporation, sole proprietorship...etc), our API responses will guide you through the entire onboarding flow step-by-step by providing further fields under required_fields and newly_required_fields arrays.

The live_application fields should continue to be filled out until required_fields, newly_required_fields, and errored_fields are all empty. At that point, the application is considered complete.

Overall, there are mainly five categories of the required information, you can check the comprehensive items under each category.

(1) KOMOJU service agreements acceptance

To provide Platform Model services to your sellers, KOMOJU must establish a direct contractual relationship with them. It requires each Seller Merchant to consent to KOMOJU Merchant Services Terms of Use and Privacy Policy. It’s your responsibility to make sure your sellers consent to the above agreements when registering a Seller Merchant account on KOMOJU via your interfaces.

Referencing KOMOJU's service agreement

As a minimum requirement, you must present your sellers with the links to the correct terms and they must expressly consent to those terms when starting the onboarding process. Below are the recommended steps:

1. Requesting Liveapplication: Show API to retrieve the URLs of KOMOJU Merchant Services Terms of Use and Privacy Policy from service_agreement.agreed_to_tosfield.
2. Presenting those terms to your sellers on your platform when they start to opt in the service.
3. Passing your seller's consent back to KOMOJU via service_agreement.agreed_to_tosfield in Live Application: Update API.

Here's an example of how you can present our terms to your users via your interface.

(2) Company information

Below is the comprehensive list of required company-related information.

(3) Personal Information

Below is the comprehensive list of required Representative Director and Applicant information.

In the case of a corporation:

• It's fine if the Representative Director and Applicant are the same person.
• The Applicant must be the person who has the authority to make decisions on corporate contracts.

In the case of a sole proprietorship:

• Since the Representative Director and the Applicant should be the same person, you only need to fill out representative_directorrelated fields.

(4) Site Information

Below is the comprehensive list of required site-related information.

• The store address should match the one listed on the website that hosts the Specified Commercial Transactions Law URL.

(5) Bank Account information

Below is the comprehensive list of required bank account information.

• If you are a corporation, you can only register an account in the name of the corporation you applied for. If you are a sole proprietor, you can only register an account in the name of the representative or business name.
• Please read this guide first to ensure you provide the bank account information correctly.

❗️

Possible payout delay

If the account holder name is incorrect, there may be a delay in receiving the payout. Please make sure to accurately enter the half-width kana name as it appears in your bank passbook.

6. Checking submitted information

Querying the Liveapplication: Show again to review all submitted information populated under submitted_fields array with any previous information provided.

7. Setup the webhook

You can set up Webhook to subscribe to the events so that you'll receive a notification immediately after the review status of a Seller Merchant's application has any update.

• Learn more about Webhook events for Platform Model here

8. Specify Owned Payment Methods of Seller Merchant

📘

Your Common Payment Methods specifies the available Owned Payment Methods for all your Seller Merchants

Please be mindful that only payment methods in Common Payment Methods are available for Owned Payment Methods of Seller Merchant. You can refer to here for more details.

In this stage, you should apply for the payment methods that your Seller Merchant wants to adopt on behalf of it. First, you can check all applicable payment methods in submitted_payment_methods and unsubmitted_payment_methodsby requesting Live Application: Payment Methods API:

curl -X GET https://komoju.com/api/v1/live_application/{id}/payment_methods \
  -u platform_merchant_secret_key: \

• submitted_payment_methodsshows the applicable payment methods Seller Merchant has applied for.
• unsubmitted_payment_methods shows the available payment methods Seller Merchant has not applied for yet.

Then, you should request Live Application: Update Payment Method API to apply for a specific payment method for your seller.

Below are the details when applying for each payment method:

(1) VISA/MasterCard

Payment methods: visa_mastercard_credit_card

Available for corporation andsole_proprietor

Note: 3D Secure 2.0 will be used for all credit card payments except some integration types. For more details, please see this article (Japanese).

To enable credit card payments on your user's account, we need to acquire the following information about your user's business.

1st stage questionnaire:

2nd stage questionnaire: Reporting on Security Measures

KOMOJU has been requested by the Ministry of Economy, Trade and Industry (METI), the Japan Credit Association (JCA), and other organizations to request that EC merchants planning to introduce new credit card payment systems declare the status of their security measures based on the "Security Checklist" developed by the Credit Transaction Security Measures Council.
The "Security Checklist" is a list of basic security measures that the Credit Card Transaction Security Council has compiled as part of the security measures that merchants should implement in order to build and operate EC sites, and covers the basic security measures set forth in the "Credit Card Security Guidelines (Version 4.0)" published by METI. We request that merchants newly applying for credit card settlement services declare the security measures listed on the next page based on this checklist and agree to implement and maintain the security measures. We have received guidance that if you do not agree to follow the above guidelines, you should not enter into a contract with us. Thank you for your cooperation.

If you are a merchant who plans to introduce KOMOJU credit card payment systems, please indicate your implementation status of the following security measures. If the system has not yet been established, please answer on the premise that the items for each key measure will be satisfied upon completion of the establishment of the system. Also, please answer on the premise that the measures will be maintained not only at the time of signing a new franchise agreement, but also continuously after the agreement is signed.
In principle, all items must be checked for a contract to be concluded. However, since the status of installation of each security measure is dependent on the system environment of your company, please check with your internal system staff or contracted system developer before checking the status of each security measure. If your system is outsourced, please confirm the status of the outsourced system before responding to our inquiry.

Topic 1: Measures against inadequate access restrictions on the administrator's screen and administrator ID/PW mismanagement

Topic 2: Measures against inadequate settings due to exposure of data directories

Topic 3: Periodic vulnerability assessments or penetration tests, and measures to address web application vulnerabilities.

Topic 4: Installation and operation of anti-virus software as measure against malware

Topic 5: Countermeasures against malicious validation and credit masters

Topic 6: Countermeasures against unauthorized login

Topic 7: If you answered true to the question in Topic 6, please answer the following questions regarding the anti-fraud login measures implemented in your system. (According to the rules of the Japan Credit Association, one or more of the measures listed below must be implemented in each of the following situations: member registration, member login authentication, and user attribute information change.)

(1) Question: Please check if you have implemented effective measures to prevent fraudulent use at the time of member registration (credit card number registration).

• Option: Can select one or multiple of the following

(2) Question: Please check if you have implemented effective countermeasures against fraudulent logins during login authentication after member registration.

• Option: Can select one or multiple of the following

(3) Question: Please check if you have implemented effective measures to prevent fraudulent use when changing member attributes (name, address, email address, etc.) after login.

• Option: Can select one or multiple of the following

(2) JCB/AMEX/Diners (Japan)

Payment methods: jcb_amex_diners_credit_card

Available for corporation andsole_proprietor

Note: 3D Secure 2.0 will be used for all credit card payments except some integration types. For more details, please see this article (Japanese).

To enable credit card payments on your user's account, we need to acquire the following information about your user's business.

1st stage questionnaire:

2nd stage questionnaire: Reporting on Security Measures

KOMOJU has been requested by the Ministry of Economy, Trade and Industry (METI), the Japan Credit Association (JCA), and other organizations to request that EC merchants planning to introduce new credit card payment systems declare the status of their security measures based on the "Security Checklist" developed by the Credit Transaction Security Measures Council.
The "Security Checklist" is a list of basic security measures that the Credit Card Transaction Security Council has compiled as part of the security measures that merchants should implement in order to build and operate EC sites, and covers the basic security measures set forth in the "Credit Card Security Guidelines (Version 4.0)" published by METI. We request that merchants newly applying for credit card settlement services declare the security measures listed on the next page based on this checklist and agree to implement and maintain the security measures. We have received guidance that if you do not agree to follow the above guidelines, you should not enter into a contract with us. Thank you for your cooperation.

If you are a merchant who plans to introduce KOMOJU credit card payment systems, please indicate your implementation status of the following security measures. If the system has not yet been established, please answer on the premise that the items for each key measure will be satisfied upon completion of the establishment of the system. Also, please answer on the premise that the measures will be maintained not only at the time of signing a new franchise agreement, but also continuously after the agreement is signed.
In principle, all items must be checked for a contract to be concluded. However, since the status of installation of each security measure is dependent on the system environment of your company, please check with your internal system staff or contracted system developer before checking the status of each security measure. If your system is outsourced, please confirm the status of the outsourced system before responding to our inquiry.

Topic 1: Measures against inadequate access restrictions on the administrator's screen and administrator ID/PW mismanagement

Topic 2: Measures against inadequate settings due to exposure of data directories

Topic 3: Periodic vulnerability assessments or penetration tests, and measures to address web application vulnerabilities.

Topic 4: Installation and operation of anti-virus software as measure against malware

Topic 5: Countermeasures against malicious validation and credit masters

Topic 6: Countermeasures against unauthorized login

Topic 7: If you answered true to the question in Topic 6, please answer the following questions regarding the anti-fraud login measures implemented in your system. (According to the rules of the Japan Credit Association, one or more of the measures listed below must be implemented in each of the following situations: member registration, member login authentication, and user attribute information change.)

(1) Question: Please check if you have implemented effective measures to prevent fraudulent use at the time of member registration (credit card number registration).

• Option: Can select one or multiple of the following

(2) Question: Please check if you have implemented effective countermeasures against fraudulent logins during login authentication after member registration.

• Option: Can select one or multiple of the following

(3) Question: Please check if you have implemented effective measures to prevent fraudulent use when changing member attributes (name, address, email address, etc.) after login.

• Option: Can select one or multiple of the following

(3) PayPay

Payment methods: paypay

Available for corporation andsole_proprietor

The following information is required when applying for PayPay:

(4) LINE Pay

Payment methods: linepay

Available for corporation andsole_proprietor

The following information is required when applying for LINEPay:

(5) Merpay

Payment methods: merpay

Available for corporation only.

The following information is required when applying for Merpay:

(6) Bank Transfer

Payment methods: bank_transfer

Available for corporation andsole_proprietor

No additional information is required when applying for Bank Transfer.

(7) Pay-easy

Payment methods: pay_easy

Available for corporation andsole_proprietor

No additional information is required when applying for Pay-easy.

(8) Konbini

Payment methods: convenience_store

Available for corporation andsole_proprietor

The following information is required when applying for Merpay:

(9) 7-Eleven

Payment methods: seven_eleven

Available for corporation only

For 7-Eleven payment, there is a screening process to ensure that the site and operation are in line with the regulations set by 7-Eleven. To enable 7-Eleven payments, your site must meet all the following requirements.

The expected review time is approximately one to two months after applying.

During the review process, both 7-Eleven and the KOMOJU Support Team may contact your user individually for confirmation or suggestions.

The following information is required when applying for 7-Eleven: