Docs
DocsAPI ExplorerChangelog

Account Management

Updated on March 26, 2026
View as Markdown

As a Platform Merchant, you have several tools to manage and monitor your account.

View payment list of Platform Merchant - Marketplace Business

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

For a Platform Merchant with Marketplace Business, you can retrieve a list of payments processed under your account.

If you have a Platform Merchant with Platform Business, there will be no payment records, as you're not processing 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.

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 your 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: Expand the "Financial" tab on the navigation bar → Select the "Payout Balance" tab.

View transactional records

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

The Balance: Transactions API allows you to view all transactional records of your account.

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: Expand the "Financial" tab on the navigation bar → Select the "Ledger" tab.

View settlement list

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

You can retrieve a list of settlement records that have been paid out or are scheduled to be paid to your account.

(2) Method 2: Access the KOMOJU dashboard

You can view the list of settlements 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 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 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.

Page Navigation

Ctrl←Ctrl→Ctrl↑Ctrl↓