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

# HaiPay API Reference Overview

> Get a quick view of HaiPay API coverage, documentation structure, and recommended reading order across cashier, cards, subscriptions, and local payments.

The HaiPay API reference covers cashier flows, international cards, subscriptions, local acquiring and payout capabilities so merchants can quickly find the right endpoints for each business case.

Each API page is organized around real integration tasks, making it easier to review request parameters, response fields, sample payloads, and debugging entry points.

## What you'll find

* Endpoints for collections, order queries, payouts, payout queries, refunds, and subscription workflows
* Local payment coverage across Asia, Europe, Latin America, and the Middle East
* Shared rules for request format, signature validation, asynchronous notifications, and response codes
* API pages that support direct testing and faster integration troubleshooting

## Core capabilities

<Columns cols={2}>
  <Card title="Cashier" icon="credit-card" href="/docs/en/api-reference/cashier/api/collectApply">
    For unified cashier scenarios, including payment creation, query, and versioned query endpoints.
  </Card>

  <Card title="International Cards" icon="globe" href="/docs/en/api-reference/card/api/collectApply">
    Covers card collections, queries, MIT flows, and refund operations.
  </Card>

  <Card title="Card Subscriptions" icon="list-check" href="/docs/en/api-reference/subscription/api/subscriptionApply">
    Includes subscription create, query, and cancel endpoints. Refunds use the unified card refund API.
  </Card>

  <Card title="Regional Local Payments" icon="location-dot" href="/docs/en/api-reference/mxn/api/collectApply">
    Focused on local collection and payout APIs for Mexico, Turkey, Brazil, Southeast Asia, and more.
  </Card>

  <Card title="Middle East Wallets and Banks" icon="building-columns" href="/docs/en/api-reference/sar/api/collectApply">
    Covers localized payment capabilities for Saudi Arabia, the UAE, Qatar, Oman, Kuwait, Bahrain, and related markets.
  </Card>
</Columns>

## Recommended reading order

1. Start with [Config & Signature](/docs/en/guide/config_settings_and_signature_rules_guide) to confirm merchant parameters, RSA signing, and request formatting.
2. Continue with [API Description](/docs/en/guide/api_description_guide) to understand shared fields, signing rules, and response structures.
3. Move into the relevant API group based on your use case, such as cashier, cards, or local payments.
4. Before launch, validate your setup with [End-to-End Testing](/docs/en/guide/end_to_end_testing) and the [Onboarding Checklist](/docs/en/guide/onboarding_checklist).

## Coverage snapshot

The current API reference spans both global capabilities and localized payment methods, including Mexico, Turkey, Brazil, Hong Kong, Singapore, Taiwan, Japan, South Korea, the Philippines, Thailand, Vietnam, Indonesia, India, Malaysia, Pakistan, Bangladesh, Egypt, and multiple Middle East markets.

If you want to browse by country or product first, you can also start from the [API documentation list](/docs/en/guide/api_doc_list).

## Related Topics

* [HaiPay Payment API Documentation List](/docs/en/guide/api_doc_list)
* [HaiPay Integration Steps Guide](/docs/en/guide/integration_guide)
* [HaiPay Configuration and Signature Guide](/docs/en/guide/config_settings_and_signature_rules_guide)