Retrieve an Event Token

get

https://test.bitpay.com/invoices/{invoiceId}/events

Retrieves a bus token which can be used to subscribe to invoice events.

Facades: merchant

Path Params

invoiceId

string

required

The ID of the invoice to retrieve an event token for

Query Params

token

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.

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

Response

Choose an example:

application/json

200200