Introduction

This API is used to create orders.

Merchants must provide outbound IP address to ACH before going live to avoid network blocking. Any changes must be reported to ACH in advance.

API Description

Request Method: POST

Request Path: /open/api/v4/merchant/order/create

Request Parameters

Header Parameters:

Parameter	Required	Type	Description
access-token	Y	string	Token for no-login access, obtained from the no-login token API
appid	Y	string	Unique identifier for the application
timestamp	Y	string	Current UTC 13-digit timestamp, valid for 5 minutes
sign	Y	string	Signature, refer to here

Body Parameters:

Parameter	Required	Type	Description
side	Y	string	onramp: BUY / offramp: SELL
merchantOrderNo	Y	string	Custom order number from the merchant; the merchant guarantees that the order number is unique.
amount	Y	string	onramp: Amount in fiat currency, unit in yuan; must control the number of decimal places according to fiat precision; precision of 0 means integer, precision of 2 means two decimal places. check: fiat currency and payment method. offramp: Amount of crypto being ordered.
fiatCurrency	Y	string	Name of the fiat currency, e.g., `USD`/`EUR` Check more *Fiat currencies INR, CLP, COP, HUF, IDR, JPY, KRW, VND do not support inputting decimal points.
alpha2	N	string	Required for offramp Follow the ISO 3166-1 alpha-2 standard. The country code corresponding to the fiat currency. Example: fiat: EUR → country: DE fiat: USD → country: US
cryptoCurrency	Y	string	Crypto name, type in capital letter Example:USDT
orderType	Y	string	onramp: 4 / offramp: 6
address	N	string	Required for onramp; the address for the user to receive cryptocurrency
network	Y	string	Crypto receiving network: e.g., ETH/BSC/BTC
payWayCode	Y	string	Payment method code(credit card:10001, apple pay:501, google pay:701); specific values can be referenced from the payment method form query
userAccountId	N	string	User userAccountId obtained from the form submission interface
redirectUrl	Y	string	onramp: Redirect address after payment process *Must be less than 256 characters.
callbackUrl	Y	string	Callback address
memo	N	string	To be filled according to network or platform requirements.Please refer Click Here
extendParams	N	object	Required for credit card/ googlepay/ applepay/Bancontact/EPS/Ideal/BLIK. For details on how to obtain, refer to Get cookie for credit card payment Check the table below.
clientIp	Y	string	User's IP

①Credit Card/ Applepay/ Googlepay extendParams

extendParams	Required	Type	Description
└─channelCookie	N	string	Channel Cookie
└─ cookie	N	string	Risk Control Cookie
└─ birthday	Y	string	User birthday, yyyy-mm-dd

②Bancontact/EPS/Ideal/BLIK extendParams

extendParams	Required	Type	Description
└─ birthday	Y	string	User birthday, yyyy-mm-dd
└─firstName	Y	string	User First Name. Only English letters (A–Z, a–z) are supported. Spaces and special characters are not allowed. If the user has a Middle Name, it should be omitted.
└─lastName	Y	string	User Last Name. Only English letters (A–Z, a–z) are supported. Spaces and special characters are not allowed.

③European citizens extendParams

extendParams	Required	Type	Description
└─taxResidency	N	string	Tax residency country (ISO 3166-1 alpha-2 country code, e.g. DE, FR, IT). Required for European citizens only. Supported from July onwards.
└─tin	N	string	Tax Identification Number (TIN) issued by a European country. Required for European citizens only. Supported from July onwards.

Request Parameter Example (Credit Card/ Applepay/ Googlepay):

{
    "side": "BUY",
    "merchantOrderNo": "test1768981546000",
    "cryptoCurrency": "USDC",
    "address": "0x1a6e411acdexxxxxxxxe0df43836563",
    "network": "BSC",
    "memo": "", //Optional
    "fiatCurrency": "USD",
    "amount": "2",
    "orderType": "4", // Fixed to 4
    "payWayCode": "10001",
    "extendParams": {
        "birthday": "2000-12-07",
        "cookie": "15cf7cxxxxxxxxxa83d1e749fecf577",
        "channelCookie": "dsid_rxxxxxxxxxwwmzbmbxxdy",
        "taxResidency": "DE",
        "tin": "12345678901"
    },
    "clientIp": "111.111.111.31",
    "userAccountId": "11111", // Optional, must fill in for card payment and account
    "redirectUrl": "https://www.xxxxxxx.com",
    "callbackUrl": "https://xxxxxxxxx/v1/index"
}

Response Parameter Example (Credit Card/ Applepay/ Googlepay):

{
    "success": true,
    "returnCode": "0000",
    "returnMsg": "SUCCESS",
    "extend": "",
    "data": {
        "orderNo": "onramp100001",
        "webUrl": "https://www.google.com"
    }
}

Response Parameter Example (onramp-QRIS):

{
    "success": true,
    "returnCode": "0000",
    "returnMsg": "SUCCESS",
    "extend": "",
    "data": {
        "orderNo": "1393135310930825216",
        "qrCode": "00020101021226610016ID.CO.SHOPEE.****"
    },
    "traceId": "6870c056ee9707c8bcbad2adf87ddda3"
}

Response Parameter Example (onramp-VA):

{
    "success": true,
    "returnCode": "0000",
    "returnMsg": "SUCCESS",
    "extend": "",
    "data": {
        "orderNo": "1393135564782686208",
        "bankName": "VA BRI",
        "accountNumber": "13033***"
    },
    "traceId": "6870c0931309ecd3e4d7f2ffc2f4b456"
}

Response Parameter Example (onramp-PayID):

{
    "success": true,
    "returnCode": "0000",
    "returnMsg": "SUCCESS",
    "extend": "",
    "data": {
        "orderNo": "1393139009753305088",
        "referenceNumber": "522***",
        "payId": "[email protected]"
    },
    "traceId": "6870c3c88dd61f975f3359b54ad54fb2"
}

Response Parameter Example (onramp-Australian Bank Transfer):

{
    "success": true,
    "returnCode": "0000",
    "returnMsg": "SUCCESS",
    "extend": "",
    "data": {
        "bsb": "840400",
        "orderNo": "1391991764944924672",
        "accountName": "Company Name",
        "referenceNumber": "51***",
        "accountNumber": "3***"
    },
    "traceId": "686c974d716f830d85325fb6f44da9a7"
}

Request Parameter Example (offramp):

{
    "side": "SELL",
    "merchantOrderNo": "mer100001",
    "cryptoCurrency": "USDT",
    "network": "ETH",
    "amount": "123.123", // Quantity of crypto being sold
    "alpha2": "US",
    "fiatCurrency": "USD",
    "payWayCode": "10001",
    "userAccountId": "12312",
    "orderType": 6, // Fixed to 6
    "callbackUrl": "http://payment.jyoumoney.com/alchemyRamp/pay/callback?tradeNo=***"
}

Response Parameter Example (offramp):

{
    "success": true,
    "returnCode": "0000",
    "returnMsg": "SUCCESS",
    "extend": "",
    "data": {
        "orderNo": "139***",
        "receivedAddress": "0xcbca***"
    }
}