Skip to main content
GET
List Card Arts

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

x-on-behalf-of
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 endpoint. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Query Parameters

product_id
string<uuid>

Filter the results to the card arts available for this card product. Omit to return all card arts available to the account.

Example:

"467e993f-317a-49fc-9ea0-bf49de7d1f76"

Response

200 - application/json

Card arts retrieved successfully.

default_card_art_id
string
required

The issuing account's current default card art. A Create Card call that omits card_art_id uses this value.

Example:

"01KD52BKQWDMFF63R1NNQN7A79"

card_arts
object[]
required

Card arts available to the issuing account, ordered with the default first, then system-configured arts, then account-bound arts.