When you create an API key, you must assign it scopes and give it an alias to identify it. Each scope corresponds to endpoints that the key has permission to:
  • READ, via GET calls
  • WRITE, via POST and PUT calls
For more details about managing scopes, see the API key management guide. This page lists the endpoints in each scope. Notes on scope evolution:
  • Each endpoint belongs to only one scope.
  • Endpoints will not be moved from their current scope.
  • If a new endpoint is added to an existing scope, keys already assigned to the scope automatically gain access to the new endpoint. This also applies to scope permissions that contain no endpoints today.
  • If a new sub-scope is created, e.g. Bankaccounts.Xxxx, then keys previously assigned the Bankaccounts scope inherit access to the new sub-scope.

Bankaccounts

WRITE READ

Client

Client.Details

WRITE READ

Client.Developers

WRITE READ

Client.PayIns

WRITE READ
  • No endpoints with READ permission

Client.Permissions

WRITE READ

Client.Reports

WRITE READ

Client.Wallets

WRITE
  • No endpoints with WRITE permission
READ

Conversions

WRITE READ

Disputes

Disputes.General

WRITE READ

Disputes.Settlement

WRITE READ

Payins

WRITE READ

Payouts

WRITE READ

Refunds

Refunds.General

WRITE
  • No endpoints with WRITE permission
READ

Refunds.Payins

WRITE READ

Refunds.Payouts

WRITE
  • No endpoints with WRITE permission
READ

Refunds.Repudiations

WRITE
  • No endpoints with WRITE permission
READ

Refunds.Transfers

WRITE READ

Transfers

WRITE READ

Users

Users.Details

WRITE READ

Users.Verification

WRITE READ

Wallet.Details

WRITE READ