Skip to main content
POST
/
v1
/
ramp
/
conversion
Create Conversion
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/ramp/conversion \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --data '
{
  "quote_id": "<string>",
  "sell_currency": "<string>",
  "buy_currency": "<string>",
  "sell_amount": "<string>",
  "buy_amount": "<string>",
  "reason": "<string>"
}
'
{
  "code": 200,
  "message": "Success",
  "data": {
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "short_order_id": "<string>",
    "status": "Submit Failed",
    "sell_currency": "<string>",
    "sell_amount": "<string>",
    "buy_currency": "<string>",
    "buy_amount": "<string>",
    "quote_price": "<string>",
    "processing_fee": "<string>",
    "network_fee": "<string>",
    "order_type": "<string>",
    "reason": "<string>"
  }
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

​
x-idempotency-key
string<uuid>

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Body

application/json
​
quote_id
string
required

Quote ID

​
sell_currency
string
required

Selling currency

​
buy_currency
string
required

Buying currency

​
sell_amount
string

Selling amount (conditional - required if buy_amount not provided)

​
buy_amount
string

Buying amount (conditional - required if sell_amount not provided)

​
reason
string

Transaction remark

Response

Conversion executed successfully

​
code
integer
required
Example:

200

​
message
string
required
Example:

"Success"

​
data
object
required

Response data for Create Conversion (4.3.2)