跳转到主要内容
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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers-sandbox.uqpaytech.com/llms.txt

Use this file to discover all available pages before exploring further.

授权

​
x-auth-token
string
header
必填

The API token for login provided by UQPay.

请求头

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

请求体

application/json
​
currency
string
必填

Wallet currency for this transfer out/in

示例:

"USD"

​
amount
string
必填

Amount for this transfer out/in

示例:

"100.50"

​
type
integer
必填

Transfer out: 4001; Transfer in: 4000

示例:

4001

​
reason
string

Transaction remark

示例:

"Business transfer"

响应

200 - application/json

Transfer created successfully

​
code
integer
必填
示例:

200

​
message
string
必填
示例:

"Success"

​
data
object
必填

Create Transfer response (section 4.2.1)