Fiat to Fiat (Global Payment)

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

Create Order

  • Request Header: Content-Type: application/json

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

  • Request Method: POST

  • Request Path: /v2/order/fiat_to_fiat

  • Authorization Required: Yes

Request Parameters

The request body should include the following parameters:

Parameter
Type
Required
Description

clientId

string

No

Unique identifier for the client

onRampCountry

string

Yes

Name of the country (e.g., "Mexico")

onRampMerchantId

number

No

ID of the merchant

onRampFiat

string

Yes

Name of the fiat currency (e.g., "MXN")

onRampFiatAmount

decimal

Yes

Amount of fiat currency to convert (e.g., 1000.00)

number

Yes

ID of the payment method

offRampCountry

string

Yes

Name of the country (e.g., "Mexico")

offRampMerchantId

number

No

ID of the merchant

offRampFiat

decimal

Yes

Name of the fiat currency (e.g., "MXN")

number

Yes

ID of the payment method

remark

string

No

Additional remarks for the order

Request Example


{
    "clientId": "xxxx",
    "onRampCountry": "Mexico",
    "onRampMerchantId": 12345,
    "onRampFiat": "MXN",
    "onRampFiatAmount": 1000.00,
    "onRampPaymentId": 91,
    "offRampCountry": "HONGKONG",
    "offRampMerchantId": 54321,
    "offRampFiat": "USD",
    "offRampPaymentId": 77,
    "remark": ""
}

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 merchantId 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.

Last updated