Skip to main content
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"
}

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. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

​
x-idempotency-key
string<uuid>
required

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
​
cardholder_id
string<uuid>
required

Unique identifier for cardholder.

Example:

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

​
card_number
string
required

Card number.

Example:

"4096360800133951"

​
card_currency
string
required

The currency assigned to the card.

Example:

"USD"

​
card_mode
enum<string>
required

Card Mode.

Available options:
SINGLE,
SHARE
Example:

"SINGLE"

Response

Assign card successfully.

​
card_id
string
required

Unique identifier for the card.

Example:

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

​
card_order_id
string
required

ID of the card order.

Example:

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

​
create_time
string
required

Create time at which the object was created.

Example:

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

​
card_status
enum<string>
required

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

Available options:
PENDING,
ACTIVE,
FROZEN,
BLOCKED,
CANCELLED,
LOST,
STOLEN,
FAILED
Example:

"ACTIVE"

​
order_status
enum<string>
required

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.
Available options:
PENDING,
PROCESSING,
SUCCESS,
FAILED