---
title: "Payment: List for Merchant"
method: GET
path: "/merchants/{merchant_id}/payments"
tags: ["Platform Model"]
---

# Payment: List for Merchant

`GET /merchants/{merchant_id}/payments`

Retrieves a paginated list of payments. Pagination can be configured with `page` and `per_page` parameters.

Payments can be filtered by `currency`, `external_order_num`, and `status`.

A time range can be specified with `start_time`, and `end_time`.

## Path parameters

- `merchant_id` string, required — A unique 25-character alphanumeric resource identifier.

## Query parameters

- `start_time` string, date-time
- `end_time` string, date-time
- `per_page` integer
- `page` integer
- `currency` 'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND' — 3-letter ISO currency code.
- `external_order_num` string
- `status` 'pending' | 'authorized' | 'captured' | 'cancelled' | 'expired' | 'refunded' | 'failed'

## Response `200`

200 response

- PlatformMerchantPaymentList
  - `resource` string, required — Resource type name for this list.
  - `total` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
  - `page` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
  - `per_page` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
  - `last_page` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
  - `data` PlatformPayment[], required — Array of payment objects for this page.
    - `id` string, required — A unique 25-character alphanumeric resource identifier.
    - `resource` string, required — Resource type name, always "payment".
    - `status` 'pending' | 'authorized' | 'captured' | 'cancelled' | 'expired' | 'refunded' | 'failed', required
    - `amount` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
    - `tax` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
    - `customer` string, required — Customer UUID if associated with a customer, otherwise null.
    - `payment_deadline` string, required — Deadline by which the payment must be completed, or null.
    - `payment_details` string, required — Serialized payment method details for this payment.
    - `payment_method_fee` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
    - `total` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
    - `currency` 'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND', required — 3-letter ISO currency code.
    - `description` string, required — Optional description for the payment.
    - `captured_at` string, date-time, required — Timestamp when the payment was captured, or null if not yet captured.
    - `external_order_num` string, required — External order reference from the merchant's system.
    - `metadata` object, required — Arbitrary key-value metadata attached to the payment.
    - `created_at` string, date-time, required — Timestamp when the payment was created.
    - `amount_refunded` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
    - `locale` 'ja' | 'en' | 'ko', required — For supported payment methods, sets the language of the instruction page.
    - `session` string, required — A unique 25-character alphanumeric resource identifier.
    - `customer_family_name` string, required — Customer's family name.
    - `customer_given_name` string, required — Customer's given name.
    - `platform_details` PlatformDetails, required
      - `submerchants` Submerchant[], required — Array of submerchant split configurations for this platform payment.
        - `submerchant_id` string, required — A unique 25-character alphanumeric merchant identifier.
        - `amount` integer, 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, 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).
      - `processing_merchant_id` string — A unique 25-character alphanumeric resource identifier.
    - `mcc` string, required — Merchant Category Code used for this payment.
    - `statement_descriptor` string, required — Statement descriptor shown to the customer on their bank statement.
    - `refunds` object[], required — Array of refund objects associated with this payment.
    - `refund_requests` object[], required — Array of refund request objects associated with this payment.

---

[API](https://skmtc.net/komoju/apis/komoju-api.md) · [All operations](https://skmtc.net/komoju/apis/komoju-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/komoju/komoju-api/revisions/65483c40ba32/schema)