Skip to main content

Scope

The kinds of permissions a user can grant on a token.

enum Scope {
openid
accounts
transactions
balances
accountholders
pci_unsafe
bankstatements
paymentinitiationrequest
client_paymentrequest
client_bankaccountverification
client_imageupload
client_businesslookup
client_paymentauthorizationrequest
tenant_clientcreate
tenant_paymentrequestcreate
tenant_subscriptioncreate
client_refund
client_disbursement
client_recurringpaymentconsentrequest
client_cdv
}

Values

openid

Allows for the identification of the request as an OIDC request

accounts

Allows the listing of bank accounts.

transactions

Allows the querying of transactions for bank accounts.

balances

Allows the querying of bank account balances.

accountholders

Allows the lookup of account holder information for bank accounts.

pci_unsafe

Allows the lookup of unmasked bank account number.

bankstatements

Allows the retrieval of user bank account statements.

paymentinitiationrequest

Allows the creation of user constrained payment requests.

client_paymentrequest

Allows the creation and retrieval of payment requests.

client_bankaccountverification

Allows the submission of bank account verification requests.

client_imageupload

Allows the uploading of client images.

client_businesslookup

Allows the lookup of business registration information.

client_paymentauthorizationrequest

Allows the creation and retrieval of payment authorizations.

tenant_clientcreate

Allows the creation of a client for a tenant

tenant_paymentrequestcreate

Allows the creation of payment requests for a tenant

tenant_subscriptioncreate

Allows the creation of subscriptions for a tenant

client_refund

Allows the initiation of a refund on a payment

client_disbursement

Allows the creation of a client disbursement

client_recurringpaymentconsentrequest

Allows the creation of a recurring payment consent request

client_cdv

Allows the submission of bank account CDV requests