API v2 (legacy)
This is the partner API AliX Pay shipped before v3. It is still live and still supported — if you integrated before v3 existed, this is the API you are calling, and nothing here is being switched off underneath you.
It is also frozen: no endpoint will be added to v2. If you are integrating today, build on v3 instead: it has a simpler auth model, a saner error contract, and it is where new services land.
These pages are written from the running code, not from the API's history. Where the older published docs and the server disagree, the server wins and the difference is called out.
What it does
The same two things v3 does. You hold a crypto fund with AliX; the API turns that fund into fiat payouts.
| Service | Use it to |
|---|---|
| Scan-to-Pay | Let your user pay a merchant by QR code. Decode the QR, quote it, pay it. |
| Cashout | Pay fiat out to a recipient's bank account directly. |
Around those sit authentication, the KYC that gates them, and your fund's balance. Payouts settle asynchronously and tell you the outcome by webhook.
How v2 differs from v3
If you know v3, read this table before anything else. Almost every row is a place where an assumption carried over from v3 will silently break.
| v2 | v3 | |
|---|---|---|
| Path prefix | /api/v2 | /v3 |
| Authentication | An RSA signature in every request body. No token. | A bearer access token, obtained once per hour. |
| Response envelope | success, message, data, errorCode, semanticCode | code, message, data |
| Error contract | semanticCode (string). The numeric errorCode is legacy. | code (string) |
| HTTP status | Not meaningful — a business error still returns 201. | Meaningful: 400, 401, 404, 409… |
| Responses signed | Yes — every success carries a signature you can verify. | No. |
| Webhook signature | A field inside the body. | The X-Alix-Signature header. |
| Order status | AWAITING_PAYMENT, PAYMENT_COMPLETED, PROCESSING, SUCCESS, ERROR | PROCESSING, SUCCESS, FAILED |
| Timestamps | 2026-07-14 10:32:07 — UTC+7, no zone marker. | ISO-8601 in UTC. |
There is also no API Explorer for v2, and there never will be. Every v2 request is signed with your RSA private key over a canonical string, so a live "try it" client in a browser would need you to paste that private key into a documentation page. The reference pages carry the full field tables instead.
Where to start
- Quick start — an end-to-end integration: verify your account, sign a request, onboard a user, quote, create an order, settle it.
- API Reference — the signing scheme, the response envelope, every error code, and the full request and response tables for all 16 endpoints.
Build against https://sandbox.alixpay.com first.