---
title: "Platform"
description: "The **Platform** endpoints power marketplaces and platforms built on top of KOMOJU."
url: "https://docs.komoju.com/en/api-reference#2025-01-28/tag/platform-model"
source_url: "https://docs.komoju.com/en/api-reference/2025-01-28/resources/platform-model.md"
language: en
api_version: "2025-01-28"
---

# Platform

The **Platform** endpoints power marketplaces and platforms built on top of KOMOJU. A platform merchant onboards submerchants, splits payments between them, and manages their live-application status, payment method availability, and balances.

## The Submerchant object

A **Submerchant** describes one merchant's share of a payment in KOMOJU's
Platform Model. Platform payments carry a list of `Submerchant` entries
that split the total between the platform and the sellers that fulfilled
the order, with a per-submerchant `platform_fee` set aside for the
platform.

### Attributes

- **`submerchant_id`** *string (SubmerchantUUID)* *required*

  A unique 25-character alphanumeric merchant identifier.

- **`amount`** *integer (SubmerchantAmount)* *required*

  The amount with tax included, greater than or equal to 0, in the lowest
  denomination of the currency (e.g. cents for USD).

- **`platform_fee`** *integer (PlatformFeeAmount)* *required*

  The platform fee amount, tax included, greater than or equal to 0, in the
  lowest denomination of the currency (e.g. cents for USD).

### Example

```json
{
  "submerchant_id": "submerc1od2nc89s6u5hh6x4g",
  "amount": 900,
  "platform_fee": 100
}
```

## Endpoints

### Balance: Transfer

- [POST /balances/{currency}/transfer](https://docs.komoju.com/en/api-reference/2025-01-28/balance-transfer.md)

### Balance: Show

- [GET /merchants/{merchant_id}/balances/{currency}](https://docs.komoju.com/en/api-reference/2025-01-28/show-merchant-balance.md)

### Balance: Show Settings

- [GET /merchants/{merchant_id}/balances/{currency}/settings](https://docs.komoju.com/en/api-reference/2025-01-28/show-merchant-balance-settings.md)

### Balances: Edit Settings

- [PUT /merchants/{merchant_id}/balances/{currency}/settings](https://docs.komoju.com/en/api-reference/2025-01-28/edit-merchant-balance-settings.md)

### Balance: Transfer

- [POST /merchants/{merchant_id}/balances/{currency}/transfer](https://docs.komoju.com/en/api-reference/2025-01-28/create-merchant-balance-transfer.md)

### Balance: Transactions

- [GET /merchants/{merchant_id}/balances/{currency}/transactions](https://docs.komoju.com/en/api-reference/2025-01-28/merchant-balance-transactions.md)

### Balance: Transaction

- [GET /merchants/{merchant_id}/balances/{currency}/transactions/{transaction_uuid}](https://docs.komoju.com/en/api-reference/2025-01-28/show-merchant-balance-transaction.md)

### Settlement: PDF

- [GET /merchants/{merchant_id}/settlements/{id}/pdf](https://docs.komoju.com/en/api-reference/2025-01-28/submerchant-settlement-pdf.md)

### Settlement: XLS

- [GET /merchants/{merchant_id}/settlements/{id}/xls](https://docs.komoju.com/en/api-reference/2025-01-28/submerchant-settlement-xls.md)

### Settlement: CSV

- [GET /merchants/{merchant_id}/settlements/{id}/csv](https://docs.komoju.com/en/api-reference/2025-01-28/submerchant-settlement-csv.md)

### Settlement: Show

- [GET /merchants/{merchant_id}/settlements/{id}](https://docs.komoju.com/en/api-reference/2025-01-28/show-submerchant-settlement.md)

### Settlement: List

- [GET /merchants/{merchant_id}/settlements](https://docs.komoju.com/en/api-reference/2025-01-28/list-submerchant-settlements.md)

### Payment: List for Merchant

- [GET /merchants/{merchant_id}/payments](https://docs.komoju.com/en/api-reference/2025-01-28/list-submerchant-payments.md)

### Merchant: Show

- [GET /merchants/{id}](https://docs.komoju.com/en/api-reference/2025-01-28/show-merchant.md)

### Merchant: Update

- [PATCH /merchants/{id}](https://docs.komoju.com/en/api-reference/2025-01-28/update-merchant.md)

### Merchant: List

- [GET /merchants](https://docs.komoju.com/en/api-reference/2025-01-28/list-merchants.md)

### Merchant: Create

- [POST /merchants](https://docs.komoju.com/en/api-reference/2025-01-28/create-merchant.md)

### File: Create

- [POST /merchants/{merchant_id}/files](https://docs.komoju.com/en/api-reference/2025-01-28/create-file.md)

### File: Show

- [GET /merchants/{merchant_id}/files/{id}](https://docs.komoju.com/en/api-reference/2025-01-28/show-file.md)

### Live Application: Show

- [GET /live_application/{merchant_id}](https://docs.komoju.com/en/api-reference/2025-01-28/show-live-application.md)

### Live Application: Update

- [PATCH /live_application/{merchant_id}](https://docs.komoju.com/en/api-reference/2025-01-28/update-live-application.md)

### Live Application: Show Payment Method

- [GET /live_application/{merchant_id}/payment_methods/{payment_method}](https://docs.komoju.com/en/api-reference/2025-01-28/show-live-application-payment-method.md)

### Live Application: Update Payment Method

- [PATCH /live_application/{merchant_id}/payment_methods/{payment_method}](https://docs.komoju.com/en/api-reference/2025-01-28/update-live-application-payment-method.md)

### Live Application: Simulate Payment Method Status

- [PATCH /live_application/{merchant_id}/payment_methods/{payment_method}/simulate_status](https://docs.komoju.com/en/api-reference/2025-01-28/simulate-live-application-payment-method-status.md)

### Live Application: Simulate Status

- [PATCH /live_application/{merchant_id}/simulate_status](https://docs.komoju.com/en/api-reference/2025-01-28/simulate-live-application-status.md)

### Live Application: Payment Methods

- [GET /live_application/{merchant_id}/payment_methods](https://docs.komoju.com/en/api-reference/2025-01-28/list-live-application-payment-methods.md)