For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create an order

POST /api/v2/orders/create-sell-order

Allows your customer to create an order with the corresponding fiat amount

Headers

Name
Value

Content-Type

application/json

lang

The default will en if this param has been empty.

Supported languages:en|cn|vi

Request Body

Vietnam 🇻🇳

  • VietQR

Example of request data payload

Phillippines 🇵🇭

  • P2P(Pear-to-Pear) QRCode

Example of request data payload
  • P2M(Pear-to-Merchant) QRCode

Example of request data payload

Thailand(Phuket) 🇹🇭

Example of request data payload

Georgia 🇬🇪

Example of request data payload

{ "externalOrderId": "f1a2acc8-c865-44fe-8e6d-d0857ada4d37", "partnerCode": "kaiAlinex", "signature": "I7XDfTngWIraq----J6lN/Aw==", "webhookSecretKey": "81663eae----83636b86b", "currency": "USDT", "fiatAmount": 1, "bankCode": "Georgia QR Pay", "bankAccountNumber": "Georgia QR", "content": "content payment", "userKYCVerified": false, "fiatCurrency": "GEL", "userEmail": "hainguyen250203@gmail.com", "extendInfo": { "qrType": "georgia.customer.k", "GE": { "recipientName": "Demo Merchant", "additionalData": { "infoPayment": "921b43b4d693d90feeb4616dd199286d:273940c3d928b6cc5aa34c87a191dc28a316668ee0249fe2b07c0cc5544aea714de04ea681914ec2f58081195025a5b1" } } } }

Brazil 🇧🇷

Example of request data payload

Argentina 🇦🇷

Example of request data payload

Peru 🇵🇪

Example of request data payload

Nigeria 🇳🇬

Example of request data payload
Name
Type
Condition
Description

partnerCode

string

required

Code of of the partner

userEmail

string

required

The email address from the end-user of your application

userKYCVerified

boolean

true | false

optional

The user's KYC status on your application

currency

string

required

cryptocurrency that you wants to sell. for example: USDT | ETH | BTC

fiatCurrency

string

optional

Supported fiat currencies:

  • VND

  • PHP

  • THB

  • GEL

  • BRL

  • ARS

  • PEN

  • NGN (If the field is empty. Default will be VND)

fiatAmount

number

required

The amount of fiat (VND) the user wants to sell. The minimum value should be:

  • VND 10000 (Sandbox: 50000)

  • PHP: 10

  • THB: 0

  • IDR: 10000

  • GEL: 1

  • BRL: 1

  • ARS: 1

  • PEN: 1

  • NGN: 1

bankCode

string

required

Code of bank

bankAccountNumber

string

required

bank account number wants to send to fiat

content

string

optional

Content of transaction

webhookSecretKey

string

required

It is secret key created by partner dashboard

signature

string

required

  • The signature created with SHA256 by using RSA created private key of partner

  • The public key that has been provided to you during onboarding.

  • The data shall be signed according to the structure: partnerCode|externalOrderId|currency|fiatAmount|bankCode|bankAccountNumber|content|userEmail|secretKey

externalOrderId

string

required

This unique id for order created and managed in partner side. It will keep the update for transaction status after created it

extendInfo

Object

Optional

Only Apply for ScanToPay

The additionalData getting from api get the information of QRCode

Vietnam

"extendInfo": null

Phillipines "extendInfo": {

extendInfo.recipientName

string

Optional

it should be used the tfrName field from the api get the content of QRcode

extendInfo.additionalData

Object

Optional

it should be used the additionalData field from the api get the content of QRcode

qrType

string

qrType

It belong to extendInfo Object and getting from API - VN: "vietqr" - PH: "ph.ppmi.p2m | com.p2pqrpay" - TH: "thailand.pwc" - ID: "qris"

countryCode

string

Optional

the countryCode getting from api get the information of QRCode

  • VN: 🇻🇳

  • PH: 🇵🇭

  • TH: 🇹🇭

  • GE: 🇬🇪

  • BR: 🇧🇷

  • AR: 🇦🇷

  • PE: 🇵🇪

  • NG: 🇳🇬

Response

Signature

  • Partner will digitally sign the transmitted data using SHA256 with RSA algorithm

  • The private key that has been of yours

  • Data shall be signed according to the structure externalOrderId|type|fiatAmount|status|secretKey

How to create and verify the signature

1. Creation

2. Verification

Transaction status

Status name
Description

AWAITING_PAYMENT

The order created successfully. It is waiting

(please wait IPN or manual check with operation)

PAYMENT_COMPLETED

When payment has transferred from AliX Pay to your customer bank account

PROCESSING_TOKEN_TRANSFER

When the token has deducted from your account wallet on AliX Pay

SUCCESS

When an transaction has completed

FAIL

When an transaction has failed with any reasons

ERROR

When an transaction has failed with any reasons

Last updated