Payment: List for Merchant

get https://komoju.com/api/v1/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.

Response

Response body

object

resource

string

required

total

int32

required

≥ 0

Amount greater than or equal to 0, in the lowest denomination of the
currency (e.g. cents for USD).

page

int32

required

≥ 0

Amount greater than or equal to 0, in the lowest denomination of the
currency (e.g. cents for USD).

per_page

int32

required

≥ 0

Amount greater than or equal to 0, in the lowest denomination of the
currency (e.g. cents for USD).

last_page

int32

required

≥ 0

Amount greater than or equal to 0, in the lowest denomination of the
currency (e.g. cents for USD).

data

array of objects

required

data*

object

string

required

length between 25 and 25

A unique 25-character alphanumeric resource identifier.

resource

string

required

status

string

required

pending authorized captured cancelled expired refunded failed

amount

int32

required

≥ 0

Amount greater than or equal to 0, in the lowest denomination of the
currency (e.g. cents for USD).

tax

int32

required

≥ 0

Amount greater than or equal to 0, in the lowest denomination of the
currency (e.g. cents for USD).

customer

string

required

payment_deadline

string

required

payment_details

string

required

payment_method_fee

int32

required

≥ 0

Amount greater than or equal to 0, in the lowest denomination of the
currency (e.g. cents for USD).

total

int32

required

≥ 0

Amount greater than or equal to 0, in the lowest denomination of the
currency (e.g. cents for USD).

currency

string

required

3-letter ISO currency code.

JPY USD EUR TWD KRW PLN GBP HKD SGD NZD AUD IDR MYR PHP THB CNY BRL CHF CAD VND

description

string

required

captured_at

date-time

required

external_order_num

string

required

metadata

object

required

Has additional fields

created_at

date-time

required

amount_refunded

int32

required

≥ 0

Amount greater than or equal to 0, in the lowest denomination of the
currency (e.g. cents for USD).

locale

string

required

For supported payment methods, sets the language of the instruction page.

ja en ko

session

string

required

length between 25 and 25

A unique 25-character alphanumeric resource identifier.

customer_family_name

string

required

customer_given_name

string

required

platform_details

object

required

mcc

string

required

statement_descriptor

string

required

refunds

array of objects

required

refunds*

object

refund_requests

array of objects

required

refund_requests*

object

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://komoju.com/api/v1/merchants/merchant_id/payments \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 response