This section outlines all the available access token permissions. You can also use the Scopes API to pull available permissions.

Read profile details
profiles.read

Grants read access to general information about your profile.

Write profile details
profiles.write

Allows modification of core profile information such as name and metadata.

Read profile address details
profiles.addresses.read

Grants read access to addresses linked to your profile.

Write profile address details
profiles.addresses.write

Allows adding or updating addresses associated with your profile.

Read owner details
profiles.owners.read

Grants visibility into the ownership structure of your business profile.

Write owner details
profiles.owners.write

Allows updating or submitting new owner information for verification.

Read member details
profiles.members.read

Grants access to view all users with access to the profile.

Write member details
profiles.members.write

Allows inviting, editing, or removing members on a profile.

Read token details
tokens.read

Grants visibility into existing access tokens.

Write token details
tokens.write

Allows creating and revoking access tokens.

Read webhook details
webhooks.read

Grants access to view configured webhooks.

Write webhook details
webhooks.write

Allows creating, updating, or deleting webhooks.

Read webhook secret
webhooks.secret.read

Grants access to the secrets used for webhook verification.

Write webhook secret
webhooks.secret.write

Allows regenerating or setting a new webhook secret.

Read provider details
providers.read

Grants access to view integrated payment or service providers.

Write provider details
providers.write

Allows connecting or disconnecting external providers.

Read wallet details
wallets.read

Grants access to view wallet-level metadata and configuration.

Write wallet details
wallets.write

Allows editing wallet-level configurations.

Read wallet pin details
wallets.pin.read

Grants visibility into the pin configuration for a wallet.

Write wallet pin details
wallets.pin.write

Allows setting or updating the wallet’s transaction pin.

Read wallet contacts details
wallets.contacts.read

Grants access to view wallet-level contact lists.

Write wallet contacts details
wallets.contacts.write

Allows modifying the contact list attached to a wallet.

Grants access to view wallet payment links.

Allows creating or deleting wallet payment links.

Read wallet balance details
wallets.balances.read

Grants access to all virtual balances in a wallet.

Write wallet balance details
wallets.balances.write

Allows configuration and internal transfer between virtual balances.

Read wallet connected account details
wallets.accounts.read

Grants visibility into connected bank accounts or payout accounts.

Write wallet connected account details
wallets.accounts.write

Allows linking or removing connected payout accounts.

Initiate transfer
transfers.initiate

Grants permission to create outbound money transfers.

Approve transfer
transfers.approve

Allows approving pending or secured transfers.

Cancel transfer
transfers.cancel

Allows cancelling transfers before completion.

Read invoice details
invoices.read

Grants access to view invoices and their statuses.

Write invoice details
invoices.write

Allows creating, editing, or deleting invoices.

Read subscription details
subscriptions.read

Grants visibility into recurring subscriptions.

Write subscription details
subscriptions.write

Allows managing and updating subscriptions.

Read customer details
customers.read

Grants access to view stored customer records.

Write customer details
customers.write

Allows creation and modification of customer records.

Read plan details
plans.read

Grants visibility into your billing plans and tiers.

Write plan details
plans.write

Allows creating or editing billing plans and options.

Read voucher details
vouchers.read

Grants access to view existing discount vouchers.

Write voucher details
vouchers.write

Allows creating or updating discount vouchers.

Apply voucher
vouchers.apply

Grants permission to apply a voucher to a transaction or invoice.

Read payment details
payments.read

Grants access to view payment records.

Initiate payment
payments.initiate

Allows programmatically initiating a new payment.

Refund payment
payments.refund

Grants permission to trigger a refund for a processed payment.

Read analytic metrics
metrics.read

Grants access to view performance metrics and analytics.

Read activity logs
logs.read

Grants access to audit trails and activity logs across your profile.