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 PaymentsElectronic Bill PresentmentPayment ProcessingPayment GatewayDisbursementsACHReal-Time PaymentsTokenization
Scopes: 16 Flows: Method: searched

Scopes (16)

ScopeDescriptionFlows
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.

Source

OAuth Scopes

paymentus-scopes.yml Raw ↑
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.

Work with this as data

Every scope set here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for oauth scopes

4 MCP tools reach this
  • find_scopesBrowse and filter every scope set in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This scope set
curl "https://apis.io/api/v1/scopes/paymentus-scopes"
All oauth scopes
curl "https://apis.io/api/v1/scopes?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.