Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Card Lifecycle

Assign Card

Assign a physical card or bulk created virtual card to a cardholder.

post/v1/issuing/cards/assign

Headers

x-on-behalf-ofstring

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

Request body

cardholder_idstring uuid required

Unique identifier for cardholder.

card_numberstring required

Card number.

card_currencystring required

The currency assigned to the card.

card_mode'SINGLE' | 'SHARE' required

Card Mode.

Example request

{
  "cardholder_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
  "card_number": "4096360800133951",
  "card_currency": "USD",
  "card_mode": "SINGLE"
}

Response

Assign card successfully.

card_idstring required

Unique identifier for the card.

card_order_idstring required

ID of the card order.

create_timestring date/time required

The timestamp when the record was created in the system. Timestamp follows the ISO 8601 standard.

card_status'PENDING' | 'ACTIVE' | 'FROZEN' | 'BLOCKED' | 'PRE_CANCEL' | 'CANCELLED' | 'LOST' | 'STOLEN' | 'FAILED' required

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

  • PENDING: The request to create the card has been received and is under review.
  • ACTIVE: The request to create the card was successful and the card is ready to use.
  • FROZEN: All incoming authorization requests will be declined. The card can be reactivated to accept new authorizations.
  • BLOCKED: The card was blocked by UQPAY due to suspicious activity.
  • PRE_CANCEL: The card is scheduled for cancellation and is in a waiting period during which all incoming authorization requests are declined. It transitions to CANCELLED when the waiting period ends.
  • CANCELLED: The card cannot be reactivated from this state, all incoming authorization requests will be permanently declined.
  • LOST: The card has been reported as lost to UQPAY.
  • STOLEN: The card has been reported as stolen to UQPAY.
  • FAILED: The request to create a card using Create Card failed.
order_status'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' 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.

Example response

{
  "card_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7",
  "card_order_id": "c0cef051-29c5-4796-b86a-cd5ee34bfad7",
  "create_time": "2024-03-01T00:00:00+08:00",
  "card_status": "ACTIVE"
}