Managing Accounts

The KOMOJU Platform API provides a set of API for the platform merchant to programmatically manage the accounts of its sub-merchants. Each sub-merchant has one corresponding KOMOJU account.

Please note that one account contains two merchant records, a test merchant and a live merchant. The test merchant is immediately usable upon creation, and it can be used to test the payment workflow. The live merchant must go through the Onboarding Process before conducting real-money transactions.

The Accounts API operates at the user level, and thus requires User-level Authentication.

Accounts

Creating an Account for a Sub-merchant

When onboarding a new sub-merchant to KOMOJU, please use the POST /api/v1/accounts API to create an account.

Accepting the Service Agreement for an Account

Before an account can be used, the Service Agreement must be agreed to by the owner of that account. The platform merchant can use the POST /api/v1/accounts/:id/accept_service_agreement API to do this programmatically for its sub-merchants.

We allow the API caller to specify both "accepted_service_agreement_at" and "accepted_service_agreement_ip". These params correspond to the timestamp and IP address of the sub-merchant that accepted the service agreement.

Please understand that KOMOJU is a bystander in this process. After the platform merchant's sub-merchants accept the KOMOJU service agreement, the platform merchant then relays each sub-merchant's timestamp and IP to KOMOJU. It is the API caller's legal responsibility to ensure that each sub-merchant has reviewed either The Payment Processing Service Terms of Use or 代金収納代行サービス利用規約 documents.

Retrieving the Account Information of a Sub-merchant

You can retrieve the account information of a sub-merchant via the GET /api/v1/accounts/:id API at any time.

Updating the Account Information of a Sub-merchant

You can update the account information of a sub-merchant via the PATCH /api/v1/accounts/:id API after it has been created.