跳转到主要内容
POST
/
v1
/
issuing
/
cards
/
{id}
/
withdraw
Card Withdraw
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/issuing/cards/{id}/withdraw \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "amount": 100.02
}
'
{
  "card_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7",
  "card_order_id": "c0cef051-29c5-4796-b86a-cd5ee34bfad7",
  "order_type": "CREATE_CARD",
  "amount": 100.02,
  "card_currency": "USD",
  "create_time": "2024-03-21T17:17:32+08:00",
  "update_time": "2024-03-21T17:17:32+08:00",
  "complete_time": "2024-03-21T17:17:32+08:00",
  "order_status": "PENDING"
}

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

路径参数

​
id
string<uuid>
必填

Universally unique identifier (UUID v4) of a resource.

示例:

"71fdb0fe-9682-457a-9361-e8868694f12f"

请求体

application/json
​
amount
number
必填

Recharge or withdraw amount for this card.

必填范围: x > 0
示例:

100.02

响应

200 - application/json

Card withdraw successfully.

​
card_id
string
必填

Unique identifier for the card.

示例:

"c0cef051-29c5-4796-b86a-cd5b684bfad7"

​
card_order_id
string
必填

ID of the card order.

示例:

"c0cef051-29c5-4796-b86a-cd5ee34bfad7"

​
order_type
enum<string>
必填

The order type.

可用选项:
CARD_CREATE,
CARD_RECHARGE,
CARD_WITHDRAW,
CARD_UPDATE
示例:

"CREATE_CARD"

​
amount
number
必填

Recharge or withdraw amount for this card.

必填范围: x > 0
示例:

100.02

​
card_currency
enum<string>
必填

The card currency.

可用选项:
SGD,
USD,
XUSD
示例:

"USD"

​
create_time
string
必填

Create time at which the object was created.

示例:

"2024-03-21T17:17:32+08:00"

​
update_time
string
必填

Updated time at which the object was created.

示例:

"2024-03-21T17:17:32+08:00"

​
complete_time
string
必填

Completed time at which the object was created.

示例:

"2024-03-21T17:17:32+08:00"

​
order_status
enum<string>
必填

This field will contain the status of the request after processing.

  • PENDING -The initial status of the order request.
  • PROCESSING - If this status shall be subject to webhooks notification.
  • SUCCESS - The final status of the order request is successful.
  • FAILED - The final status of the order request is failed.
可用选项:
PENDING,
PROCESSING,
SUCCESS,
FAILED