> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gowasl.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Payzah Cards API: Sell Digital Gift Cards via REST

> Integrate with Payzah's Cards and Vouchers platform to browse, purchase, and deliver digital gift cards through your own sales channels.

The Payzah Cards API lets merchants connect their websites and mobile apps to Payzah's catalog of digital gift cards and vouchers. With a few REST calls you can authenticate, browse available cards, check balances, place orders, and receive real-time webhook notifications — all without managing card inventory yourself.

<CardGroup cols={2}>
  <Card title="Get Started" icon="rocket" href="/getting-started">
    Register as a merchant and make your first API call in minutes.
  </Card>

  <Card title="Integration Guide" icon="map" href="/guides/request-flow">
    Follow the end-to-end flow from authentication to order confirmation.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/authentication/get-token">
    Full reference for every endpoint — request params, responses, and examples.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/api-reference/webhooks/overview">
    Receive real-time notifications for order status, busy mode, and more.
  </Card>
</CardGroup>

## How it works

<Steps>
  <Step title="Register as a merchant">
    Send your company details to Payzah to receive your private key and API credentials.
  </Step>

  <Step title="Authenticate">
    Call the Authentication API with your username and password to receive a session token.
  </Step>

  <Step title="Browse the card catalog">
    Fetch available card types and their denominations to display in your storefront.
  </Step>

  <Step title="Place and confirm orders">
    Initiate a card request, confirm it with payment details, and receive card codes instantly.
  </Step>
</Steps>

## Explore the docs

<CardGroup cols={3}>
  <Card title="Core Concepts" icon="book" href="/concepts">
    Understand vendors, cards, balances, and the order lifecycle.
  </Card>

  <Card title="Error Codes" icon="circle-exclamation" href="/security/error-codes">
    Diagnose and resolve API errors quickly.
  </Card>

  <Card title="Console Panel" icon="display" href="/guides/console-panel">
    Use the merchant dashboard for card replacement and reporting.
  </Card>
</CardGroup>


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