Permission Scopes
This section outlines all the available resource based permissions.
Core Resources
Logs | |
---|---|
logs.read | Read API logs |
Access tokens | |
---|---|
tokens.read | Read tokens |
tokens.write | Create, update or delete tokens |
Webhooks | |
---|---|
webhooks.read | Read webhooks |
webhooks.write | Create, update or delete webhooks |
webhooks.secret.read | Read webhook secret |
webhooks.secret.write | Rotate webhook secret |
Wallets | |
---|---|
wallets.read | Read wallets, transactions & statements |
wallets.write | Create, update or delete wallets |
wallets.pin.read | Read wallet PIN code |
wallets.pin.write | Rotate wallet PIN code |
wallets.balances.read | Read wallet balances |
wallets.balances.write | Create, update or delete wallet balances |
wallets.accounts.read | Read wallet accounts |
wallets.accounts.write | Create, verify or delete wallet accounts |
wallets.contacts.read | Read wallet contacts |
wallets.contacts.write | Create or delete wallet contacts |
wallets.links.read | Read wallet payment links |
wallets.links.write | Create, update or delete wallet payment links |
Transfers | |
---|---|
transfers.initiate | Initiate transfers from a wallet |
transfers.approve | Approve pending transfers from a wallet |
transfers.cancel | Cancel pending transfers from a wallet |
Business Resources
Customers | |
---|---|
customers.read | Read customers |
customers.write | Create, update or delete customers |
Invoices | |
---|---|
invoices.read | Read invoices |
invoices.write | Create, send, update or delete invoices |
Plans | |
---|---|
plans.read | Read plans |
plans.write | Create, update or delete plans |
Subscriptions | |
---|---|
subscriptions.read | Read subscriptions |
subscriptions.write | Create, update or delete subscriptions |
Vouchers | |
---|---|
vouchers.read | Read vouchers |
vouchers.write | Create, update or delete vouchers |
vouchers.apply | Apply vouchers to invoices |
Payments | |
---|---|
payments.read | Read payments |
payments.initiate | Initiate payments |
payments.refund | Refund payments |
Payment Providers | |
---|---|
providers.read | Read payment providers |
providers.write | Create, update or modify payment providers |
Metrics | |
---|---|
metrics.read | Read billing metrics |