Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update card metadata

Tokenization Service provides the UpdateCard API to update or override a card profile’s metadata.

The issuer backend typically uses this API when it needs to update how a card appears in xPay Wallets.

What card metadata is used for

Card metadata is information used by xPay Wallets, for example:

  • Display card details (for example, the card program name).

  • Configure endpoints for transaction notifications and history.

  • Show issuer application contact details and links.

Send the metadata fields in the metadata object of the request body.

Example request body:

{
  "issuerCardRefId": "string",
  "metadata": {
    "foregroundColor": "rgb(223355)",
    "backgroundColor": "rgb(223355)",
    "labelColor": "rgb(223355)",
    "shortDescription": "ACME Gold Card",
    "longDescription": "ACME Bank Gold card",
    "contactWebsite": "https://acme.com/contacts",
    "contactEmail": "contacts@acme.com",
    "contactNumber": "+33645878741",
    "privacyPolicyURL": "https://acme.com/contacts"
  }
}
UpdateCard request example with card metadata fields.
PreviousReplace or renew a card
NextToken Life Cycle Management

Last updated

Was this helpful?