Tokens

Tokens are API access identifiers which are associated with a set of capabilities. A capability may be very broad, for example, retrieve the list of all exchange rates. Or a capability may be very specific, for example, refund invoice RhHwkycGaDskrEhGfXWnRG.

Resource

Name Type Facade
public merchant
data array ✓ ✓
policies object ✓ ✓
policy
Can be "sin", "access", "events", "id", or "session"
string ✓ ✓
method
Can be "requireSin", "requireFacadeAccess", "allowEventStream", "invalidated", "inactive", "unclaimed", "requireSession"
string ✓ ✓
params
Can be "support", SIN value, or null
array ✓ ✓
resource
Token identifier. This field can be ignored in merchant implementations.
string ✓
token
API token for token resource
string ✓ ✓
facade
Can be "merchant", "pos" or "payout"
string ✓ ✓
dateCreated
UNIX time of creation, in milliseconds
string ✓ ✓
pairingExpiration
UNIX time of expiration, in milliseconds
number ✓ ✓
pairingCode
Access approval code. To be validated via the BitPay dashboard in order to activate the token returned in the same payload.
string ✓ ✓