Request an API Token

post

https://test.bitpay.com/tokens

Facades: public, merchant

📘
Note
For e-commerce implementation, we advise merchants to generate a standard pos facade token directly from the BitPay dashboard (make sure "Require Authentication" is disabled) and use the "Tokens" API endpoint only to request higher privilege tokens (typically merchant facade). Merchants only need to use this endpoint once, depending on the number of facades they want to have access to.

Body Params

string

required

Client identity based on BitAuth identity protocol, also known as SIN (System Identification Number)

facade

string

Defaults to pos

Can be merchant, pos, or payout. If passed in the body of the request together with the id parameter, leave the pairingCode parameter out.

label

string

Optional. Token label, may include spaces, underscores, and dashes. BitPay invites the merchants to pass their Business Name or website in this field.

pairingCode

string

Optional.

Client Initiated Pairing: If you do not pass a pairing code in the body of the request, you need to send the id and facade parameters. This will allow you to request API tokens with higher privileges (merchant, or payout facades)
Server Initiated Pairing: If you pass a pairing code in the body of the request, leave the facade parameter out. The pairing code which can be generated from the BitPay dashboard (with "Require Authentication" enabled) only allows you to request a pos facade token with authentication, meaning it will be necessary to cryptographically sign every request using this token, just like the other facades with higher privileges.

Headers

X-Accept-Version

string

required

Defaults to 2.0.0

Must be set to 2.0.0 for requests to the BitPay API

Response

Language

Loading…

Response

Choose an example:

application/json

Note

200200