Retrieve Invoices Filtered by Query

Facades: merchant

Query Params
string
required

When fetching an invoice via the merchant or the pos facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.

string
required

The start of the date window to query for invoices. Format YYYY-MM-DD

string
required

The end of the date window to query for invoices. Format YYYY-MM-DD

string

The invoice status you want to query on

string

The optional order id specified at time of invoice creation

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