> For the complete documentation index, see [llms.txt](https://api-docs.qattahpay.sa/qattah-payment-public-api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.qattahpay.sa/qattah-payment-public-api-documentation/welcome.md).

# Welcome!

## Intro

This document describes Qattah Pay API to create new Qattah for end-users and receive the payment status events. This API is used by Qattah Pay partners to benefit from Qattah Pay splitting orders' payments into multiple invoices for multiple users.

Qattah Pay provides an endpoint for creating a new Qattah when the end-user chooses Qattah Pay as the payment method. The request will redirect the user to a hosted session at Qattah Pay to finalize the splitting and payment cycles, and then the Qattah Pay partner will receive the payment status event. This event is performed asynchronously.

The payment status event coming from the Qattah Pay server is sent to an endpoint provided by the Qattah Pay partner. Routing the end-user to the after-payment step is then ensured by the partner.<br>

<figure><img src="/files/3Fb9y1jijYDJfNcO1rAb" alt=""><figcaption></figcaption></figure>

## Want to jump right in?

Feeling like an eager beaver? Jump into the quick start docs and get making your first request:

{% content-ref url="/pages/qS52ciZ57Ldz9sjPCIOZ" %}
[Quick Start](/qattah-payment-public-api-documentation/quick-start.md)
{% endcontent-ref %}

## Want to take a journey?

Let's take a journey with your end-user to know where he will go, how he will split, and when he will get back to you.

Also, you have another joiner to the journey, the merchant admin user who will manage, analyze and monitor the Qattah Pay Orders using the Merchant Admin Dashboard.

{% content-ref url="/pages/9wNDPgImZFNmT3Gdn42O" %}
[User flows](/qattah-payment-public-api-documentation/user-flows.md)
{% endcontent-ref %}

## Want to deep dive?

Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with the API:

{% content-ref url="/pages/Uv6JzQsd8M0QBPkyDQsA" %}
[API Reference](/qattah-payment-public-api-documentation/reference/api-reference.md)
{% endcontent-ref %}

## Want a sample code?

Directly go to the point by investigating the sample code that we developed to help Android and iOS developers understand the data flow better.

{% content-ref url="/pages/m68YD69wEI8pns4Sl4xk" %}
[Sample code](/qattah-payment-public-api-documentation/reference/sample-code.md)
{% endcontent-ref %}


---

# 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, and the optional `goal` query parameter:

```
GET https://api-docs.qattahpay.sa/qattah-payment-public-api-documentation/welcome.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.