Create a Fiat to Crypto Order

This section provides information about the fiat to crypto on-ramp process, allowing users to convert fiat currency into cryptocurrency through the API.

Create Order

• Request Header: X-BH-TOKEN: ******

• Request Header: Content-Type: application/json

• Request Method: POST

• Request Path: /v2/order/fiat_to_crypto

• Authorization: Required

Request Parameters

The request body should include the following parameters:

Parameter	Type	Required	Description
country	string	Yes	Name of the country (e.g., "Mexico")
clientId	string	No	An order ID that you may define and will be returned to you in a Get Order call.
merchantId	number	No	ID of the merchant
crypto	string	Yes	Name of the cryptocurrency (e.g., "USDT")
fiat	string	Yes	Name of the fiat currency (e.g., "MXN")
fiatAmount	decimal	No	Place the order in fiat currency or choose from cryptoAmount. Amount of fiat currency to convert (e.g., 1000.00)
cryptoAmount	decimal	No	Place the order in crypto format, or choose from fiatAmount. Amount of crypto currency to convert (e.g., 1000.00)
paymentId	number	Yes	ID of the payment method
remark	string	No	Additional remarks for the order
depositAlias	string	No	Alias of the virtual account
quoteId	string	no	QuoteId of the price

Request Example

{
    "country": "Mexico",
    "clientId": "xxxx",
    "merchantId": 3,
    "crypto": "USDT",
    "fiat": "MXN",
    "fiatAmount": 1000.00,
    "paymentId": 63,
    "remark": "",
    "depositAlias": "tom_alias",
    "quoteId": "e46836d68a4a4a6f8f2f609352cffb2f"
}

Response Parameters

The response will contain the following parameters:

Parameter	Type	Description
code	number	Response status code (e.g., 200)
msg	string	Response message (e.g., "SUCCESS")
data	object	Contains order details
data.orderId	number	ID of the created order

Response Example

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "orderId": 1123123123
    }
}

Notes

• Ensure to provide valid parameters for successful order creation.

• The settingsId and paymentId must correspond to existing merchant and payment method configurations.

• The response will confirm the successful creation of the order along with the order ID for tracking.