Sign in

v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB
Platform Model

Payment: List for Merchant

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/merchants/{merchant_id}/payments

Path parameters

merchant_idstring required

A unique 25-character alphanumeric resource identifier.

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.

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
status'pending' | 'authorized' | 'captured' | 'cancelled' | 'expired' | 'refunded' | 'failed'
Example:captured

Response

200 response

resourcestring required

Resource type name for this list.

totalinteger required

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

pageinteger required

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

per_pageinteger required

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

last_pageinteger required

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

Example response

{
  "data": [
    {
      "status": "captured",
      "currency": "JPY",
      "platform_details": {
        "submerchants": [
          {
            "submerchant_id": "submerc1od2nc89s6u5hh6x4g",
            "amount": 900,
            "platform_fee": 100
          }
        ]
      }
    }
  ]
}