跳转到主要内容
POST
/
v1
/
issuing
/
cards
/
assign
Assign Card
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/issuing/cards/assign \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "cardholder_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
  "card_number": "4096360800133951",
  "card_currency": "USD",
  "card_mode": "SINGLE"
}
'
{
  "card_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7",
  "card_order_id": "c0cef051-29c5-4796-b86a-cd5ee34bfad7",
  "create_time": "2024-03-21T17:17:32+08:00",
  "card_status": "ACTIVE",
  "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.

请求体

application/json
​
cardholder_id
string<uuid>
必填

Unique identifier for cardholder.

示例:

"5135e6cc-28b6-4889-81dc-3b86a09e1395"

​
card_number
string
必填

Card number.

示例:

"4096360800133951"

​
card_currency
string
必填

The currency assigned to the card.

示例:

"USD"

​
card_mode
enum<string>
必填

Card Mode.

可用选项:
SINGLE,
SHARE
示例:

"SINGLE"

响应

200 - application/json

Assign card 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"

​
create_time
string
必填

Create time at which the object was created.

示例:

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

​
card_status
enum<string>
必填

Card status enum. See the Card lifecycle and statuses guide for more information.

可用选项:
PENDING,
ACTIVE,
FROZEN,
BLOCKED,
CANCELLED,
LOST,
STOLEN,
FAILED
示例:

"ACTIVE"

​
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