As a Platform Merchant, you have several tools to manage and monitor your sub-merchants.

View the list of sub-merchants

(1) Method 1: Use the Merchant: List API

With this API, you can retrieve key information about each sub-merchant, including:

status: The application status of the sub-merchant.
Payments_enabled: Indicates whether the Seller Merchant can process payments. For Payout Merchants, this value is always null, as they don't process payments.
Payouts_enabled: Indicates whether the sub-merchant can receive payouts from KOMOJU. This applies to both Seller Merchants and Payout Merchants.

(2) Method 2: Access the KOMOJU dashboard

You can also view your list of sub-merchants through the KOMOJU dashboard

Path: Select the "Sub-Merchants" tab on the navigation bar.

View the details of a sub-merchant

(1) Method 1: Use the Merchant: Show API

The following key attributes provide detailed information about a sub-merchant:

Field	Type	Description
live	boolean	Indicates whether the sub-merchant is in live mode
platform_role	string	The role of the sub-merchant, either Seller Merchant or Payout Merchant.
status	string	The application status of the sub-merchant
payments_enabled	boolean	Indicates whether the sub-merchant can process payments.
payouts_enabled	boolean	Indicates whether the sub-merchant can receive payouts from KOMOJU.
send_payment_instruction_email	boolean	The 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's email address.(reference) (*Partial refund is not supported.)
expiry_settings	array	The expiry settings for Konbini and Bank Transfer payments. - Reference of Konbini payment expiry date - Reference of Bank Transfer payment expiry date
active_payment_methods	array	The active Owned Payment Methods of the Seller Merchant

(2) Method 2: Access the KOMOJU dashboard

You can also view the details of a sub-merchant via the dashboard.

Path: Select the "Sub-Merchants" tab on the navigation bar -> Select a sub-merchant -> Select the "Settings" tab.

Update sub-merchant settings

(1) Method 1: Use the Merchant: UpdateAPI

You can update various settings for a sub-merchant, including the fields listed in the previous section.

(2) Method 2: Access the KOMOJU dashboard

You can also update sub-merchant settings through the dashboard.

Path: Select the "Sub-Merchants" tab on the navigation bar -> Select a sub-merchant -> Select the "Settings" tab.

View payment list of a Seller Merchant

(1) Method 1: Use the Payment: List for Merchant API

For a sub-merchant that is a Seller Merchant, you can retrieve a list of payments processed under their account. If the sub-merchant is a Payout Merchant, there will be no payment records, as they do not process payments.

(2) Method 2: Access the KOMOJU dashboard

You can also view the payment list directly through the dashboard.

Path: Select the "Payments" tab on the navigation bar -> Filter payments by the "Merchant" attribute.

View payment details

(1) Method 1: Use the Payment: Show API

You can view detailed information about a specific payment by providing the payment ID.

(2) Method 2: Access the KOMOJU dashboard

Path: Select the "Payments" tab on the navigation bar -> Select a specific payment.

Check balance

(1) Method 1: Use the Balance: Show API

You can check the outstanding balance of a sub-merchant account with balance_total attribute. Since the Platform Model only supports JPY payments, be sure to specify JPYfor the currencyattribute.

Please ensure you're calling the 2024-10-01 version of the API.

(2) Method 2: Access the KOMOJU dashboard

You can also check the balance via the dashboard

Path: Select the "Sub-Merchants" tab on the navigation bar -> Select a sub-merchant -> Select "Payout Balance" tab.

View transactional records

(1) Method 1: Use the Balance: Transactions and Balance: Transaction API

The Balance: Transactions API allows you to view all transactional records of a sub-merchant.

Requesting Balance: Transaction API with a specific transaction ID allows you to view all transactional records belonging to the ID.

(2) Method 2: Access the KOMOJU dashboard

You can also view transactional records via the dashboard.

Path: Select the "Sub-Merchants" tab on the navigation bar -> Select a sub-merchant -> Select the "Transaction Records" tab.

View settlement list

(1) Method 1: Use the Settlement: ListAPI

You can retrieve a list of settlement records that have been paid out or are scheduled to be paid to a sub-merchant.

(2) Method 2: Access the KOMOJU dashboard

You can view the list of settlements for a sub-merchant via the dashboard.

Path: Expand the "Financial" tab on the navigation bar -> Select the "Settlements" tab -> Filter settlements by the "Merchant" attribute

View settlement details

(1) Method 1: Use the Settlement: Show API

You can view detailed information about a specific settlement by providing a settlement ID.

Please ensure you're calling the 2024-10-01 version of the API.

(2) Method 2: Access the KOMOJU dashboard

You can view the detailed information of a settlement via the dashboard.

Path: Expand the "Financial" tab and select the "Settlements" tab on the navigation bar -> Select a settlement record

Download settlement report

(1) Method 1: Use the Settlement: CSV and Settlement: XLS API

You can fetch a CSV or Excel file for a specific settlement record by providing a settlement ID.

(2) Method 2: Access the KOMOJU dashboard

Path: Expand the "Financial" tab on the navigation bar -> Select the "Settlements" tab -> Select a settlement record -> Click the "Download" button -> Click the "Download CSV" or "Download Excel" button

Download settlements notice

(1) Method 1: Use the Settlement: PDF API

You can fetch a PDF file of the Settlement Notice by providing a settlement ID.

(2) Method 2: Access the KOMOJU dashboard

Path: Expand the "Financial" tab on the navigation bar -> Select the "Settlements" tab -> Select a settlement record -> Click the "Download" button -> Click the "Settlement Notice" button