# Modulus Labs API

## Docs

- [Create Account](https://docs.moduluslabs.io/api-reference/onboarding/create-account.md): Create a new user account with contact information and credentials
- [Onboard Merchant](https://docs.moduluslabs.io/api-reference/onboarding/onboard-merchant.md): Onboard a merchant to accept payments through Modulus Labs
- [Ping](https://docs.moduluslabs.io/api-reference/onboarding/ping.md): Public health check endpoint to verify Onboarding API connectivity and availability
- [Retrieve Onboarding Data](https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data.md): Retrieve complete merchant onboarding data by reference number
- [Retrieve Onboarding Status](https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-status.md): Retrieve the current onboarding status for a merchant (lightweight endpoint)
- [Update Onboarding Data](https://docs.moduluslabs.io/api-reference/onboarding/update-onboarding-data.md): Update merchant onboarding data after being declined
- [Upload Onboarding Files](https://docs.moduluslabs.io/api-reference/onboarding/upload-onboarding-files.md): Upload business documents for merchant onboarding verification
- [Create Dynamic QR Ph](https://docs.moduluslabs.io/api-reference/qr/create.md): Generate a Dynamic QR Ph code for Consumer Scans Business transactions
- [Ping](https://docs.moduluslabs.io/api-reference/qr/ping.md): Public health check endpoint to verify API connectivity and availability
- [Create Payment](https://docs.moduluslabs.io/api-reference/terminal-gateway/create-payment.md): Initiate a payment to a specific terminal with long-polling up to 90 seconds
- [Create Webhook Endpoint](https://docs.moduluslabs.io/api-reference/terminal-gateway/create-webhook-endpoint.md): Register a new webhook endpoint to receive asynchronous payment notifications
- [Delete Webhook Endpoint](https://docs.moduluslabs.io/api-reference/terminal-gateway/delete-webhook-endpoint.md): Permanently delete a webhook endpoint
- [Get Transaction](https://docs.moduluslabs.io/api-reference/terminal-gateway/get-transaction.md): Retrieve transaction status for reconciliation or post-timeout verification
- [Get Webhook Endpoint](https://docs.moduluslabs.io/api-reference/terminal-gateway/get-webhook-endpoint.md): Retrieve a specific webhook endpoint by its ID
- [List Terminals](https://docs.moduluslabs.io/api-reference/terminal-gateway/list-terminals.md): Retrieve all active terminals in your group with connection details and status
- [List Webhook Endpoints](https://docs.moduluslabs.io/api-reference/terminal-gateway/list-webhook-endpoints.md): Retrieve all webhook endpoints configured for your group
- [Update Webhook Endpoint](https://docs.moduluslabs.io/api-reference/terminal-gateway/update-webhook-endpoint.md): Update an existing webhook endpoint's configuration
- [Get Transaction](https://docs.moduluslabs.io/api-reference/transaction-reporting/get-transaction.md): Retrieve a single transaction with full detail fields including lifecycle events
- [List Branches](https://docs.moduluslabs.io/api-reference/transaction-reporting/list-branches.md): Returns branches with stable UUIDs, optionally filtered by merchant
- [List Merchants](https://docs.moduluslabs.io/api-reference/transaction-reporting/list-merchants.md): Returns merchants with stable UUIDs, scoped to the authenticated entity
- [List Transactions](https://docs.moduluslabs.io/api-reference/transaction-reporting/list-transactions.md): Returns a paginated list of transactions with sorting and filtering
- [Ping](https://docs.moduluslabs.io/api-reference/transaction-reporting/ping.md): Liveness probe — verify the service is running
- [Create Webhook](https://docs.moduluslabs.io/api-reference/webhooks/create.md): Register a new webhook endpoint to receive QR Ph transaction notifications
- [Delete Webhook](https://docs.moduluslabs.io/api-reference/webhooks/delete.md): Permanently remove a webhook endpoint
- [Get Webhooks](https://docs.moduluslabs.io/api-reference/webhooks/list.md): Retrieve all registered webhook endpoints for your merchant account
- [Ping](https://docs.moduluslabs.io/api-reference/webhooks/ping.md): Public health check endpoint to verify Webhook API connectivity and availability
- [Simulate Webhook](https://docs.moduluslabs.io/api-reference/webhooks/simulate.md): Test your webhook integration by triggering simulated transaction notifications in sandbox
- [Update Webhook](https://docs.moduluslabs.io/api-reference/webhooks/update.md): Modify an existing webhook endpoint configuration
- [Changelog](https://docs.moduluslabs.io/changelog.md): Latest updates and improvements to Modulus Labs APIs
- [Errors](https://docs.moduluslabs.io/docs/errors.md): Understanding error codes and how to handle them
- [Authentication](https://docs.moduluslabs.io/docs/onboarding/authentication.md): Learn how to authenticate with JWT Bearer Tokens
- [Enums Reference](https://docs.moduluslabs.io/docs/onboarding/enums.md): All valid enumeration values for the Onboarding API
- [Onboarding API](https://docs.moduluslabs.io/docs/onboarding/introduction.md): Onboard merchants to accept payments through Modulus Labs
- [Production Deployment](https://docs.moduluslabs.io/docs/production.md): Deploy your QR payment integration to production
- [Authentication](https://docs.moduluslabs.io/docs/qr/authentication.md): Learn how to authenticate your API requests using HTTP Basic Auth
- [Encryption & JWE Tokens](https://docs.moduluslabs.io/docs/qr/encryption.md): Learn how to encrypt and decrypt payloads using JWE tokens
- [Introduction](https://docs.moduluslabs.io/docs/qr/introduction.md): Welcome to the Modulus Labs QR API documentation
- [Quickstart](https://docs.moduluslabs.io/docs/qr/quickstart.md): Get started with the Modulus Labs QR API in minutes
- [Testing in Sandbox](https://docs.moduluslabs.io/docs/qr/testing.md): Learn how to test Dynamic QR Ph transactions in the sandbox environment
- [Authentication](https://docs.moduluslabs.io/docs/terminal-gateway/authentication.md): API key provisioning and authentication methods for HTTP and WebSocket protocols
- [Core Concepts](https://docs.moduluslabs.io/docs/terminal-gateway/concepts.md): Single device enforcement, terminal reconnection resilience, and desktop POS recovery in the Terminal Gateway
- [HTTP Endpoints](https://docs.moduluslabs.io/docs/terminal-gateway/http/endpoints.md): Complete reference for Terminal Gateway HTTP API endpoints
- [HTTP Quick Start](https://docs.moduluslabs.io/docs/terminal-gateway/http/quickstart.md): Get started with the Terminal Gateway HTTP API in minutes
- [Receiving Webhooks](https://docs.moduluslabs.io/docs/terminal-gateway/http/webhooks-receiving.md): Handle webhook payloads and verify signatures for payment notifications
- [Webhook Setup](https://docs.moduluslabs.io/docs/terminal-gateway/http/webhooks-setup.md): Configure webhook endpoints to receive asynchronous payment notifications
- [Terminal Gateway](https://docs.moduluslabs.io/docs/terminal-gateway/introduction.md): Real-time communication between your POS system and payment terminals via HTTP or WebSocket
- [Data Types Reference](https://docs.moduluslabs.io/docs/terminal-gateway/reference.md): Shared data types, payment statuses, and error codes for Terminal Gateway APIs
- [Actions Reference](https://docs.moduluslabs.io/docs/terminal-gateway/websocket/actions.md): Send commands to discover terminals and initiate payments
- [Push Notifications](https://docs.moduluslabs.io/docs/terminal-gateway/websocket/notifications.md): Receive real-time updates for terminal status changes and payment completions
- [WebSocket Quick Start](https://docs.moduluslabs.io/docs/terminal-gateway/websocket/quickstart.md): Establish and maintain WebSocket connections with authentication, heartbeat, and reconnection handling
- [Authentication](https://docs.moduluslabs.io/docs/transaction-reporting/authentication.md): API key authentication and entity-level data scoping
- [Filtering & Sorting](https://docs.moduluslabs.io/docs/transaction-reporting/filtering.md): Query parameters for filtering, sorting, and paginating transaction data
- [Introduction](https://docs.moduluslabs.io/docs/transaction-reporting/introduction.md): Unified API for querying transaction history across all payment methods
- [Quick Start](https://docs.moduluslabs.io/docs/transaction-reporting/quickstart.md): Make your first Transaction Reporting API call in minutes
- [Overview](https://docs.moduluslabs.io/docs/webhooks/overview.md): Receive real-time notifications when QR Ph transactions are completed
- [Webhook Payload](https://docs.moduluslabs.io/docs/webhooks/payload.md): Complete reference for webhook payload structure, encryption, and fields
- [Receiving Webhooks](https://docs.moduluslabs.io/docs/webhooks/receiving.md): Handle and process webhook notifications for QR Ph transactions
- [Webhook Security](https://docs.moduluslabs.io/docs/webhooks/security.md): Secure your webhook endpoints and verify webhook authenticity
- [Webhook Setup](https://docs.moduluslabs.io/docs/webhooks/setup.md): Register and configure webhook endpoints to receive QR Ph transaction notifications

## OpenAPI Specs

- [openapi](https://docs.moduluslabs.io/api-reference/openapi.json)

## Optional

- [Support](mailto:support@moduluslabs.io)