API V5 · OAS3

Rox Pay API V5 documentation

V5 keeps the same resources as V4, split into focused Swagger sections. Create a V5 credential with the scopes you need, then request a bearer token with a comma-separated Scopes string.

Token example: {"Username":"...","Password":"...","Scopes":"online-payments, chat-api"} · Endpoint: POST /api/v5/auth/token · Missing scope on a call returns 401.

Online payments

online-payments

Payments (incl. Checkout SDK), PIS, stores, subscriptions, and transactions.

Wallet

wallet

Hosted wallet access, tokenized cards, and instant transfers between RoxPay wallets.

POS terminals

pos-terminals

POS terminals, receipts, stores, and transactions.

Banking services

banking-services

AIS, banking services, IBAN checks, and VoP.

Utilities

utilities

Information lookups, clients, transactions, users, webhooks, and authorized domains.

Chat API

chat-api

WhatsApp chat iframe, notifications, and WhatsApp.

Fiscal invoices

fiscal-invoices

Fiscal invoices and receipts.

Partners

partners

Companies and onboarding. Restricted to Admin or Partner companies (401 otherwise).