OpenAPI 3.1

LuxPay API reference

Search by route, operation, or domain, then inspect request and response schemas and runnable examples.

JSON YAML Postman

Audit

GET/wallets/{walletId}/audit

List wallet audit recordslistWalletAudit

business_auditor

Authentication

POST/auth/customer/login

Customer loginloginCustomer

public POST/auth/customer/register

Register wallet customerregisterCustomer

public POST/auth/employee/login

Business employee loginloginEmployee

Health

API healthgetHealth

Holds

POST/wallets/hold

Hold wallet fundscreateHold

business_operator POST/wallets/release

Release held fundsreleaseHold

business_operator

Ledger

GET/wallets/{walletId}/ledger

List ledger entrieslistWalletLedger

business_finance GET/wallets/{walletId}/statement

Get wallet statementgetWalletStatement

customer_or_business GET/wallets/{walletId}/verify-integrity

Verify ledger integrityverifyWalletLedgerIntegrity

restricted_auditor POST/wallets/reverse

Reverse ledger postingreverseLedgerPair

restricted_finance

Merchant wallets

POST/merchant-wallets

Create merchant walletcreateMerchantWallet

business_operator GET/merchant-wallets/{merchantId}/overview

Merchant wallet overviewgetMerchantWalletOverview

merchant POST/merchant-wallets/{merchantId}/payment-link

Create payment linkcreateMerchantPaymentLink

merchant POST/merchant-wallets/{merchantId}/qr-payment

Create QR payment payloadcreateMerchantQrPayload

merchant POST/merchant-wallets/{merchantId}/settlement-request

Request merchant settlementrequestMerchantSettlement

merchant_finance GET/merchant-wallets/{merchantId}/transactions

List merchant transactionslistMerchantTransactions

Payment services

GET/payment-services

List payment serviceslistPaymentServices

authenticated GET/payment-services/{provider}

Get payment servicegetPaymentService

authenticated POST/payment-services/{provider}/select

Select payment serviceselectPaymentService

Payments

POST/payments/{paymentUuid}/cancel

Cancel paymentcancelPayment

authenticated POST/payments/{paymentUuid}/confirm

Confirm paymentconfirmPayment

authenticated POST/payments/{paymentUuid}/refund

Refund paymentrefundPayment

merchant_finance GET/payments/{paymentUuid}/status

Get payment statusgetPaymentStatus

authenticated POST/payments/initiate

Initiate paymentinitiatePayment

Payouts

List payoutslistPayouts

business_finance POST/payouts

Create payout requestcreatePayout

business_finance GET/payouts/{payoutId}

Get payoutgetPayout

business_finance POST/payouts/{payoutId}/approve

Approve payoutapprovePayout

restricted_approver POST/payouts/{payoutId}/cancel

Cancel payoutcancelPayout

business_finance POST/payouts/{payoutId}/execute

Execute payoutexecutePayout

restricted_operator POST/payouts/{payoutId}/reject

Reject payoutrejectPayout

restricted_approver

Provider webhooks

POST/webhooks/{provider}

Receive provider webhookreceiveProviderWebhook

Reports

GET/reports/fees

Fee reportgetFeeReport

business_finance GET/reports/payouts

Payout reportgetPayoutReport

business_finance GET/reports/settlements

Settlement reportgetSettlementReport

business_finance GET/reports/summary

Balance summarygetBalanceSummary

business_finance GET/reports/transactions

Transaction reportgetTransactionReport

business_finance

Settlements

GET/wallet-settlements

List settlementslistSettlements

business_finance POST/wallet-settlements

Create settlementcreateSettlement

business_finance GET/wallet-settlements/{settlementId}

Get settlementgetSettlement

business_finance POST/wallet-settlements/{settlementId}/approve

Approve settlementapproveSettlement

restricted_approver POST/wallet-settlements/{settlementId}/cancel

Cancel settlementcancelSettlement

business_finance POST/wallet-settlements/{settlementId}/execute

Execute settlementexecuteSettlement

restricted_operator POST/wallet-settlements/{settlementId}/reject

Reject settlementrejectSettlement

restricted_approver

Transactions

POST/wallets/{walletId}/deposit

Deposit fundsdepositWallet

business_operator GET/wallets/{walletId}/transactions

List wallet transactionslistWalletTransactions

customer_or_business POST/wallets/{walletId}/withdraw

Withdraw fundswithdrawWallet

business_operator POST/wallets/refund

Refund wallet transactionrefundWalletTransaction

business_operator

Transfers

POST/transfers

Transfer between walletscreateTransfer

customer_or_business POST/wallets/pay-merchant

Pay merchant walletpayMerchant

Wallets

List accessible walletslistWallets

customer_or_business POST/wallets

Create walletcreateWallet

business_operator GET/wallets/{walletId}

Get walletgetWallet

customer_or_business GET/wallets/{walletId}/balance

Get wallet balancegetWalletBalance

customer_or_business POST/wallets/{walletId}/freeze

Freeze walletfreezeWallet

restricted_operator POST/wallets/{walletId}/unfreeze

Unfreeze walletunfreezeWallet

restricted_operator POST/wallets/users

Create customer walletcreateCustomerWallet

business_operator