API reference

Meta

Reachability, account, permissions and limits

Operations

OperationWhat it doesScope
GET/v1/pingReachability check. No API key required.
GET/v1/accountPartner, settlement modes, scopes and limits of this key.account:read

A key that lacks one of these scopes is refused with 403 insufficient_scope, and error.missingScope names the one it was missing. Scopes are fixed when the key is issued.

Shared across these operations

The error envelope and the full list of error types are the same for every operation in the API, as are the object schemas the responses are built from. Neither is repeated per page.