As a Platform Merchant, you'll have the following capabilities to manage your sub-merchants.

View the list of sub-merchants

(1) Method 1: Request Merchant: List API

In the API response, you'll be able to check the status of the following aspects

Application status: This is KOMOJU's current review status of the sub-merchant's application. It can be accepted, declined, or pending.
Payments_enabled: This represents if the Seller Merchant can start processing payments. For Payout Merchant, it always be null since it is never a processing merchant.
Payouts_enabled: This represents whether the sub-merchant can receive payouts from KOMOJU or not. Both Seller Merchant and Payout Merchant should have a status.

(2) Method 2: Access KOMOJU dashboard

You can also access this via the dashboard. The path: Side navigation bar -> select "Sub-merchants".

View the detail of a sub-merchant

(1) Method 1: Request Merchant: Show API

You'll be able to access detailed information of the sub-merchant. Below is the explanation of some key attributes (not all):

Field	Type	Description
live	boolean	The live status of the sub-merchant.
platform_role	string	The role of the sub-merchant, either Seller Merchant or Payout Merchant.
application_status	string	The review status of the sub-merchant's application
payments_enabled	boolean	This represents if the sub-merchant can process payments
payouts_enabled	boolean	This represents whether the sub-merchant can receive payouts from KOMOJU or not.
send_payment_instruction_email	boolean	Email with payment instructions will be sent to the customer's email address. (reference)
send_payment_receipt_email	boolean	After the customer completes the payment, an email with a receipt will be sent to the customer's email address. (reference)
send_payment_reminder_email	boolean	1 day before the payment's expiration date, a reminder email will be sent to the customer's email address. (reference)
send_payment_refund_email	boolean	When the full refund is completed, an email will be sent to the customer email address.(reference) (*The e-mail will be sent only when the full refund is completed. Partial refunds are not supported.)
expiry_settings	array	The expiry days of Konbini payment and Bank Transfer payments. - Reference of Konbini payment expiry date - Reference of Bank Transfer payment expiry date
active_payment_methods	array	The payment methods that Seller Merchant supports the customers to pay

(2) Method 2: Access KOMOJU dashboard

You can also access the dashboard to check the details. The path: Side navigation bar -> select "Sub-merchants" -> select a specific sub-merchant -> select "Settings" tab.

Update sub-merchant settings

(1) Method 1: Request Merchant: UpdateAPI

You can update the settings of some fields mentioned in "View the detail of a sub-merchant" above.

(2) Method 2: Access KOMOJU dashboard

You can also access the dashboard to update the settings of each sub-merchant. The path: Side navigation bar -> select "Sub-merchants" -> select a specific sub-merchant -> select "Settings" tab.

View payment list

(1) Method 1: Request Payment: List for Merchant API

If your sub-merchant is a Seller Merchant, you can get a list of payments processed under its account. In contrast, if the sub-merchant is a Payout Merchant, there is no payment record under its account due to not being a processing merchant.

(2) Method 2: Access KOMOJU dashboard

You can also access the dashboard to view the payment list. The path: Side navigation bar -> select "Payments" -> filter the records by sub-merchant's name.

View payment detail

(1) Method 1: Request Payment: Show API

You can access the detailed information of a payment by giving a payment id.

(2) Method 2: Access KOMOJU dashboard

The path: Side navigation bar -> select "Payments" -> select a specific payment record

Check balance

(1) Method 1: Request Balance: Show API

You can check the outstanding balance of a sub-merchant account with balance_total attribute. Since Platform Model only supports JPY processing payment methods, you should select JPYfor currencyattribute.

(2) Method 2: Access KOMOJU dashboard

You can also access the dashboard to check it. The path: Side navigation bar -> select "Sub-merchants" -> select a specific sub-merchant -> select "Payout Balance" tab.

View transactional records

(1) Method 1: Request Balance: Transactions and Balance: Transaction API

With Balance: Transactions API, you can view all transactional records of a sub-merchant.

On the other hand, by requesting Balance: Transaction API with given a transaction UUID, you'll be able to view more detailed transactional records belonging to that transaction of a sub-merchant.

(2) Method 2: Access KOMOJU dashboard

You can also access the dashboard to check those records. The path: Side navigation bar -> select "Sub-merchants" -> select a specific sub-merchant -> select "Transaction Records" tab.

View settlements list

(1) Method 1: Request Settlement: ListAPI

You can get a list of settlement records that KOMOJU has been paid out or going to pay out to your sub-merchant.

(2) Method 2: Access KOMOJU dashboard

You can also access the dashboard to view the settlement list of your sub-merchant. The path: Side navigation bar -> expand "Financial" section -> select "Settlements" -> filter the settlement records by sub-merchant's name

View settlements detail

(1) Method 1: Request Settlement: Show API

You can access detailed information on a settlement record by giving a specific settlement id.

(2) Method 2: Access KOMOJU dashboard

The path: Side navigation bar -> expand "Financial" section -> select "Settlements" -> select a specific settlement record

Download settlements report

(1) Method 1: Request Settlement: CSV and Settlement: XLS API

You can fetch a CSV file or an Excel file of a specific settlement record by giving a specific settlement id.

(2) Method 2: Access KOMOJU dashboard

The path: Side navigation bar -> expand "Financial" section -> select "Settlements" -> select a specific settlement record -> select "Download" button -> select "Download CSV" or "Download Excel"

Download settlements notice

(1) Method 1: Request Settlement: PDF API

You can fetch a PDF file of a Settlement Notice by giving a specific settlement id.

(2) Method 2: Access KOMOJU dashboard

The path: Side navigation bar -> expand "Financial" section -> select "Settlements" -> select a specific settlement record -> select "Download" button -> select "Settlement Notice"