Paymentus Authentication API

The Authentication API issues short-lived JWT access tokens for the XOTP payment surface. A client signs a request with a pre-shared key (identified by a key id / kid and a three-letter application acronym / tla), declares the granular scopes it needs (for example xotp, xotp:profile, xotp:payment, xotp:autopay, xotp:accounts) or a pixel that maps to those scopes, and receives a Bearer token used on subsequent XOTP calls. Documented publicly via the @paymentus/auth Node.js SDK.

API entry from apis.yml

apis.yml Raw ↑
aid: paymentus:paymentus-authentication-api
name: Paymentus Authentication API
description: The Authentication API issues short-lived JWT access tokens for the XOTP payment surface.
  A client signs a request with a pre-shared key (identified by a key id / kid and a three-letter application
  acronym / tla), declares the granular scopes it needs (for example xotp, xotp:profile, xotp:payment,
  xotp:autopay, xotp:accounts) or a pixel that maps to those scopes, and receives a Bearer token used
  on subsequent XOTP calls. Documented publicly via the @paymentus/auth Node.js SDK.
humanURL: https://developer.paymentus.io/
baseURL: https://api.paymentus.com
tags:
- Authentication
- JWT
- Scopes
properties:
- type: Documentation
  url: https://developer.paymentus.io/
- type: SDK
  url: https://www.npmjs.com/package/@paymentus/auth