On This Page

Retrieve Network Token Payment Credentials

This section describes how to retrieve network token payment credentials such as:

Network token value

Cryptogram (Visa and Mastercard only)

Dynamic card verification value (CVV) (American Express only)

Network token payment credentials are returned as a JSON web encryption (JWE) response.

Prerequisites

You must have the payment credentials service enabled for the TMS vault from which the network token is retrieved. For information on how to enable the payment credentials service, see Token Vault Management.

You must have a message-level encryption (MLE) key from the Smartpay Fuse Portal to retrieve network token data. For information on how to create an MLE key, see Message-Level Encryption Keys.

Endpoint

Test:

POST https://api.smartpayfuse-test.barclaycard/tms/v2/tokens/{tokenId}/
payment-credentials

Production:

POST https://api.smartpayfuse.barclaycard/tms/v2/tokens/{tokenId}
/payment-credentials

The {tokenId}
is the token ID returned in the

field when you created the customer, payment instrument or instrument identifier token. See Create an Instrument Identifier for more information.

REST Example: Retrieving Network Token Payment Credentials

Request

POST https://api.smartpayfuse-test.barclaycard/tms/v2/tokens/7040890000006625091/payment-credentials

Response to a Successful Request: BASE 64

JraWQiOiI5OWY5YmVjOTlmMzQ1MDJmMDE2NWIyYmJhYWYyODAxNDNhOTI0OWNjIiwiY3R5IjoianNvbiIsInR5cCI6IkpXVCIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.uYCE2zysWJB8E562FGJl4YyotZEHw4Az-2fvhjaUWubuAZ2tmZm44oKUdsfsBLYWInxpMDUsiENTTHG_UJJ25Snhcft6eZGj79gW_S55ZAGAi1eYIJA08gr01U7P-1QIzQ5t6dlkTRZElYDiNjypSaVfQPQPODaGNfB04Li7Pt88i-PIspGafq9P7TgacPyKoIkvM5CwLWbwSZYN_jdFq8hEu4Dy7gqDpf0z-rCdtWggWpFbGwdurDrKCbLBoQ4dY7OckJoe2OOWH-O1h_7uZymDDUjnqWFRcHgjxY7bmWJz94i_r4QUaoTQiaaqgyP6A2H3Gmt6Dy4VpIzO2XgLQA._cLex9BPstYqqnfe.RMbdjAqWR6HaVZ7USbp6j-KWPC1jGc3Wzk4M_CwJ58X2NNZ5ekUpAvU28_MbqQ2W6MLhJ7ulgfU5mk9_Y5nvAW6Yh68Ctye2yOhgu_V_33aLmz3iZP5AEGi7HeJVng0hy4EaQHNb92XYXUV1mvFHJokA4cRaj3eKwh6v-1lRhB4uIgXU62ZanVGGu5c7UkVkf6JiigZarGJiY2DKCRjYnbQYkj4JNFY94JlS50wTnGrk3MiAJN9DYIU-6US98zWGJ8VhBwhMuXk1juqVBfifjJMFa_-vnJjGpq1ri2buZ7hMJG-x0PIYoHUGSFeqNrcLUjJxI0o8lnXfhj7DtfYvNc0e4g5U39xtk-T2TDnQfdekRVxgdxcVR4mZdEqUHBxYUWTSW4AbgV-fjuCGDCkUoPIgkZ95y4RJhSPZzjZHdulf2Fk3L7e-nto2PB25zUTt_aXeNBSH8zjmaI2ve6D3VN0ScduRMl_9PXv1876opHEGqgkKLSTXcTUasXKlzMEiUzLl3p5pN30KnVbryAzuU3hhmIMyyPpEQkp9h3WlD4sc5oH1E8YtihLlSTtTUNwX5dJuR6iVwpKqFxECqYPtDWlzXQDTedFqdTA4isE3MCs.th9qWPzsevuDYp--06oPOw

Response to a Successful Request: Decrypted

{
    "_links": {
      "self": {
        "href": "/tms/v2/tokens/7040890000006625091/payment-credentials"
      },
      "tokenized-cards": {
        "href": "/tms/v2/tokenized-cards/223ACDECF1681954E063A2598D0A786D"
      }
    },
    "tokenizedCard": {
      "id": "223ACDECF1681954E063A2598D0A786D",
      "state": "ACTIVE",
      "enrollmentId": "FM4MMC00001441368fa429c85a5d4df5ad1875bfd2faa5eb",
      "tokenReferenceId": "DM4MMC1US0000000a7fab5f3a27e49daaf1984f7b49ab2f6",
      "number": “X214150083525091",
      "expirationMonth": "10",
      "expirationYear": "2027",
      "type": "mastercard",
      "cryptogram": "AJnA9YsVfmS8AAFHiRkBAAADFA==",
      "requestorId": "50162233570",
      "card": {
        "suffix": "0747",
        "expirationMonth": "12",
        "expirationYear": "2025"
      },
      "metadata": {
        "cardArt": {
          "combinedAsset": {
            "id": "9a90ad5f-8577-4a7a-856f-eb66e5437671",
            "_links": {
              "self": {
                "href": "/tms/v2/tokens/7040890000006625091/mdes/assets/card-art-combined"
              }
            }
          },
          "brandLogoAsset": {
            "id": "3d7c2517-6b98-4eac-a099-9bd407830e0e",
            "_links": {
              "self": {
                "href": "/tms/v2/tokens/7040890000006625091/mdes/assets/brand-logo"
              }
            }
          },
          "issuerLogoAsset": {
            "id": "f607c880-ceaa-4e88-86a7-de854abc8417",
            "_links": {
              "self": {
                "href": "/tms/v2/tokens/7040890000006625091/mdes/assets/issuer-logo"
              }
            }
          },
          "iconAsset": {
            "id": "549a3034-12da-4e85-b0d9-9ad19fec6e2b",
            "_links": {
              "self": {
                "href": "/tms/v2/tokens/7040890000006625091/mdes/assets/icon"
              }
            }
          },
          "foregroundColor": "0F0F0F"
        },
        "issuer": {
          "name": "Test IssuerÂ®",
          "shortDescription": "MasterCard Test Bank",
          "longDescription": "Test Bank for MasterCard MTF"
        }
      },
      "source": "ONFILE"
    },
    "card": {
      "number": "521415XXXXXX5091"
    },
    "issuer": {
      "paymentAccountReference": "50015018T6JE5ZORJON0QTP9HHMYN"
    },
    "processingInformation": {}
  }

For more information on decrypting data, see Encrypt and Decrypt Data.