Retrieve all batches that belong to a merchant

get

https://api.pushpay.com/v1/merchant/{merchantKey}/batches

Retrieves all batches that belong to the in scope merchant & which pass the specified filters

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

merchantKey

string

required

The unique key of the merchant - a case-sensitive series of characters

Query Params

orderBy

string

Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'. Valid columns are 'name', 'createdOn', 'transactions', and 'amount'

name

string

Only include batches which contain the following substring, wildcharacters implicitly prepended and appended

type

string

enum

Only include batches which are of the specified type (BatchEntry or CheckDeposit)

Allowed:

status

string

enum

Only include batches which have the specified status (Open, Validating, ReadyToAllocate, Completed or Rejected)

Allowed:

from

date-time

Only include batches which have been created after the specified date (UTC)

date-time

Only include batches which have been created before the specified date (UTC)

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

200success