GuidesAPI ReferenceChangelog
Log In
API Reference

Create Card

post
https://api-sandbox.uqpaytech.com/api/v1/issuing/cards

Creates a virtual card and issues it to the specified cardholder.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
≥ 0

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 BIN:

  • For the following BINs, card_limit is required during card creation and must be greater than or equal to 0.01:

    • 527735
    • 555071
    • 555243

  • For all other BINs, card_limit is optional:

    • If omitted, the system will default 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.
string
enum
required

The card currency. For example USD or SGD.

Allowed:
uuid
required

The cardholder’s unique identifier.

string
required

The card product's unique identifier.

spending_controls
array of objects

Rules that control spending for this card.

spending_controls
risk_controls
object

User-customized risk control settings.

Supported configurations depend on the card BIN. See Supported BINs for Risk Control Configurations for details.

metadata
object

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

string
enum
Defaults to NORMAL

Indicates whether the card is a standard reusable card or a one-time-use card.

  • NORMAL - A standard card that can be used for multiple transactions.
  • ONE_TIME - A one-time-use card that is automatically cancelled after the first transaction event defined by auto_cancel_trigger.
Allowed:
string
enum

Defines the transaction event that triggers automatic cancellation of a ONE_TIME card. Required when usage_type is ONE_TIME.

  • ON_AUTH - The card is cancelled immediately after the first authorization is approved. Subsequent authorization requests on the same card will be declined.
  • ON_CAPTURE - The card is cancelled after the first transaction's capture (settlement) succeeds, allowing a full authorization and capture cycle to complete.
Allowed:
date-time

The absolute expiry date and time of the card. If the card has not been cancelled by a first-transaction event before this time, it is automatically cancelled and any unused balance is released.

cardholder_required_fields
object

Supplementary cardholder KYC information provided at card creation time to fulfill the product's required_fields.

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

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.

Responses

Updated 8 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago