Retrieve all settlements that belong to a merchant

get

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

Retrieves all settlements 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', 'depositDate', and 'transactions'

isReconciled

boolean

Only include settlements which have or have not been reconciled by the user

name

string

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

type

string

enum

Only include settlements which are of the specified type (ACH, CreditCard, DepositedCheck or CashAndRecorded)

Allowed:

depositFrom

date-time

Only include settlements which have been deposited after the specified date (UTC)

depositTo

date-time

Only include settlements which have been deposited 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

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