Skip to main content
POST
/
v1
/
ramp
/
transfer
Create Transfer
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/ramp/transfer \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --data '
{
  "currency": "USD",
  "amount": "100.50",
  "type": 4001,
  "reason": "Business transfer"
}
'
{
  "code": 200,
  "message": "Success",
  "data": {
    "order_id": "3c9e22ba-7b5e-4b7c-b92e-197d0406b86b",
    "short_order_id": "TO260123-JZBHC9IA",
    "order_status": "Pending",
    "order_type": "Transfer Out",
    "amount": 100,
    "currency": "USD",
    "processing_fee": 0,
    "create_time": "2026-01-23 13:12:27 +08:00",
    "reason": "testAPI",
    "complete_time": "",
    "message": "<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
​
currency
string
required

Wallet currency for this transfer out/in

Example:

"USD"

​
amount
string
required

Amount for this transfer out/in

Example:

"100.50"

​
type
integer
required

Transfer out: 4001; Transfer in: 4000

Example:

4001

​
reason
string

Transaction remark

Example:

"Business transfer"

Response

Transfer created successfully

​
code
integer
required
Example:

200

​
message
string
required
Example:

"Success"

​
data
object
required

Create Transfer response (section 4.2.1)