---
title: "Sub-merchant Management"
description: "How Platform Merchants can manage and monitor their sub-merchants, including viewing account lists, details, payments, balances, transaction records, settlements, and downloading reports."
url: "https://docs.priv.staging.komoju-dev.tools/en/docs/platform-model/sub-merchant-management"
source_url: "https://docs.priv.staging.komoju-dev.tools/en/docs/platform-model/sub-merchant-management.md"
language: en
last_modified: "2026-03-26"
---

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](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/merchants) 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](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/merchants/%7Bid%7D) 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](https://help.komoju.com/hc/en-us/articles/4747504469022)) |
| `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](https://help.komoju.com/hc/en-us/articles/4747504469022)) |
| `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](https://help.komoju.com/hc/en-us/articles/4747504469022)) |
| `send_payment_refund_email` | boolean | When the full refund is completed, an email will be sent to the customer's email address. ([reference](https://help.komoju.com/hc/en-us/articles/4747504469022)) (*Partial refund is not supported.) |
| `expiry_settings` | array | The expiry settings for Konbini and Bank Transfer payments. [Reference](https://help.komoju.com/hc/en-us/articles/4747480397982) of Konbini payment expiry date. [Reference](https://help.komoju.com/hc/en-us/articles/4747456709022) 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: Update](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/PATCH/merchants/%7Bid%7D) API**

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](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/merchants/%7Bmerchant_id%7D/payments) 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](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/payments/GET/payments/%7Bid%7D) 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](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/balances/%7Bmerchant_id%7D/balances/%7Bcurrency%7D) 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 `JPY` for the `currency` attribute.

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](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/balances/%7Bmerchant_id%7D/balances/%7Bcurrency%7D/transactions) and [Balance: Transaction](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/balances/%7Bmerchant_id%7D/balances/%7Bcurrency%7D/transactions/%7Btransaction_uuid%7D) APIs**

The [Balance: Transactions](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/balances/%7Bmerchant_id%7D/balances/%7Bcurrency%7D/transactions) API allows you to view all transactional records of a sub-merchant.

Requesting [Balance: Transaction](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/balances/%7Bmerchant_id%7D/balances/%7Bcurrency%7D/transactions/%7Btransaction_uuid%7D) 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: List](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/merchants/%7Bmerchant_id%7D/settlements) API**

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](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/merchants/%7Bmerchant_id%7D/settlements/%7Bid%7D) 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](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/merchants/%7Bmerchant_id%7D/settlements/%7Bid%7D/csv) and [Settlement: XLS](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/merchants/%7Bmerchant_id%7D/settlements/%7Bid%7D/xls) APIs**

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](https://docs.priv.staging.komoju-dev.tools/en/api-reference#2025-01-28/tag/platform-model/GET/merchants/%7Bmerchant_id%7D/settlements/%7Bid%7D/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.