Manage sub-merchants

Learn how to split payments between multiple parties.

As a Platform Merchant, you're able to access the following management-related key functions to manage your sub-merchants.

View sub-merchants account list

(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 the 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's never a processing merchant.
  • Payouts_enabled: This represents whether the sub-merchants can receive payouts from KOMOJU or not.

(2) Method 2: Access KOMOJU dashboard

You can also access our frontend dashboard to check it. The path: Navigation bar -> click Sub-merchants section.

View sub-merchant account detail

(1) Method 1: Request Merchant: Show API

If the sub-merchant is a Seller Merchant, you'll be able to check the status of the following fields

FieldTypeDescription
application_statusstringThe review status of the sub-merchant's application
payments_enabledbooleanThis represents if the Seller Merchant can start processing payments
payouts_enabledbooleanThis represents whether the sub-merchants can receive payouts from KOMOJU or not.
send_payment_instruction_emailbooleanEmail with payment instructions will be sent to the customer's email address. (reference)
send_payment_receipt_emailbooleanWhen the customer complete the payment, an email will be sent to the customer email address. (reference)
send_payment_reminder_emailboolean1 day before the payment expire date, a reminder email will be sent to the customer email address. (reference)
send_payment_refund_emailbooleanWhen the full refund is completed, an email will be sent to the customer email address.(reference)
expiry_settingsarrayThe expiry days of Konbini payment and Bank Transfer payments.
- Reference of Konbini payment expiry date
- Reference of Bank Transfer payment expiry date
active_payment_methodsarrayThe active payment methods that Seller Merchant can process payments.

If the sub-merchant is a Payout Merchant, only the following items are available to be checked

FieldTypeDescription
application_statusstringThe review status of the sub-merchant's application
payouts_enabledbooleanThis represents whether the sub-merchants can receive payouts from KOMOJU or not.

(2) Method 2: Access KOMOJU dashboard

You can also access our frontend dashboard to check it. The path: Navigation bar -> click Sub-merchants section -> select the sub-merchant -> click "settings" tab.

Update sub-merchant settings

(1) Method 1: Request Merchant: UpdateAPI

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

(2) Method 2: Access KOMOJU dashboard

You can also access our frontend dashboard to update those settings of every sub-merchant. The path: Navigation bar -> click Sub-merchants section -> select the sub-merchant -> click "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 payment records processed under its account because Seller Merchant is a processing merchant. 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 our frontend dashboard to view the payment list. The path: Navigation bar -> click "Payments" section and filter the records by sub-merchant's name.

View payment detail

(1) Method 1: Request Payment: Show API

You can request detailed information on a payment record by giving a specific payment id.

(2) Method 2: Access KOMOJU dashboard

You can also view detailed information on a payment record on our frontend dashboard. The path: Navigation bar -> click "Payments" section -> click a specific payment record.

Check balance

(1) Method 1: Request Balance: Show API

You can check the outstanding balance in a specific sub-merchant account with balance_total attribute.

(2) Method 2: Access KOMOJU dashboard

You can also access our frontend dashboard to check the outstanding balance in a specific sub-merchant account. The path: Navigation bar -> click Sub-merchants section -> select the sub-merchant -> click "payout balance" tab.

View all transactional records

(1) Method 1: Request Balance: TransactionsAPI

You can check all kinds of transactional records of the sub-merchant so that you're able to know the most granular composition of the balance.

(2) Method 2: Access KOMOJU dashboard

You can also access our frontend dashboard to check all kinds of transactional records a sub-merchant account. The path: Navigation bar -> click Sub-merchants section -> select the sub-merchant -> click "ledger" tab.

View settlements list

(1) Method 1: Request Settlement: ListAPI

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

(2) Method 2: Access KOMOJU dashboard

You can also view the settlement list of your sub-merchant. The path: Navigation bar -> expand "Financial" section -> click "Settlements" tab and filter the settlement records by sub-merchant's name.

View settlements detail

(1) Method 1: Request Settlement: Show API

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

(2) Method 2: Access KOMOJU dashboard

You can view detailed information on a settlement record by accessing our frontend dashboard. The path: Navigation bar -> expand "Financial" section -> click "Settlements" tab -> click a specific settlement record.

Download settlements report

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

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

(2) Method 2: Access KOMOJU dashboard

You can also download a CSV file and an Excel file of a specific settlement record by accessing our frontend dashboard. The path: Navigation bar -> expand "Financial" section -> click "Settlements" tab -> click a specific settlement record -> click "Download" button -> select "Download CSV" or "Download Excel" option.

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

You can also download a PDF file of a Settlement Notice by accessing our frontend dashboard. The path: Navigation bar -> expand "Financial" section -> click "Settlements" tab -> click a specific settlement record -> click "Download" button -> select "Settlement Notice" option.