Request an API Token

Facades: public, merchant

Body Params
string
required

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

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.

string

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

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
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

Response

Language
LoadingLoading…
Response
Choose an example:
application/json