# Welcome to Tupay API

##  Onboarding process

### 1. Sign Up. <a href="#sign-up" id="sign-up"></a>

Fill in the [**Signup form**](https://merchants.tupayonline.com/signup) for Tupay.\
We will contact you and approve your Sign Up request.

### 2. Account Creation. <a href="#account-creation" id="account-creation"></a>

As soon as we accept your request to start processing with us, you will receive an email to configure your account in our [STG environment](https://merchants-stg.tupayonline.com/login) .  Activate your STG account.

### 3. Environments. <a href="#environments" id="environments"></a>

Our STG environment is a safe environment you can use to test your integration and any new features you need to test risk-free.

\
Login into our STG Tupay Panel and  Fetch your API credentials by going to **Settings** > **API Access**, read our documentation and start the integration process!

### 4. Integration.

Integrate Tupay  and make sure everything is working smoothly :rocket:

<table data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-type="content-ref"></th><th data-hidden></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center">Technical and Security Aspects</td><td><a href="/pages/JRRfEU5bs2gZnQGC5Gv7">/pages/JRRfEU5bs2gZnQGC5Gv7</a></td><td></td><td><a href="/files/jox9WU9QtqAKnPZQ2dFT">/files/jox9WU9QtqAKnPZQ2dFT</a></td><td><a href="/pages/JRRfEU5bs2gZnQGC5Gv7">/pages/JRRfEU5bs2gZnQGC5Gv7</a></td></tr><tr><td align="center">Deposit Creation Endpoint</td><td></td><td></td><td><a href="/files/XYL5D0pVX25zfuQ9fcmo">/files/XYL5D0pVX25zfuQ9fcmo</a></td><td><a href="/pages/ziG4zmfZt6QzdZyUsI2Z">/pages/ziG4zmfZt6QzdZyUsI2Z</a></td></tr><tr><td align="center">Deposit Status Endpoint</td><td></td><td></td><td><a href="/files/7vXg7WZrjvqQz5EzxIT7">/files/7vXg7WZrjvqQz5EzxIT7</a></td><td><a href="/pages/WXSKDwSOP69n2y00BQ3O">/pages/WXSKDwSOP69n2y00BQ3O</a></td></tr></tbody></table>

### 5. Go Live. <a href="#go-live" id="go-live"></a>

When you have completed the integration process, you will want to start processing,\
to do that, you will need an account in our **Production** environment.

\
You will see a "*Request Go Live*" button over the top right corner on the **Home** of the **STG Tupay Panel**.

\
Proceed to Request Go Live, we will receive your request, review your tests and if everything looks fine, you will receive an email to activate your account in Production​​​ :smile:           &#x20;

&#x20;                                                                                               &#x20;

<figure><img src="/files/OgJfe2BOf0MieCifl0Bi" alt=""><figcaption></figcaption></figure>

### User journey

Send all the required fields :ballot\_box\_with\_check: via API to create a frictionless payment experience for your users and avoid extra steps.<br>

## Postman collection


---

# Agent Instructions: 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://docs.tupayonline.com/english/welcome-to-tupay-api.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.