跳转到主要内容
POST
/
v1
/
transfer
Create Transfer
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/transfer \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "source_account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
  "target_account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
  "currency": "USD",
  "amount": "1000",
  "reason": "Transfer"
}
'
{
  "transfer_id": "e08146de-4267-4e76-b35b-f7b34b656a53",
  "short_reference_id": "P220406-LLCVLRM"
}

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-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
source_account_id
string
必填

A unique identifier of the account.

示例:

"f5bb6498-552e-40a5-b14b-616aa04ac1c1"

target_account_id
string
必填

A unique identifier of the account.

示例:

"f5bb6498-552e-40a5-b14b-616aa04ac1c1"

currency
string
必填

Currency code ISO 4217 for the transfer.

示例:

"USD"

amount
string
必填

The amount to transfer.

示例:

"1000"

reason
string
必填

The reason for the transfer.

示例:

"Transfer"

响应

200 - application/json

Transfer creation successfully.

transfer_id
string
必填

Unique identifier for the created transfer.

示例:

"e08146de-4267-4e76-b35b-f7b34b656a53"

short_reference_id
string
必填

System-generated short reference for the transfer.

示例:

"P220406-LLCVLRM"