Retrieve Recipients by Status

get

https://test.bitpay.com/recipients

Facades: payout

Query Params

token

string

required

Approved payout facade token.

status

string

The recipient status you want to query on. Possible status options are invited, unverified, verified, and active.

limit

int32

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

offset

int32

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

Headers

Content-Type

string

required

Defaults to application/json

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

X-Accept-Version

string

required

Defaults to 2.0.0

Must be set to 2.0.0 for requests to the BitPay API

X-Identity

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.

X-Signature

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

Loading…

Response

Choose an example:

application/json

200200