Network APIMerchants

List merchants

Returns a list of merchants matching the given query parameters.

This endpoint is rate limited to 50 QPS.

Scopes: MERCHANTS_READ

Headers

AcceptstringRequired
X-RegionstringRequired
X-SignaturestringRequired
User-AgentstringRequired

Query parameters

reference_idstringOptional>=1 character<=1024 characters

Filters results to only include merchants with a reference_id matching the given value.

cursorstringOptional>=1 character
A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.
limitintegerOptional>=1<=100Defaults to 50
Maximum number of merchants to return.

Response

OK
merchantslist of objects
List of merchants matching the given query parameters.
cursorstring or null>=1 character
The pagination cursor to be used in a subsequent request. If empty, this is the final response.

Errors