# mizaniya-api-beta

- [Mizaniya Pay VTPE: Payment Integration API for Partners](https://beta-developers.mizaniyapay.dz/index.md): Mizaniya Pay VTPE is a Virtual Terminal Payment Engine that partners integrate with by building a Product Information API endpoint and a webhook receiver for payment events.
- [Implement Your First VTPE Integration in Minutes](https://beta-developers.mizaniyapay.dz/quickstart.md): Step-by-step guide to implement the Product Information API and webhook handler for VTPE, from creating a partner account to going live.
- [Authenticate with the Mizaniya Pay VTPE Platform](https://beta-developers.mizaniyapay.dz/authentication.md): Learn all three authentication mechanisms used between VTPE and partner APIs: Bearer API Secret, X-Timestamp header, and HMAC signature verification for webhooks.
- [VTPE Integration: Architecture and Component Overview](https://beta-developers.mizaniyapay.dz/concepts/integration-overview.md): VTPE calls your Product Information API for payment details and POSTs webhooks for lifecycle events. Learn the two-component integration model, configuration, and end-to-end flow.
- [VTPE Payment Lifecycle and State Transitions](https://beta-developers.mizaniyapay.dz/concepts/payment-lifecycle.md): Understand the three VTPE payment events: initialized, success, and fail. Learn what data each event carries and the recommended actions for your system.
- [VTPE Webhook Events and Delivery](https://beta-developers.mizaniyapay.dz/concepts/webhooks.md): VTPE sends signed POST webhooks for payment events. Learn about the event envelope, the three event types, retry behavior, acknowledgement, and signature verification.
- [VTPE Product Information API Error Responses](https://beta-developers.mizaniyapay.dz/concepts/errors.md): Your Product Information API must return NOT_FOUND, ALREADY_PAID, and SERVICE_UNAVAILABLE errors to VTPE with the correct HTTP status and JSON format.
- [Configure Your VTPE Integration: Setup Guide](https://beta-developers.mizaniyapay.dz/guides/configuration.md): Step-by-step guide to configure a VTPE integration by providing your API URL and Webhook URL and setting up credentials securely.
- [Verify VTPE Webhook Signatures with HMAC-SHA256](https://beta-developers.mizaniyapay.dz/guides/webhook-security.md): Learn how to verify VTPE webhook X-Signature headers using HMAC-SHA256 over the raw payload concatenated with the X-Timestamp value.
- [Production Best Practices for VTPE Integrations](https://beta-developers.mizaniyapay.dz/guides/best-practices.md): Secure secrets, validate timestamps, process webhooks idempotently, log safely, handle retries asynchronously, and monitor your VTPE integration in production.
- [Complete VTPE Integration Example](https://beta-developers.mizaniyapay.dz/guides/complete-integration.md): End-to-end VTPE integration code showing the Product Information API, webhook handler with signature verification, and all three event types.
- [Changelog](https://beta-developers.mizaniyapay.dz/changelog.md): A record of all notable changes to the VTPE Integration API, including new features, breaking changes, and fixes.
- [Contact Us](https://beta-developers.mizaniyapay.dz/contact.md): Get in touch with the Mizaniya Pay partner support team via WhatsApp, email, or our website.
- [Mizaniya Pay VTPE API: Reference Overview](https://beta-developers.mizaniyapay.dz/api-reference/introduction.md): Partner-hosted API conventions, request headers, response formats, and error structure for Mizaniya Pay VTPE integrations.
- [Product Information API: GET /{reference} Endpoint](https://beta-developers.mizaniyapay.dz/api-reference/payments/get-payment.md): The GET endpoint partners must expose for VTPE to retrieve payment details by reference, including response fields and implementation examples.
- [Payment Status API: GET /partner/payments/v1/{reference}/status](https://beta-developers.mizaniyapay.dz/api-reference/payments/payment-status.md): Query the current lock and payment state of a product reference. Use this to reconcile missing webhooks or check status before releasing a product.
- [VTPE Webhook Events: Complete Reference](https://beta-developers.mizaniyapay.dz/api-reference/webhooks/events.md): All three webhook events, common envelope, headers, acknowledgement format, and retry behavior for Mizaniya Pay VTPE integrations.
- [payment.initialized: Payment Session Created Event](https://beta-developers.mizaniyapay.dz/api-reference/webhooks/payment-initialized.md): Reference for the payment.initialized webhook event, including event data fields, payload example, and handler implementations in JavaScript and Python.
- [payment.success: Payment Confirmed Event Schema](https://beta-developers.mizaniyapay.dz/api-reference/webhooks/payment-success.md): Reference for the payment.success webhook event, including event data, channel values, payload example, and idempotent handler implementations.
- [payment.fail: Payment Failed or Cancelled Event](https://beta-developers.mizaniyapay.dz/api-reference/webhooks/payment-fail.md): Reference for the payment.fail webhook event, including event data fields, payload example, and handler implementations in JavaScript and Python.
- [Static QR Code API: Amount Configuration](https://beta-developers.mizaniyapay.dz/api-reference/qr-codes/overview.md): Attach and clear DZD payment amounts on static QR codes for the Mizaniya Pay platform using two REST endpoints.
- [POST /set-qr-config: Attach Amount Configuration to QR Code](https://beta-developers.mizaniyapay.dz/api-reference/qr-codes/set-qr-config.md): Attach one or more DZD payment amounts to a static Mizaniya Pay QR code, with optional expiry and single-use settings.
- [POST /un-set-qr-config: Clear QR Code Amount Configuration](https://beta-developers.mizaniyapay.dz/api-reference/qr-codes/un-set-qr-config.md): Remove the current amount configuration from a static Mizaniya Pay QR code so it no longer presents pre-configured amounts.
- [AGENTS](https://beta-developers.mizaniyapay.dz/AGENTS.md)