# AvraAPI

> Official AvraAPI documentation for backend SDKs, microservice APIs, and Universal Payment Gateway integrations.

- [Welcome to AvraAPI](https://docs.avraapi.com/introduction.md): The official developer documentation for the AvraAPI enterprise gateway and services.
- [Quickstart](https://docs.avraapi.com/information/quickstart.md): Create a project, generate Development credentials, and make your first server-to-server AvraAPI request.
- [Authentication & credentials](https://docs.avraapi.com/information/authentication-and-credentials.md): Authenticate server-to-server AvraAPI requests with project-scoped credentials and an environment boundary.
- [Projects & environments](https://docs.avraapi.com/information/projects-and-environments.md): Understand project ownership, Development and Production environments, pause behavior, and Workspace connections.
- [Responses, errors & retries](https://docs.avraapi.com/information/errors-and-response-format.md): Use AvraAPI response envelopes, request IDs, error codes, idempotency, and safe retry behavior.
- [Service pricing](https://docs.avraapi.com/information/service-pricing.md): Understand AvraAPI credits, provider usage, and Workspace-based UPG commercial capacity.
- [Workspace overview](https://docs.avraapi.com/workspaces/overview.md): Use Workspaces to manage teams, connected projects, UPG capacity, and delegated access without sharing account credentials.
- [Project linking](https://docs.avraapi.com/workspaces/project-linking.md): Connect a client project to a Business Workspace with a one-time key and explicit delegated permissions.
- [Roles & permissions](https://docs.avraapi.com/workspaces/roles-and-permissions.md): Use granular Workspace roles together with project-level delegation to provide least-privilege access.
- [Plans & capacity](https://docs.avraapi.com/workspaces/plans-and-capacity.md): Understand Workspace UPG entitlements, project activation slots, upgrades, and safe release behavior.
- [API key safety](https://docs.avraapi.com/security/api-key-safety.md): Protect AvraAPI project credentials through server-only storage, environment separation, rotation, and incident response.
- [Live Development requests](https://docs.avraapi.com/security/live-development-requests.md): Use Development credentials safely: Development is a real environment, not a mocked or free sandbox.
- [Webhook verification](https://docs.avraapi.com/security/webhook-verification.md): Receive payment-provider callbacks on your server, preserve raw evidence safely, and verify before fulfilling an order.
- [AvraAPI Changelog](https://docs.avraapi.com/information/documentation-changelog.md): Release notes for the AvraAPI Platform, official SDKs, and Payment Elements.
- [Universal Payment Gateway](https://docs.avraapi.com/universal-payment-gateway/overview.md): Use one AvraAPI SDK flow to discover, start, and verify payments across your configured gateways.
- [UPG Project Slots](https://docs.avraapi.com/universal-payment-gateway/project-slots.md): Understand the Workspace capacity requirement that authorizes a project to start new UPG checkouts.
- [Gateway Vault](https://docs.avraapi.com/universal-payment-gateway/gateway-vault.md): Set up gateway profiles safely so your SDK can create checkout sessions without handling provider secrets.
- [UPG Quick Setup](https://docs.avraapi.com/universal-payment-gateway/quick-setup.md): Connect a website to the Universal Payment Gateway with the PHP SDK and optional Payment Elements.
- [Payment Initiation](https://docs.avraapi.com/universal-payment-gateway/advanced-setup/payment-initiation.md): Create a provider-neutral checkout session safely from your backend.
- [Payment Response & Completion](https://docs.avraapi.com/universal-payment-gateway/advanced-setup/webhooks-and-completion.md): Verify provider callbacks and returns on your server before fulfilling an order.
- [Redirect Checkout](https://docs.avraapi.com/universal-payment-gateway/advanced-setup/redirect-checkout.md): Create and hand off provider-hosted checkout sessions with the Universal Payment Gateway SDK.
- [In-page Checkout](https://docs.avraapi.com/universal-payment-gateway/advanced-setup/hosted-checkout.md): Create overlay and embedded checkout sessions that keep the buyer on your site.
- [Gateway-wise Functions](https://docs.avraapi.com/universal-payment-gateway/gateway-wise-functions.md): Choose a gateway by its real checkout, completion, and cross-SDK capabilities.
- [PayHere](https://docs.avraapi.com/universal-payment-gateway/gateway-wise-functions/payhere.md): Use PayHere checkout and advanced payment operations through the AvraAPI Universal Payment Gateway.
- [MarxPay](https://docs.avraapi.com/universal-payment-gateway/gateway-wise-functions/marxpay.md): Use MarxPay redirect checkout, configured tender variants, return binding, initiation, and order-summary retrieval.
- [OnePay](https://docs.avraapi.com/universal-payment-gateway/gateway-wise-functions/onepay.md): Use OnePay redirect or overlay checkout with backend status reconciliation.
- [WebXPay](https://docs.avraapi.com/universal-payment-gateway/gateway-wise-functions/webxpay.md): Use the released WebXPay V2 Pay Once redirect flow with Merchant API reconciliation.
- [KOKO](https://docs.avraapi.com/universal-payment-gateway/gateway-wise-functions/koko.md): Use KOKO LKR redirect checkout with signed callback and order-view reconciliation.
- [PayPlus](https://docs.avraapi.com/universal-payment-gateway/gateway-wise-functions/payplus.md): Use PayPlus hosted redirect checkout with signed callback verification and status reconciliation.
- [Stripe](https://docs.avraapi.com/universal-payment-gateway/gateway-wise-functions/stripe.md): Use Stripe Checkout redirect sessions with raw webhook verification and bound session reconciliation.
- [DirectPay](https://docs.avraapi.com/universal-payment-gateway/gateway-wise-functions/directpay.md): Use DirectPay overlay or embedded checkout with signed backend callback completion.
- [UPG Errors](https://docs.avraapi.com/universal-payment-gateway/errors.md): Handle UPG readiness, typed SDK exceptions, and non-final payment results safely.
- [Payment Elements](https://docs.avraapi.com/universal-payment-gateway/payment-elements/overview.md): Build a consistent browser checkout while keeping AvraAPI credentials, Vault credentials, and payment completion on your server.
- [Visual Playground](https://docs.avraapi.com/universal-payment-gateway/payment-elements/visual-playground.md): Try the real Payment Elements customer form without API credentials or a payment request.
- [Render Customer Form](https://docs.avraapi.com/universal-payment-gateway/payment-elements/render-form.md): Collect buyer details with a configurable, accessible form and send them only to your backend.
- [Render Payment Methods](https://docs.avraapi.com/universal-payment-gateway/payment-elements/render-methods.md): Render only the payment methods that AvraAPI has made public, configured, and usable for the project.
- [Checkout Lifecycle, Events & Errors](https://docs.avraapi.com/universal-payment-gateway/payment-elements/checkout-lifecycle.md): Launch provider checkout safely, handle browser UI feedback, and keep server-side payment completion authoritative.
- [SDK overview](https://docs.avraapi.com/sdk/overview.md): Choose the supported AvraAPI SDK for your backend application.
- [PHP SDK overview and setup](https://docs.avraapi.com/sdk/php/overview-and-setup.md): Install and configure the official AvraAPI PHP SDK for a secure backend integration.
- [PHP SDK currency services](https://docs.avraapi.com/sdk/php/currency-services.md): Use the AvraAPI PHP SDK to retrieve active currency codes, rates, and conversions.
- [PHP SDK security services](https://docs.avraapi.com/sdk/php/security-services.md): Use the AvraAPI PHP SDK to check IP-risk signals and disposable-email signals.
- [PHP SDK location service](https://docs.avraapi.com/sdk/php/location-service.md): Use the AvraAPI PHP SDK to resolve a permitted IPv4 or IPv6 address.
- [PHP SDK SMS service](https://docs.avraapi.com/sdk/php/sms-service.md): Use the AvraAPI PHP SDK to send SMS or read the configured SMS balance.
- [PHP SDK utility services](https://docs.avraapi.com/sdk/php/utility-services.md): Use the AvraAPI PHP SDK to generate QR codes, barcodes, and PDFs.
- [PHP SDK Universal API call](https://docs.avraapi.com/sdk/php/universal-api-call.md): Use the AvraAPI PHP SDK Universal Function for a released provider route that does not yet have a typed SDK method.
- [PHP SDK advanced services](https://docs.avraapi.com/sdk/php/advanced-services.md): Use the PHP SDK server-side Universal Payment Gateway integration and follow the canonical AvraAPI payment guides.
- [Laravel SDK overview and setup](https://docs.avraapi.com/sdk/laravel/overview-and-setup.md): Install and configure the official AvraAPI Laravel SDK with the Facade or dependency injection.
- [Laravel SDK currency services](https://docs.avraapi.com/sdk/laravel/currency-services.md): Use the AvraAPI Laravel SDK to retrieve active currency codes, rates, and conversions.
- [Laravel SDK security services](https://docs.avraapi.com/sdk/laravel/security-services.md): Use the AvraAPI Laravel SDK to check IP-risk and disposable-email signals.
- [Laravel SDK location service](https://docs.avraapi.com/sdk/laravel/location-service.md): Use the AvraAPI Laravel SDK to resolve a permitted IPv4 or IPv6 address.
- [Laravel SDK SMS service](https://docs.avraapi.com/sdk/laravel/sms-service.md): Use the AvraAPI Laravel SDK to send SMS or read the configured SMS balance.
- [Laravel SDK utility services](https://docs.avraapi.com/sdk/laravel/utility-services.md): Use the AvraAPI Laravel SDK to generate QR codes, barcodes, and PDFs.
- [Laravel SDK Universal API call](https://docs.avraapi.com/sdk/laravel/universal-api-call.md): Use the AvraAPI Laravel SDK Universal Function for a released provider route that does not yet have a typed SDK method.
- [Laravel SDK advanced services](https://docs.avraapi.com/sdk/laravel/advanced-services.md): Use the Laravel SDK server-side Universal Payment Gateway integration and follow the canonical AvraAPI payment guides.
- [Node.js SDK overview and setup](https://docs.avraapi.com/sdk/nodejs/overview-and-setup.md): Install and configure the official AvraAPI Node.js SDK for a secure server-side integration.
- [Node.js SDK currency services](https://docs.avraapi.com/sdk/nodejs/currency-services.md): Use the AvraAPI Node.js SDK to retrieve active currency codes, rates, and conversions.
- [Node.js SDK security services](https://docs.avraapi.com/sdk/nodejs/security-services.md): Use the AvraAPI Node.js SDK to check IP-risk signals and disposable-email signals.
- [Node.js SDK location service](https://docs.avraapi.com/sdk/nodejs/location-service.md): Use the AvraAPI Node.js SDK to resolve a permitted IPv4 or IPv6 address.
- [Node.js SDK SMS service](https://docs.avraapi.com/sdk/nodejs/sms-service.md): Use the AvraAPI Node.js SDK to send SMS or read the configured SMS balance.
- [Node.js SDK utility services](https://docs.avraapi.com/sdk/nodejs/utility-services.md): Use the AvraAPI Node.js SDK to generate QR codes, barcodes, and PDFs.
- [Node.js SDK Universal API call](https://docs.avraapi.com/sdk/nodejs/universal-api-call.md): Use the AvraAPI Node.js SDK Universal Function for a released provider route that does not yet have a typed SDK method.
- [Node.js SDK advanced services](https://docs.avraapi.com/sdk/nodejs/advanced-services.md): Use the Node.js SDK server-side Universal Payment Gateway integration and follow the canonical AvraAPI payment guides.
- [API Reference overview](https://docs.avraapi.com/api-reference/overview.md): See AvraAPI service groups, their providers, and the safe paths for SDK and REST integrations.
- [Providers & Microservices](https://docs.avraapi.com/api-reference/providers-and-microservices.md): Understand AvraAPI service groups, managed providers, and the supported ways to integrate.
- [REST API guide](https://docs.avraapi.com/api-reference/rest-api.md): Use the AvraAPI v1 REST API directly with project-scoped credentials and an explicit environment.
- [CBSL Rates](https://docs.avraapi.com/api-reference/cbsl-rates.md): Use CBSL indicative, buying, and selling LKR rate types through the Currency API.
- [List supported currency codes](https://docs.avraapi.com/api-reference/currency/list-codes.md): Retrieve the active Currency code list, including CBSL target codes.
- [Get latest rates](https://docs.avraapi.com/api-reference/currency/latest-rates.md): Retrieve the available rate map from one active base currency.
- [Get one currency-pair rate](https://docs.avraapi.com/api-reference/currency/pair-rate.md): Retrieve one standard pair or request a CBSL LKR rate type.
- [Convert a currency amount](https://docs.avraapi.com/api-reference/currency/convert-amount.md): Calculate a conversion for one positive amount using the current pair rate.
- [Check SMS balance](https://docs.avraapi.com/api-reference/sms/balance.md): Read the balance associated with the configured QuickSend SMS integration.
- [Send an SMS](https://docs.avraapi.com/api-reference/sms/send.md): Send one SMS, the same SMS to a bulk list, or different SMS messages to multiple recipients.
- [Check VPN, proxy, and IP risk](https://docs.avraapi.com/api-reference/security/vpn-shield.md): Classify one permitted IPv4 or IPv6 address for VPN, proxy, Tor, relay, and hosting signals.
- [Check a disposable email address](https://docs.avraapi.com/api-reference/security/burner-email-shield.md): Check one email address for disposable or temporary-email signals.
- [Look up an IP address](https://docs.avraapi.com/api-reference/location/lookup.md): Resolve one permitted IPv4 or IPv6 address into the AvraAPI Location result.
- [Generate a QR code](https://docs.avraapi.com/api-reference/utilities/qr-generate.md): Create a PNG, SVG, or Base64 QR code through your configured AvraAPI QR Generator.
- [Generate a barcode](https://docs.avraapi.com/api-reference/utilities/barcode-generate.md): Create a PNG or SVG barcode through your configured AvraAPI Barcode Generator.
- [Generate a PDF](https://docs.avraapi.com/api-reference/utilities/pdf-generate.md): Render HTML as a binary PDF or a Base64 JSON response through your configured AvraAPI PDF Generator.

## OpenAPI Specs

- [provider-api.openapi](/api-reference/provider-api.openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.