Retrieve Payouts Filtered by Query

Facades: payout

Query Params
string
required

Approved payout facade token.

string

The start of the date window to query for payouts by effectiveDate. Format YYYY-MM-DD. If no date is provided it will default to 90 days ago.

string

The end of the date window to query for payouts by effectiveDate. Format YYYY-MM-DD. If no date is provided it will default to the date and time of the request.

string

The payout status you want to query on.

string

The optional reference specified at payout creation.

string

The groupId added to each payout that was created at the same time through the Create Payout Group request.

int32

Maximum results that the query will return (useful for paging results).

int32

Number of results to offset (ex. skip 10 will give you results starting with the 11th result).

Headers
string
required
Defaults to application/json

Must be set to application/json for requests to the BitPay API

string
required
Defaults to 2.0.0

Must be set to 2.0.0 for requests to the BitPay API

string
required

The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

string
required

The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json