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), Odoo provider, 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. Partners also order POS hardware from RoxPay's catalog for a portfolio merchant and pay it from their own wallet balance.

Banking services

banking-services

AIS, banking services, IBAN checks, and VoP.

Utilities

utilities

Information lookups, contacts, contact companies, transactions, users, webhooks, and authorized domains.

Chat API

chat-api

WhatsApp chat iframe, notifications, and WhatsApp.

Fiscal invoices

fiscal-invoices

Italian e-invoices (fatture) and fiscal receipts (corrispettivi). Start with Fiscal Configuration to switch on the channels you need.

Contracts

contracts

SecureSign digital contracts: create, update, list, and read. The Utilities contact book (`/api/v5/clients`) is republished here so a contracts integration can manage its contacts without a second credential — note that a contract's `ClientId` is a SecureSign recipient id from GET /api/v5/contracts/clients, not a contact `CLT-…` id.

Domains

domains

Register and manage `.eu` domains. First-time setup: create your registrant (the legal owner) with POST /domains/registrant. Then the usual flow is list packages → check availability → quote → buy/transfer (buy/transfer charge a card for the up-front deposit). Also: list your domains, issue/revoke a domain's transfer auth-code, and toggle auto-renew (off lets a domain lapse at expiry — there is no delete endpoint).

Partners

partners

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