Physical cards are pre-manufactured and shipped to you or your cardholders. Unlike virtual cards, each physical card must be assigned to a cardholder and then activated before it can be used for transactions.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.
Prerequisites
- A cardholder with
cardholder_status: SUCCESS— see Create cardholders - A physical card number (provided by UQPAY as part of your card inventory)
- Sufficient issuing balance if using a Single mode product
Step 1: Assign the card
Call the Assign Card endpoint to link a physical card to a cardholder.- A
card.activation.codewebhook delivers the activation code. - A
card.create.succeededwebhook confirms the card was assigned. The card remains inPENDINGstatus until activated.
The activation code does not expire.
Step 2: Receive the activation code
Subscribe to thecard.activation.code webhook to receive the activation code programmatically.
Step 3: Activate the card
Call the Activate Card endpoint with the activation code and a 6-digit PIN.card.activation.status webhook fires and an email confirmation is sent.
PENDING to ACTIVE. The card is now ready for transactions, including ATM withdrawals (for eligible BINs).
Reset PIN
You can change the card PIN at any time using the Reset Card PIN endpoint. The result is returned synchronously — no webhook is triggered.Related
- Core concepts — Virtual vs. physical, Single vs. Share
- Card lifecycle — Freeze, unfreeze, or cancel cards
- Assign Card API
- Activate Card API
- Activation Code webhook
- Activation Status webhook

