> For the complete documentation index, see [llms.txt](https://ethosflow.gitbook.io/ethosflow-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ethosflow.gitbook.io/ethosflow-docs/home.md).

# Home

## EthosPay / EthosFlow API Documentation

This documentation is for external merchant engineering teams integrating with EthosPay or EthosFlow. It covers backend APIs, webhook signature verification, reconciliation queries, and frontend SDK usage.

### Documentation Scope

| Document                            | Audience                                          | Main Content                                                                                               |
| ----------------------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| Professional Merchant API           | Backend systems with professional merchant access | Receiving addresses, payout orders, chain configuration, pay-in/payout notification queries, webhooks      |
| Professional Merchant API Reference | Professional merchant backend developers          | Endpoint, method, request, response, and webhook field tables                                              |
| Ordinary Merchant API               | EthosPay ordinary merchant backend systems        | Receiving addresses, hosted payment page data, chain configuration, pay-in notification queries, webhooks  |
| Ordinary Merchant API Reference     | Ordinary merchant backend developers              | Endpoint, method, request, response, and webhook field tables                                              |
| Merchant SDK                        | Frontend checkout pages or hosted payment pages   | EthosPay API client, order creation, order detail lookup, transaction status query, payment status helpers |

### Entry Points

| Type                      | Endpoint                                              | Notes                                                   |
| ------------------------- | ----------------------------------------------------- | ------------------------------------------------------- |
| Professional merchant API | `POST https://<api-host>/api/{merchant_id}`           | `merchant_id` is issued by the platform                 |
| Ordinary merchant API     | `POST https://<ethospay-host>/basicapi/{merchant_id}` | `merchant_id` is the ordinary merchant registered email |

All backend APIs use JSON request bodies and `X-Signature` signing. Merchants must keep private keys secure and verify webhooks with the platform public key.

### API Reference

* Professional Merchant API Reference
* Ordinary Merchant API Reference

### Recommended Reading Order

1. Read the Quick Start and identify whether you are integrating as a professional merchant, ordinary merchant, or frontend SDK user.
2. Open the corresponding API or SDK document.
3. Use the API Reference page to verify request fields, response fields, and webhook payloads.
4. Complete request signing, webhook verification, and idempotent processing before launch.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ethosflow.gitbook.io/ethosflow-docs/home.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.