> For the complete documentation index, see [llms.txt](https://aliniex.gitbook.io/alix-pay/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://aliniex.gitbook.io/alix-pay/guides/on-off-ramp-service/api-integration.md).

# API Integration

Welcome to the Alix Pay  B2B API documentation! This API is currently in the **pre-launch phase**, providing the essential information you need to get started with integrating our services.

In this version, we've included key features to support:

1. On-ramp transactions: Buy cryptocurrency using fiat currency
2. Off-ramp transactions: Sell cryptocurrency and withdraw fiat currencies
3. Customer data management
4. Market information retrieval

**How to Integrate**\
To start using our API, follow these steps:

1. Contact our support team to request your initial **Merchant key**(partner code) and **secret key**.
2. Use the provided API key to authenticate requests.
3. Signature verification for request and response. Please refer [here](/alix-pay/api-reference/introduction/digital-signature.md) for more details
4. Start sharing your customer data via the /merchant/customers endpoint.
5. Use on-ramp or off-ramp endpoints to create orders and track their status.

**Important Notes**

1. This environment is still under development, and breaking changes may occur.
2. Payment confirmations in the playground environment are simulated.
3. Do not use the playground environment for real transactions.

For API key requests and further inquiries, please contact our support team at <support@alixpay.com>

## [On ramp](/alix-pay/api-reference/on-off-ramp-api/on-ramp.md)

We are supporting the fiat currencies:

* VND :flag\_vn:
* PHP :flag\_ph:
* IDR :flag\_id:

We are supporting the crypto currencies:

* TBD

## [Off ramp](#off-ramp)

We are supporting the fiat currencies:&#x20;

* VND :flag\_vn:
* THB :flag\_th:
* PHP :flag\_ph:
* IDR :flag\_id:

We are supporting the crypto currencies:

* TBD

## Environments for integration

<table data-header-hidden><thead><tr><th width="187">Environment</th><th>Method</th><th>Url</th></tr></thead><tbody><tr><td></td><td></td><td></td></tr><tr><td>Sandbox</td><td>POST</td><td>https://sandbox.alixpay.com</td></tr><tr><td>Production</td><td>POST</td><td>https://api.alixpay.com</td></tr><tr><td></td><td></td><td></td></tr></tbody></table>

## Postman API collection

{% file src="/files/UvFANyTRaoahNTZRCvAg" %}


---

# 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://aliniex.gitbook.io/alix-pay/guides/on-off-ramp-service/api-integration.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.