v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB

Platform Model

Merchant: List

Retrieves a paginated list of sub-merchants. Results can be filtered by live status, platform_role, account status, and whether payments or payouts are enabled.

get/merchants

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.

liveboolean

platform_role'seller' | 'payout'

statusstring

payments_enabledboolean

payouts_enabledboolean

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).