LuxPay API overview

What this portal documents

This portal is the technical reference for the LuxPay Wallet API and its connected payment surfaces. The contract covers authentication, wallets, balances, transactions, transfers, holds and releases, the immutable ledger, merchant payments, payment services, payouts, settlements, reports, and provider-facing webhooks. Product education and end-user operating guidance remain on the separate LuxPay product documentation site.

Source of truth

The OpenAPI file in this repository is derived from the actual LuxApi route registration and controller validation rules. An endpoint appearing in the reference does not mean every integration may call it. The access tier identifies customer, merchant, finance, approver, operator, auditor, and provider-only surfaces. Business and branch identity are resolved from trusted authentication context where the contract requires it; do not add identity fields that the request schema intentionally excludes.

Integration model

Obtain the provisioned environment URL and credentials from LuxPay, call the health endpoint, and attach a unique request ID to every request. Use idempotency keys for financial mutations and persist returned resource identifiers instead of relying only on UI state. Read Authentication and Idempotency before your first write operation.

Security boundary

Never ship secrets in a public mobile or browser bundle, and never log access tokens, passwords, or webhook signatures. All examples use synthetic values. Placeholder server URLs in the contract are deliberately non-production until LuxPay provisions the real environment.