List in-scope Merchants

get

https://api.pushpay.com/v1/merchants/in-scope

You can find merchants the client's scope applies to - you can further filter this list by using one or more parameters for:

country (Country, valid values are NZ, AU, CA or US currently).
name (Full or partial name of a merchant listing)
handle (the full handle for a merchant listing)
visibility (if the merchant listings are visible or hidden)
status (if the merchant listings are active, closed or pending)

Note: Unfiltered requests will return merchants of Status = Active/Pending/Closed and Visibility = Visible/Hidden

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

One or more terms between spaces which will each be matched partially against the name of the merchant

handle

string

The unique text 'handle' assigned to the merchant

country

string

enum

The country the Merchant resides within

visibility

string

enum

Returns merchant listings based on the specified visibility filter: 'Visible' returns only visible listings, while 'Hidden' returns both visible and hidden listings

Allowed:

status

string

enum

Only include merchant listings matching the specified status - Active/Pending/Closed

Allowed:

page

int32

required

The page parameter (Note: page numbering starts at 0)

pageSize

int32

required

The page size parameter (Note: default page size is 25)

Responses

400

The server will not process the request due to a client error

401

Request failed because the client was not authorized to perform this action

404

Could not find resource

429

Request was throttled due to too many requests from this client or IP address

Language

Credentials

OAuth2

Loading…

Response

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

application/hal+json

200success