Paymentus · OAuth Scopes

Paymentus OAuth Scopes

OAuth 2.0 searched

Paymentus publishes 16 OAuth 2.0 scopes. Scopes are the fine-grained permissions an application requests at authorization time to act against the Paymentus API on a user’s behalf.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

PaymentsUnited StatesBill PaymentElectronic Bill PresentmentPayment ProcessingPayment GatewayDisbursementsACHReal-Time PaymentsTokenization

Scopes: 16 Flows: Method: searched

Scopes (16)

Scope	Description	Flows
xotp	Basic XOTP functionality (base payment surface).
xotp:profile	Profile (wallet/payment-method token) management.
xotp:profile:read	Read profile data.
xotp:profile:create	Create profiles.
xotp:profile:update	Update profiles.
xotp:profile:delete	Delete profiles.
xotp:listProfiles	List profiles.
xotp:payment	Payment processing (Sale / make payment).
xotp:payment:history	Read payment history.
xotp:payment:void	Void or cancel payments.
xotp:autopay	AutoPay enrollment and management.
xotp:autopay:delete	Delete AutoPay settings.
xotp:account	Link an account to a user.
xotp:accounts	Account management.
xotp:listAccounts	List accounts.
paybotus	Paybotus functionality.

📄 Provider scope reference: https://developer.paymentus.io/

Source

OAuth Scopes

generated: '2026-07-24'
method: searched
source: https://www.npmjs.com/package/@paymentus/auth
docs: https://developer.paymentus.io/
model: >-
  Granular OAuth-style scopes declared at JWT issuance via the Auth API. A client
  requests scopes directly or supplies a Paymentus "pixel" that expands to a
  required scope set (see pixels[] below).
schemes:
  - name: BearerAuth
    type: jwt-scopes
    source: packages/paymentus-packages.yml
scopes:
  - scope: xotp
    description: Basic XOTP functionality (base payment surface).
  - scope: "xotp:profile"
    description: Profile (wallet/payment-method token) management.
  - scope: "xotp:profile:read"
    description: Read profile data.
  - scope: "xotp:profile:create"
    description: Create profiles.
  - scope: "xotp:profile:update"
    description: Update profiles.
  - scope: "xotp:profile:delete"
    description: Delete profiles.
  - scope: "xotp:listProfiles"
    description: List profiles.
  - scope: "xotp:payment"
    description: Payment processing (Sale / make payment).
  - scope: "xotp:payment:history"
    description: Read payment history.
  - scope: "xotp:payment:void"
    description: Void or cancel payments.
  - scope: "xotp:autopay"
    description: AutoPay enrollment and management.
  - scope: "xotp:autopay:delete"
    description: Delete AutoPay settings.
  - scope: "xotp:account"
    description: Link an account to a user.
  - scope: "xotp:accounts"
    description: Account management.
  - scope: "xotp:listAccounts"
    description: List accounts.
  - scope: paybotus
    description: Paybotus functionality.
pixels:
  - name: tokenization-pixel
    scopes: ["xotp:profile"]
    required_claims: []
  - name: list-wallets-pixel
    scopes: ["xotp:profile", "xotp:listProfiles", "xotp:profile:delete"]
    required_claims: [userLogin]
  - name: user-checkout-pixel
    scopes: ["xotp:profile", "xotp:payment", "xotp:listProfiles", "xotp:listAccounts", "xotp:profile:delete"]
    optional_scopes: ["xotp:autopay", "xotp:account"]
    required_claims: [userLogin, paymentsData]
  - name: guest-checkout-pixel
    scopes: ["xotp:payment", "xotp:listAccounts", "xotp:profile"]
    required_claims: [paymentsData]
    note: Automatically sets pmToken ['anonymousPMOnly'] in the JWT.