Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Card Lifecycle

Update Card

Updates the specified issuing card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

post/v1/issuing/cards/{id}

Path parameters

idstring uuid required
Example:b3d9d2d5-4c12-4946-a09d-953e82sed2b0

Universally unique identifier (UUID v4) of a resource.

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

card_limitnumber

The total credit limit assigned to the card, currency refer to card_currency. This is not a cumulative balance, but a fixed credit limit similar to that of a credit card.

Field behavior by card product:
  • Business Mastercard and Personal Visa: card_limit is required during card creation and must be greater than or equal to 0.01.
  • Business Visa: card_limit is optional.
    • If omitted, the system defaults card_limit to 0.
    • If provided, the value must be greater than or equal to 0, with up to two decimal places. Negative values are not allowed.

See Card products for the full capability matrix.

name_on_cardstring

The cardholder name shown on the card. When the Secure Iframe renders the cardholder name (cardholder_name=true), this value is used as the default; if omitted, the iframe falls back to first_name + last_name from the cardholder record.

no_pin_payment_amountnumber

The allowable amount for card transactions without PIN verification. Default NO-PIN transaction amount applied when not explicitly set by the customer. Defaults to 200 SGD.

If you would like to opt-out from having any transactions without credentials or password, you may adjust the amount to zero (0).

Note: This setting is only applicable to Business Visa. See Card products and No-PIN payments for more information.

metadataMetadata

Any key-value object. Max length = 512 bytes. This must be valid JSON data.

card_art_idstring

Identifier of a card art. Stable across card products; reuse the same value when creating multiple cards with the same design.

Example request

{
  "card_limit": 2100.02,
  "name_on_card": "MARSHALL HU",
  "no_pin_payment_amount": 100,
  "spending_controls": [
    {
      "amount": "100.03",
      "interval": "PER_TRANSACTION"
    }
  ],
  "risk_controls": {
    "enable_3ds": "Y",
    "allow_3ds_transactions": "Y",
    "blocked_mcc": [
      "5999",
      "6011"
    ]
  },
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "card_art_id": "01KD52BKQWDMFF63R1NNQN7A79"
}

Response

Card update successfully.

card_idstring required

Unique identifier for the card.

card_order_idstring required

ID of the card order.

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",
  "card_status": "ACTIVE"
}