A card art is the visual design that appears in Apple Wallet when a cardholder adds an Enhanced virtual card to Apple Pay. Each card art has a stableDocumentation Index
Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt
Use this file to discover all available pages before exploring further.
card_art_id that you reference when creating or updating a card.
Every card is issued with exactly one card art. You can:
- List the card arts available to an issuing account.
- Set a default card art so subsequent card-creation calls don’t need to pass
card_art_id. - Override per card by passing
card_art_idon Create Card or Update Card.
Where card art appears
In this release, card art is rendered only in Apple Wallet, and only when both of the following are true:- the cardholder has completed Enhanced KYC — see Enhanced KYC card issuance;
- the cardholder has added their virtual card to Apple Pay.
card_art_id on Create Card / Update Card still succeed for cards outside this surface — the card_art_id is recorded on the card — but the chosen card art only takes visual effect inside Apple Wallet once the conditions above are met.
Default resolution order
When a Create Card or Update Card request omitscard_art_id, the platform resolves the default in this order:
- Account binding — a card art explicitly bound to the issuing account.
- Master account binding — if the issuing account has no binding of its own, the platform falls back to bindings on its master account.
- Channel system default — if neither account has a binding, the platform falls back to the channel’s system-default card art (configured by UQPAY).
card_art_not_configured.
List available card arts
Call List Card Arts to populate your card-art picker before issuing or updating a card. The endpoint takes no query parameters; the issuing account is resolved from your auth token or thex-on-behalf-of header.
is_default marks the card art used when card_art_id is omitted on Create Card. is_system_config marks card arts that come from the channel’s system configuration and are always available to every account on the channel.
Set the default card art
Call Set Default Card Art to change which card art is used whencard_art_id is omitted on Create Card. The new value must be one of the card arts returned by List Card Arts.
Issue a card with a specific card art
Passcard_art_id on the Create Card request to override the default for one card:
Change the card art on an existing card
Passcard_art_id on the Update Card request to change the art on a card that’s already issued:
order_status: PROCESSING, and the new card art takes effect once the channel confirms the change.
Errors
code | When it appears | What to do |
|---|---|---|
card_art_not_available | The card_art_id you sent is not in the account’s available list. | Call List Card Arts to see allowed values, or omit card_art_id to use the default. |
card_art_not_configured | No system default and no binding exists for the channel. | Contact your UQPAY solutions engineer to configure card art for the channel. |
card_art_not_supported | The card product does not support card art selection. | Omit card_art_id, or use a card product that supports card art. |

