v1
latestOpenAPI 3.0.22026-07-2667277423.4 KBPayments
Payment: List
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.
get/payments
Query parameters
start_timestring date-time
Query for records created after this time.
end_timestring date-time
Query for records created before this time.
per_pageinteger
How many objects per page.
pageinteger
Page number to query for.
merchant_idstring
A unique 25-character alphanumeric merchant identifier.
Example:merc4ezlzkh7gfp4g93853
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.
Example:JPY
external_order_numstring
A unique ID from your application used to track this payment.
statusstring
Example:pending,captured
The status of the payment. Can be a single status or comma-separated values.
Response
200 response
Example response
{
"data": [
{
"id": "pay3fj6nnhvws08idzacf6et8",
"status": "captured",
"amount": 1000,
"payment_details": {
"month": 10,
"year": 2031,
"email": "example@komoju.com",
"name": "John Doe",
"given_name": "John",
"family_name": "Doe",
"installments": "3",
"shipping_address_name": "Taro Tanaka",
"shipping_address_line1": "5-2-1 Ginza",
"shipping_address_line2": "3rd floor",
"shipping_address_city": "Chuo-ku",
"shipping_address_state": "Tokyo",
"shipping_address_zip": "170-3293",
"shipping_address_country": "Japan",
"billing_address_name": "Taro Tanaka",
"billing_address_line1": "5-2-1 Ginza",
"billing_address_line2": "3rd floor",
"billing_address_city": "Chuo-ku",
"billing_address_state": "Tokyo",
"billing_address_zip": "170-3293",
"billing_address_country": "Japan"
},
"currency": "JPY",
"statement_descriptor": {
"statement_descriptor": "株式会社KOMOJU",
"statement_descriptor_alpha": "KOMOJU",
"statement_descriptor_kana": "コモジュ",
"statement_city": "Tokyo",
"contact_phone": "0312345678"
},
"platform_details": {
"submerchants": [
{
"submerchant_id": "submerc1od2nc89s6u5hh6x4g",
"amount": 900,
"platform_fee": 100
}
]
},
"refunds": [
{
"id": "ref442o1crn4qn3a3c7gspfik",
"amount": 1000,
"currency": "JPY",
"payment": "pay3fj6nnhvws08idzacf6et8",
"description": "Full refund",
"platform_details": {
"submerchants": [
{
"submerchant_id": "submerc1od2nc89s6u5hh6x4g",
"amount": 900,
"platform_fee": 100
}
]
}
}
],
"refund_requests": [
{
"id": "refreqlv6wny1ew1a1aq4zum1",
"payment": "pay3fj6nnhvws08idzacf6et8",
"customer_name": "ｻｲﾄｳ ﾏｻﾋﾛ",
"bank_name": "サンプル銀行",
"bank_code": "0900",
"branch_name": "本店",
"branch_number": "100",
"account_number": "1234567",
"status": "completed",
"platform_details": {
"submerchants": [
{
"submerchant_id": "submerc1od2nc89s6u5hh6x4g",
"amount": 900,
"platform_fee": 100
}
]
}
}
]
}
]
}