# Open Pay

## Docs

- [Audit Logs](https://docs-openpay.nipuntheekshana.com/api-reference/admin/audit-logs.md): Query platform-wide and merchant-scoped audit trails for compliance and monitoring
- [Merchant Management](https://docs-openpay.nipuntheekshana.com/api-reference/admin/merchant-management.md): List, review, and manage merchant accounts from the admin panel
- [Admin API Overview](https://docs-openpay.nipuntheekshana.com/api-reference/admin/overview.md): Manage merchants, withdrawals, users, roles, and platform settings through the Admin API
- [Platform Settings](https://docs-openpay.nipuntheekshana.com/api-reference/admin/settings.md): Configure platform settings, email templates, and legal documents
- [User Management](https://docs-openpay.nipuntheekshana.com/api-reference/admin/user-management.md): Manage admin users, roles, and permissions for the platform
- [Withdrawal Management](https://docs-openpay.nipuntheekshana.com/api-reference/admin/withdrawal-management.md): Review, approve, reject, and complete merchant withdrawal requests
- [Change Password](https://docs-openpay.nipuntheekshana.com/api-reference/auth/change-password.md): Change the authenticated merchant's account password
- [Disable 2FA](https://docs-openpay.nipuntheekshana.com/api-reference/auth/disable-2fa.md): Disable two-factor authentication on the merchant's account
- [Get Profile](https://docs-openpay.nipuntheekshana.com/api-reference/auth/get-profile.md): Retrieve the authenticated merchant's profile
- [Login](https://docs-openpay.nipuntheekshana.com/api-reference/auth/login.md): Authenticate a merchant and obtain access and refresh tokens
- [Refresh Token](https://docs-openpay.nipuntheekshana.com/api-reference/auth/refresh-token.md): Exchange a refresh token for a new access token and refresh token pair
- [Register Merchant](https://docs-openpay.nipuntheekshana.com/api-reference/auth/register.md): Create a new merchant account on the Open Pay platform
- [Setup 2FA](https://docs-openpay.nipuntheekshana.com/api-reference/auth/setup-2fa.md): Generate a TOTP secret and QR code URI for setting up two-factor authentication
- [Verify 2FA](https://docs-openpay.nipuntheekshana.com/api-reference/auth/verify-2fa.md): Verify a TOTP code to complete two-factor authentication setup
- [Create Checkout Session](https://docs-openpay.nipuntheekshana.com/api-reference/checkout/create-session.md): Create a hosted checkout session and receive a redirect URL for the customer
- [Direct Debit Overview](https://docs-openpay.nipuntheekshana.com/api-reference/direct-debit/overview.md): Pre-authorized recurring and on-demand crypto charges
- [Get Exchange Rates](https://docs-openpay.nipuntheekshana.com/api-reference/exchange/get-rates.md): Retrieve the current active exchange rates for supported currency pairs
- [Branches](https://docs-openpay.nipuntheekshana.com/api-reference/merchants/branches.md): Create and manage merchant branch locations for point-of-sale integrations
- [Get Merchant](https://docs-openpay.nipuntheekshana.com/api-reference/merchants/get-merchant.md): Retrieve a merchant's details by their ID
- [List Merchants](https://docs-openpay.nipuntheekshana.com/api-reference/merchants/list-merchants.md): List all merchants on the platform (admin only)
- [Manage API Keys](https://docs-openpay.nipuntheekshana.com/api-reference/merchants/manage-api-keys.md): Create, list, and revoke API keys for server-to-server authentication
- [Payment Links](https://docs-openpay.nipuntheekshana.com/api-reference/merchants/payment-links.md): Create and manage shareable payment links for collecting crypto payments
- [Update Merchant](https://docs-openpay.nipuntheekshana.com/api-reference/merchants/update-merchant.md): Update a merchant's profile information
- [API Overview](https://docs-openpay.nipuntheekshana.com/api-reference/overview.md): Learn how to authenticate and interact with the Open Pay REST API
- [Create Payment](https://docs-openpay.nipuntheekshana.com/api-reference/payments/create-payment.md): Create a new payment intent and receive a crypto address for the customer to pay
- [Get Payment](https://docs-openpay.nipuntheekshana.com/api-reference/payments/get-payment.md): Retrieve the details and current status of a specific payment
- [List Payments](https://docs-openpay.nipuntheekshana.com/api-reference/payments/list-payments.md): Retrieve a paginated list of payments with optional filters
- [Refunds Overview](https://docs-openpay.nipuntheekshana.com/api-reference/refunds/overview.md): Merchant-initiated refund system for completed payments
- [Create Withdrawal](https://docs-openpay.nipuntheekshana.com/api-reference/settlements/create-withdrawal.md): Request a withdrawal of available funds to your bank account
- [Get Balance](https://docs-openpay.nipuntheekshana.com/api-reference/settlements/get-balance.md): Retrieve the merchant's current available, pending, and total earned balances
- [List Withdrawals](https://docs-openpay.nipuntheekshana.com/api-reference/settlements/list-withdrawals.md): Retrieve a paginated list of withdrawal requests
- [Create Subscription Plan](https://docs-openpay.nipuntheekshana.com/api-reference/subscriptions/create-plan.md): Create a new recurring subscription plan for customers to subscribe to
- [List Subscription Plans](https://docs-openpay.nipuntheekshana.com/api-reference/subscriptions/list-plans.md): Retrieve all subscription plans for the authenticated merchant
- [Manage Subscriptions](https://docs-openpay.nipuntheekshana.com/api-reference/subscriptions/manage-subscription.md): List, view, and cancel subscriptions
- [Subscribe to Plan](https://docs-openpay.nipuntheekshana.com/api-reference/subscriptions/subscribe.md): Create a new subscription for a customer on a specific plan
- [Configure Webhook](https://docs-openpay.nipuntheekshana.com/api-reference/webhooks/configure.md): Set or update the webhook endpoint URL and subscribe to specific events
- [Get Public Key](https://docs-openpay.nipuntheekshana.com/api-reference/webhooks/get-public-key.md): Retrieve the ED25519 public key used to verify webhook payload signatures
- [List Deliveries](https://docs-openpay.nipuntheekshana.com/api-reference/webhooks/list-deliveries.md): Retrieve a paginated list of webhook delivery attempts with their status
- [Test Webhook](https://docs-openpay.nipuntheekshana.com/api-reference/webhooks/test-webhook.md): Send a test webhook event to your configured endpoint to verify connectivity
- [Architecture](https://docs-openpay.nipuntheekshana.com/architecture.md): Microservices architecture powering the Open Pay platform
- [Authentication](https://docs-openpay.nipuntheekshana.com/authentication.md): Three authentication layers securing the Open Pay platform
- [Error Handling](https://docs-openpay.nipuntheekshana.com/guides/error-handling.md): Handle API errors, rate limits, and retries gracefully
- [Payment Flow](https://docs-openpay.nipuntheekshana.com/guides/payment-flow.md): Understand the complete payment lifecycle from creation to settlement
- [Point of Sale Integration](https://docs-openpay.nipuntheekshana.com/guides/pos-integration.md): Accept crypto payments at physical retail locations with QR-based checkout
- [Security Best Practices](https://docs-openpay.nipuntheekshana.com/guides/security.md): Protect your integration with API key management, webhook verification, and smart contract security
- [Webhooks](https://docs-openpay.nipuntheekshana.com/guides/webhooks.md): Receive real-time payment notifications with cryptographically signed webhooks
- [Introduction](https://docs-openpay.nipuntheekshana.com/introduction.md): Open Pay — a crypto-to-fiat payment platform for Sri Lanka and beyond
- [Shopify Plugin](https://docs-openpay.nipuntheekshana.com/plugins/shopify.md): Accept crypto payments in your Shopify store
- [WooCommerce Plugin](https://docs-openpay.nipuntheekshana.com/plugins/woocommerce.md): Accept crypto payments in your WooCommerce store with Open Pay
- [Quickstart](https://docs-openpay.nipuntheekshana.com/quickstart.md): Start accepting crypto payments with Open Pay in under 5 minutes
- [CLI Tool](https://docs-openpay.nipuntheekshana.com/sdks/cli.md): Command-line interface for managing Open Pay payments and configuration
- [Go SDK](https://docs-openpay.nipuntheekshana.com/sdks/go.md): Official Go SDK for the Open Pay API
- [Java SDK](https://docs-openpay.nipuntheekshana.com/sdks/java.md): Official Java SDK for the Open Pay API
- [SDK Overview](https://docs-openpay.nipuntheekshana.com/sdks/overview.md): Official SDKs for integrating Open Pay into any application
- [PHP SDK](https://docs-openpay.nipuntheekshana.com/sdks/php.md): Official PHP SDK for the Open Pay API
- [Python SDK](https://docs-openpay.nipuntheekshana.com/sdks/python.md): Official Python SDK for the Open Pay API
- [TypeScript SDK](https://docs-openpay.nipuntheekshana.com/sdks/typescript.md): Official TypeScript/Node.js SDK for the Open Pay API
- [Deployment Guide](https://docs-openpay.nipuntheekshana.com/smart-contracts/deployment.md): Deploy and configure Open Pay smart contracts on BSC
- [OpenPayEscrow](https://docs-openpay.nipuntheekshana.com/smart-contracts/escrow.md): On-chain escrow contract for trustless payment processing
- [Smart Contracts Overview](https://docs-openpay.nipuntheekshana.com/smart-contracts/overview.md): On-chain escrow and price feed contracts for trustless crypto payments
- [OpenPayPriceFeed](https://docs-openpay.nipuntheekshana.com/smart-contracts/price-feed.md): Chainlink oracle integration for real-time token price conversion

## OpenAPI Specs

- [openapi](https://docs-openpay.nipuntheekshana.com/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/theetaz/open-pay)
- [Merchant Portal](https://olp-merchant.nipuntheekshana.com)
- [Admin Dashboard](https://olp-admin.nipuntheekshana.com)