---
title: "KOMOJU API Reference (2025-01-28)"
description: "Full featured access to the KOMOJU payments system."
url: "https://docs.komoju.com/en/api-reference#2025-01-28/description/introduction"
source_url: "https://docs.komoju.com/en/api-reference/2025-01-28/index.md"
language: en
api_version: "2025-01-28"
---

# KOMOJU API Reference (2025-01-28)

## Payments

- [Payment: List](https://docs.komoju.com/en/api-reference/2025-01-28/list-payments.md) — `GET /payments`
- [Payment: Create](https://docs.komoju.com/en/api-reference/2025-01-28/create-payment.md) — `POST /payments`
- [Payment: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-payment.md) — `GET /payments/{id}`
- [Payment: Update](https://docs.komoju.com/en/api-reference/2025-01-28/update-payment.md) — `PATCH /payments/{id}`
- [Payment: Capture](https://docs.komoju.com/en/api-reference/2025-01-28/capture-payment.md) — `POST /payments/{id}/capture`
- [Payment: Refund](https://docs.komoju.com/en/api-reference/2025-01-28/refund-payment.md) — `POST /payments/{id}/refund`
- [Payment: Cancel](https://docs.komoju.com/en/api-reference/2025-01-28/cancel-payment.md) — `POST /payments/{id}/cancel`
- [Payment: Finalize](https://docs.komoju.com/en/api-reference/2025-01-28/finalize-payment.md) — `POST /payments/{id}/finalize`
- [Payment: Refund Request](https://docs.komoju.com/en/api-reference/2025-01-28/create-refund-request.md) — `POST /payments/{id}/refund_request`
- [Payment Method: List](https://docs.komoju.com/en/api-reference/2025-01-28/list-payment-methods.md) — `GET /payment_methods`

## Sessions

- [Session: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-session.md) — `GET /sessions/{id}`
- [Session: Create](https://docs.komoju.com/en/api-reference/2025-01-28/create-session.md) — `POST /sessions`
- [Session: Cancel](https://docs.komoju.com/en/api-reference/2025-01-28/cancel-session.md) — `POST /sessions/{id}/cancel`
- [Session: Pay](https://docs.komoju.com/en/api-reference/2025-01-28/pay-session.md) — `POST /sessions/{id}/pay`

## Tokens

- [Token: Create](https://docs.komoju.com/en/api-reference/2025-01-28/create-token.md) — `POST /tokens`

## SecureTokens

- [SecureToken: Create](https://docs.komoju.com/en/api-reference/2025-01-28/create-secure-token.md) — `POST /secure_tokens`
- [SecureToken: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-secure-token.md) — `GET /secure_tokens/{id}`

## Subscriptions

- [Customer: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-customer.md) — `GET /customers/{id}`
- [Customer: Update](https://docs.komoju.com/en/api-reference/2025-01-28/update-customer.md) — `PATCH /customers/{id}`
- [Customer: Destroy](https://docs.komoju.com/en/api-reference/2025-01-28/delete-customer.md) — `DELETE /customers/{id}`
- [Customer: List](https://docs.komoju.com/en/api-reference/2025-01-28/list-customers.md) — `GET /customers`
- [Customer: Create](https://docs.komoju.com/en/api-reference/2025-01-28/create-customer.md) — `POST /customers`
- [Subscription: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-subscription.md) — `GET /subscriptions/{id}`
- [Subscription: Destroy](https://docs.komoju.com/en/api-reference/2025-01-28/delete-subscription.md) — `DELETE /subscriptions/{id}`
- [Subscription: List](https://docs.komoju.com/en/api-reference/2025-01-28/list-subscriptions.md) — `GET /subscriptions`
- [Subscription: Create](https://docs.komoju.com/en/api-reference/2025-01-28/create-subscription.md) — `POST /subscriptions`

## Chargebacks

- [Chargeback: List](https://docs.komoju.com/en/api-reference/2025-01-28/list-chargeback-requests.md) — `GET /chargeback_requests`
- [Chargeback: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-chargeback-request.md) — `GET /chargeback_requests/{id}`
- [Chargeback: Accept](https://docs.komoju.com/en/api-reference/2025-01-28/accept-chargeback-request.md) — `POST /chargeback_requests/{id}/accept`
- [Chargeback: Defend](https://docs.komoju.com/en/api-reference/2025-01-28/defend-chargeback-request.md) — `POST /chargeback_requests/{id}/defend`

## Events

- [Event: List](https://docs.komoju.com/en/api-reference/2025-01-28/list-events.md) — `GET /events`
- [Event Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-event.md) — `GET /events/{id}`

## Settlements

- [Balance: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-balance.md) — `GET /balances/{currency}`
- [Balance: Transactions](https://docs.komoju.com/en/api-reference/2025-01-28/balance-transactions.md) — `GET /balances/{currency}/transactions`
- [Balance: Transaction](https://docs.komoju.com/en/api-reference/2025-01-28/show-transaction.md) — `GET /balances/{currency}/transactions/{transaction_uuid}`
- [Settlement: Index](https://docs.komoju.com/en/api-reference/2025-01-28/list-settlements.md) — `GET /settlements`
- [Settlement: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-settlement.md) — `GET /settlements/{id}`
- [Settlement: CSV](https://docs.komoju.com/en/api-reference/2025-01-28/show-settlement-csv.md) — `GET /settlements/{id}/csv`
- [Settlement: XLS](https://docs.komoju.com/en/api-reference/2025-01-28/show-settlement-xls.md) — `GET /settlements/{id}/xls`
- [Settlement: PDF](https://docs.komoju.com/en/api-reference/2025-01-28/show-settlement-pdf.md) — `GET /settlements/{id}/pdf`

## Platform Model

- [Balance: Transfer](https://docs.komoju.com/en/api-reference/2025-01-28/balance-transfer.md) — `POST /balances/{currency}/transfer`
- [Balance: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-merchant-balance.md) — `GET /merchants/{merchant_id}/balances/{currency}`
- [Balance: Show Settings](https://docs.komoju.com/en/api-reference/2025-01-28/show-merchant-balance-settings.md) — `GET /merchants/{merchant_id}/balances/{currency}/settings`
- [Balances: Edit Settings](https://docs.komoju.com/en/api-reference/2025-01-28/edit-merchant-balance-settings.md) — `PUT /merchants/{merchant_id}/balances/{currency}/settings`
- [Balance: Transfer](https://docs.komoju.com/en/api-reference/2025-01-28/create-merchant-balance-transfer.md) — `POST /merchants/{merchant_id}/balances/{currency}/transfer`
- [Balance: Transactions](https://docs.komoju.com/en/api-reference/2025-01-28/merchant-balance-transactions.md) — `GET /merchants/{merchant_id}/balances/{currency}/transactions`
- [Balance: Transaction](https://docs.komoju.com/en/api-reference/2025-01-28/show-merchant-balance-transaction.md) — `GET /merchants/{merchant_id}/balances/{currency}/transactions/{transaction_uuid}`
- [Settlement: PDF](https://docs.komoju.com/en/api-reference/2025-01-28/submerchant-settlement-pdf.md) — `GET /merchants/{merchant_id}/settlements/{id}/pdf`
- [Settlement: XLS](https://docs.komoju.com/en/api-reference/2025-01-28/submerchant-settlement-xls.md) — `GET /merchants/{merchant_id}/settlements/{id}/xls`
- [Settlement: CSV](https://docs.komoju.com/en/api-reference/2025-01-28/submerchant-settlement-csv.md) — `GET /merchants/{merchant_id}/settlements/{id}/csv`
- [Settlement: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-submerchant-settlement.md) — `GET /merchants/{merchant_id}/settlements/{id}`
- [Settlement: List](https://docs.komoju.com/en/api-reference/2025-01-28/list-submerchant-settlements.md) — `GET /merchants/{merchant_id}/settlements`
- [Payment: List for Merchant](https://docs.komoju.com/en/api-reference/2025-01-28/list-submerchant-payments.md) — `GET /merchants/{merchant_id}/payments`
- [Merchant: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-merchant.md) — `GET /merchants/{id}`
- [Merchant: Update](https://docs.komoju.com/en/api-reference/2025-01-28/update-merchant.md) — `PATCH /merchants/{id}`
- [Merchant: List](https://docs.komoju.com/en/api-reference/2025-01-28/list-merchants.md) — `GET /merchants`
- [Merchant: Create](https://docs.komoju.com/en/api-reference/2025-01-28/create-merchant.md) — `POST /merchants`
- [File: Create](https://docs.komoju.com/en/api-reference/2025-01-28/create-file.md) — `POST /merchants/{merchant_id}/files`
- [File: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-file.md) — `GET /merchants/{merchant_id}/files/{id}`
- [Live Application: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-live-application.md) — `GET /live_application/{merchant_id}`
- [Live Application: Update](https://docs.komoju.com/en/api-reference/2025-01-28/update-live-application.md) — `PATCH /live_application/{merchant_id}`
- [Live Application: Show Payment Method](https://docs.komoju.com/en/api-reference/2025-01-28/show-live-application-payment-method.md) — `GET /live_application/{merchant_id}/payment_methods/{payment_method}`
- [Live Application: Update Payment Method](https://docs.komoju.com/en/api-reference/2025-01-28/update-live-application-payment-method.md) — `PATCH /live_application/{merchant_id}/payment_methods/{payment_method}`
- [Live Application: Simulate Payment Method Status](https://docs.komoju.com/en/api-reference/2025-01-28/simulate-live-application-payment-method-status.md) — `PATCH /live_application/{merchant_id}/payment_methods/{payment_method}/simulate_status`
- [Live Application: Simulate Status](https://docs.komoju.com/en/api-reference/2025-01-28/simulate-live-application-status.md) — `PATCH /live_application/{merchant_id}/simulate_status`
- [Live Application: Payment Methods](https://docs.komoju.com/en/api-reference/2025-01-28/list-live-application-payment-methods.md) — `GET /live_application/{merchant_id}/payment_methods`

## One Click

- [External Customer: Destroy](https://docs.komoju.com/en/api-reference/2025-01-28/delete-external-customer.md) — `DELETE /external_customers/{id}`

## Barcodes

- [Barcode: Show](https://docs.komoju.com/en/api-reference/2025-01-28/show-barcode.md) — `GET /barcodes/{payment_id}`