# LuxPay Developer Documentation

> Canonical developer reference for the LuxPay Wallet API.

## Contracts
- [OpenAPI JSON](/openapi/luxpay-wallet-v1.json)
- [OpenAPI YAML](/openapi/luxpay-wallet-v1.yaml)
- [Postman](/postman/LuxPay-Wallet-API.postman_collection.json)

## Guides
- [نظرة عامة على واجهة LuxPay](/ar/guides/overview): نظرة عامة على واجهة LuxPay
- [البدء السريع](/ar/guides/quickstart): البدء السريع
- [المصادقة والرموز](/ar/guides/authentication): المصادقة والرموز
- [البيئات والإعداد](/ar/guides/environments): البيئات والإعداد
- [منع التكرار وإعادة المحاولة](/ar/guides/idempotency): منع التكرار وإعادة المحاولة
- [الأخطاء ومعرفات الطلب](/ar/guides/errors-request-ids): الأخطاء ومعرفات الطلب
- [الصفحات والمرشحات](/ar/guides/pagination-filtering): الصفحات والمرشحات
- [دورة حياة المحفظة](/ar/guides/wallet-lifecycle): دورة حياة المحفظة
- [دورة حياة الدفع](/ar/guides/payment-lifecycle): دورة حياة الدفع
- [تكامل التاجر](/ar/guides/merchant-integration): تكامل التاجر
- [الصرف والتسويات](/ar/guides/payouts-settlements): الصرف والتسويات
- [Webhooks وتوقيع المزود](/ar/guides/webhooks): Webhooks وتوقيع المزود
- [أمان الإنتاج](/ar/guides/security-production): أمان الإنتاج
- [الإصدارات والتغييرات](/ar/guides/versioning-changelog): الإصدارات والتغييرات
- [أنماط بناء SDK](/ar/guides/sdk-patterns): أنماط بناء SDK
- [LuxPay API overview](/en/guides/overview): LuxPay API overview
- [Quickstart](/en/guides/quickstart): Quickstart
- [Authentication and tokens](/en/guides/authentication): Authentication and tokens
- [Environments and configuration](/en/guides/environments): Environments and configuration
- [Idempotency and retries](/en/guides/idempotency): Idempotency and retries
- [Errors and request IDs](/en/guides/errors-request-ids): Errors and request IDs
- [Pagination and filtering](/en/guides/pagination-filtering): Pagination and filtering
- [Wallet lifecycle](/en/guides/wallet-lifecycle): Wallet lifecycle
- [Payment lifecycle](/en/guides/payment-lifecycle): Payment lifecycle
- [Merchant integration](/en/guides/merchant-integration): Merchant integration
- [Payouts and settlements](/en/guides/payouts-settlements): Payouts and settlements
- [Provider webhooks](/en/guides/webhooks): Provider webhooks
- [Production security](/en/guides/security-production): Production security
- [Versioning and changelog](/en/guides/versioning-changelog): Versioning and changelog
- [SDK design patterns](/en/guides/sdk-patterns): SDK design patterns

## Operations
- GET /wallets/{walletId}/audit — List wallet audit records (listWalletAudit)
- POST /auth/customer/login — Customer login (loginCustomer)
- POST /auth/customer/register — Register wallet customer (registerCustomer)
- POST /auth/employee/login — Business employee login (loginEmployee)
- GET /health — API health (getHealth)
- POST /wallets/hold — Hold wallet funds (createHold)
- POST /wallets/release — Release held funds (releaseHold)
- GET /wallets/{walletId}/ledger — List ledger entries (listWalletLedger)
- GET /wallets/{walletId}/statement — Get wallet statement (getWalletStatement)
- GET /wallets/{walletId}/verify-integrity — Verify ledger integrity (verifyWalletLedgerIntegrity)
- POST /wallets/reverse — Reverse ledger posting (reverseLedgerPair)
- POST /merchant-wallets — Create merchant wallet (createMerchantWallet)
- GET /merchant-wallets/{merchantId}/overview — Merchant wallet overview (getMerchantWalletOverview)
- POST /merchant-wallets/{merchantId}/payment-link — Create payment link (createMerchantPaymentLink)
- POST /merchant-wallets/{merchantId}/qr-payment — Create QR payment payload (createMerchantQrPayload)
- POST /merchant-wallets/{merchantId}/settlement-request — Request merchant settlement (requestMerchantSettlement)
- GET /merchant-wallets/{merchantId}/transactions — List merchant transactions (listMerchantTransactions)
- GET /payment-services — List payment services (listPaymentServices)
- GET /payment-services/{provider} — Get payment service (getPaymentService)
- POST /payment-services/{provider}/select — Select payment service (selectPaymentService)
- POST /payments/{paymentUuid}/cancel — Cancel payment (cancelPayment)
- POST /payments/{paymentUuid}/confirm — Confirm payment (confirmPayment)
- POST /payments/{paymentUuid}/refund — Refund payment (refundPayment)
- GET /payments/{paymentUuid}/status — Get payment status (getPaymentStatus)
- POST /payments/initiate — Initiate payment (initiatePayment)
- GET /payouts — List payouts (listPayouts)
- POST /payouts — Create payout request (createPayout)
- GET /payouts/{payoutId} — Get payout (getPayout)
- POST /payouts/{payoutId}/approve — Approve payout (approvePayout)
- POST /payouts/{payoutId}/cancel — Cancel payout (cancelPayout)
- POST /payouts/{payoutId}/execute — Execute payout (executePayout)
- POST /payouts/{payoutId}/reject — Reject payout (rejectPayout)
- POST /webhooks/{provider} — Receive provider webhook (receiveProviderWebhook)
- GET /reports/fees — Fee report (getFeeReport)
- GET /reports/payouts — Payout report (getPayoutReport)
- GET /reports/settlements — Settlement report (getSettlementReport)
- GET /reports/summary — Balance summary (getBalanceSummary)
- GET /reports/transactions — Transaction report (getTransactionReport)
- GET /wallet-settlements — List settlements (listSettlements)
- POST /wallet-settlements — Create settlement (createSettlement)
- GET /wallet-settlements/{settlementId} — Get settlement (getSettlement)
- POST /wallet-settlements/{settlementId}/approve — Approve settlement (approveSettlement)
- POST /wallet-settlements/{settlementId}/cancel — Cancel settlement (cancelSettlement)
- POST /wallet-settlements/{settlementId}/execute — Execute settlement (executeSettlement)
- POST /wallet-settlements/{settlementId}/reject — Reject settlement (rejectSettlement)
- POST /wallets/{walletId}/deposit — Deposit funds (depositWallet)
- GET /wallets/{walletId}/transactions — List wallet transactions (listWalletTransactions)
- POST /wallets/{walletId}/withdraw — Withdraw funds (withdrawWallet)
- POST /wallets/refund — Refund wallet transaction (refundWalletTransaction)
- POST /transfers — Transfer between wallets (createTransfer)
- POST /wallets/pay-merchant — Pay merchant wallet (payMerchant)
- GET /wallets — List accessible wallets (listWallets)
- POST /wallets — Create wallet (createWallet)
- GET /wallets/{walletId} — Get wallet (getWallet)
- GET /wallets/{walletId}/balance — Get wallet balance (getWalletBalance)
- POST /wallets/{walletId}/freeze — Freeze wallet (freezeWallet)
- POST /wallets/{walletId}/unfreeze — Unfreeze wallet (unfreezeWallet)
- POST /wallets/users — Create customer wallet (createCustomerWallet)