Skip to main content

Get Card Metadata

This method is used to retrieve metadata for a credit card. This metadata includes card art, issuer information, card metadata and token metadata. This request fetches the most up-to-date metadata for the card from the issuing bank. This method can be used by passing in a TokenEx token that has an existing network token associated with it.

Required API Key Permissions: NetworkTokenizationGeneralAccess

Request Headers: Authentication and Authorization

* denotes a required field
HTTP Request HeaderDescription
tx-tokenex-id*Like a username, this ID logically segments your tokenized data.
tx-apikey*Controls your access to individual functions in the API

Request Body Parameters:

ParameterDescription
tokenThe TokenEx token that represents the PAN and has an associated network token.
tokenReferenceIdIf there is more than one network token stored for that token, indicate which network token to use for this operation.

Response Body Parameters:

ParameterTypeDescription
successboolIndicator if the request was successfully processed by TokenEx.
referenceNumberstringTokenEx reference number for the transaction.
errorstringTokenEx Error Code and human readable description.
messagestringHuman readable message about response from TokenEx.
networkResponse.messageIdstringUnique message identifier (GUID format), generated per response.
networkResponse.conversationIdstringMessage identifier assigned for the entire conversation (GUID format).
networkResponse.statusCodestringThe four-digit status code.
networkResponse.statusMessagestringHuman readable comments about the status. Null on success.
networkResponse.encData.cardData.paymentAccountReferencestringGlobally unique reference of a cardholder’s PAN. It is commonly abbreviated as PAR.
networkResponse.encData.cardData.cardSuffixstringThe last four digits of the real PAN.
networkResponse.encData.cardData.panExpDatestringThe expiry date of the real PAN. The format is 'YYMM'.
networkResponse.encData.cardData.coBrandedboolIt indicates if the card is a co-branded card.
networkResponse.encData.cardData.coBrandNamestringThe card co-brand name. It is required if isCoBranded is set to true.
networkResponse.encData.cardData.expDataPrintedboolIt indicates if the expiration date is printed on the card or not.
networkResponse.encData.cardData.cvv2PrintedboolIt indicates if the cvv2 is printed on the card or not.
networkResponse.cardMetadata.termsAndConditionsUrlstringURL describing the terms and conditions.
networkResponse.cardMetadata.cardArtUrlstringURL of the card art image.
networkResponse.cardMetadata.cardForegroundColorstringThe foreground color of the card, as a CSS RGB value.
networkResponse.cardMetadata.issuerData.issuerNamestringThe name of the card issuer.
networkResponse.cardMetadata.issuerData.issuerEmailstringThe customer service email address of the issuer.
networkResponse.cardMetadata.issuerData.issuerWebsitestringThe customer service website of the issuer.
networkResponse.cardMetadata.issuerData.customerServiceTelephonestringThe customer service phone number of the issuer.
networkResponse.cardMetadata.cardAssets[].guidstringUnique identifier (GUID format) of the asset.
networkResponse.cardMetadata.cardAssets[].assetTypestring enumThe type of asset. Possible values: COMBINED_BACKGROUND, ICON_ISSUER, ICON_BRAND, ICON
networkResponse.tokenMetadata.tokenSuffixstringThe last four digits of the token value. Null when the token number is 12 digits or fewer.
networkResponse.tokenMetadata.tokenExpDatestringThe expiry date of the token. The format is 'YYMM'.
POST /v2/NetworkToken/GetCardMetadata HTTP/1.1
Host: test-api.tokenex.com
tx-apikey: YourAPIKey
tx-tokenex-id: YourTokenExID
Content-Type: application/json

{
"token": "476120FDallZ7718",
"tokenReferenceId": "749f4d0d-4005-443e-9a66-0ea2d317b8f6"
}