Retrieve Network Token AFT Payment Credentials

This section describes how to retrieve the payment credentials for a Visa Token Service (VTS) network token that is used for account funding transactions (AFTs). You can retrieve these payment credentials for a VTS network token:
  • VTS network token value
  • AFT cryptogram (Visa only)
The VTS network token payment credentials are returned as a JSON Web Encryption (JWE) response.
IMPORTANT
You must contact your Visa representative to ensure that your system is enabled to retrieve an AFT cryptogram.

Endpoint

Test:
POST
https://apitest.visaacceptance.com
/tms/v2/tokens/
{tokenId}/
payment-credentials
Production:
POST
https://api.visaacceptance.com
/tms/v2/tokens/
{tokenId}
/payment-credentials
The
{tokenId}
 is the token ID returned in the
id
 field when you create the customer, payment instrument, or instrument identifier token. For more information, see Create an Instrument Identifier.

Required Fields for Retrieving Network Token AFT Payment Credentials

paymentCredentialType
Set to
CRYPTOGRAM
.
transactionType
Set to
AFT
.

REST Example: Retrieving Network Token AFT Payment Credentials

Light Dark
Request
123
{"paymentCredentialType": "CRYPTOGRAM",
  "transactionType": "AFT"
}
Response to a Successful Request: BASE 64
1
eyJraWQiOiJmOTdmOWIyMDZkYzQxNzJmZGRlOWRlNjM5NjMyMWViZTI2NjY4NDc0IiwiY3R5IjoianNvbiIsInR5cCI6IkpXVCIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.-YJItC1VKN3zLlpEZf9VJrUcYrTew6zCNNRKs3treD-Mn3VNK6eYm2YAhkeuryYIU2NXZVW3CsZsqeOu5y3c2eO_AiDHRYIKG9MJLoXYqgb-oIotvsmN3p4nYuiYIL21FkdssBV-V66kyMWPaVZpTqFp0lZBm0NN6p1MoUEybPc5vBpY2I24QZFHJjtX6jxdivA5XmgBgj2DEnue7KlsS3AtMsixmSGOd46FR0iadGQFQHAvs8lDjfcUj5-vxcFopp8wBOd1sNsItCnqj4WTZFbZGyTe-GnouSCfNX7uC-oHHdxRGdA.z8TDop4oz778UEUI.yNSpacqPUTGVScMLQJNDjFEvlWdY7YrywJNh7_hCgQBPeW-a1wPnKRsg_9qubr6_2xYldoNTzrGgiuTj5_cToO5sZF0zFoaDjN9zZMVeppYTB9dfgvQd8AF0AFemhm9lfJVLgjbejPTAHHtJspIUGbV4QUPQTAQLLrlT_WSRf-hjQRUHrqoXpkXg-Fjzf1SLNTJb8aFWuvLjNtQMoau-CwSBeJSbCluDuOKU56TFCZn-9UtE67uDoSgPMgs8XVyAPdSdHLFK8yXzp0mvYqEcR3_p75-MHXsA4qQJuAfXoHjEFsUpqyCkUBPLE7meGfiuQE9fnlqmtVAtvrdlwdqTVJc_388UJLIGqm0KDuD4gGhdzYuCEnNSrV8VnQ87IggFPMl4kqtbfCjJ-qvowC6m1a1Wv8rzRo9AqAFXmUpkTaE4vCaPMnRbXuzY0dss81LQlyGri0_eBy6WfOvXe-0yOviDKFxT_GVeF4nSwkbpxMGGI7aWbVXJ-_r6LBgALtgIbiQZqrWrgLv_FV7DDhY7HnN39R14gve6yxNPu7RCFEViy6RUldo_JxPCjNBL6xGXn1ccnxSCQwyvFGvrF1wvm-Ed8vCnImimX4ClV0_ba9lyOUYGIIS7-CWrra7TvtISVdYL4J0vPnOHvr8RCwEi5Y6iBtV-Ew6BhHpVd8aFdSTTOfHI7bUtUUE8mFmtnLD1atC-sa2sBjrw4PlB-NQMEE4uAGeeccYmYdfPUQdLuMRkzkoPFoNwqnJJ5UC8T6GzEQxZCzfxgTyn_m2toU-Sbb42QKB0BI01czad24FuILk93QaVv2SwRX_OQWb8lCxbWFIaxGrHEGLL5YpgqrVKFDLWETD9o-ysQzFweiW-SORrbLhmKs2xp3GT75d_wxE5IOvLl_A7tJl8I5BQ-aBnTtyZofEJsd6inYHM0TYzj-9YRK4r-grA3xvytI50dwkJJJ4Ju9wJGuxAdKvbxYrkwKgn0HKBE58BGjKElT6j0gLXU0bsuDPo1E_OSj9NGyUeB9LKGIptGNQOBeNi06pYwTGMkjfPZi9S1Zv9wnr7CwcSe_xImu4f192co8hJKUIXosbAZturQ-8tR5BOZSKrLgO4vCQfJmYxYC1IVaDWknhTe78ev9qVZD0HP7H_gqXPHY5O5DfBr-pxFCnYt-oQwt24hc2_r13JvzekYP3bjoUV9YsoO8-eJ1A4NyO8Bk2qUZMEWca_szCz_uCiozwdXWc0HVIUWsn1BvrbRKzM91UxrEZkKmP3xaOPQv91FMTgVvJEG7pxrObH49gGgNO8rU-J46Hd01YcAFzvgqYTSxGaCF5lgmgbXzPK16AWfGYKPXEUExZERvVhIxhQRKpBKD3KJFO772blKdfTjPl_QqnUJ5_wy7QScUP_7okJZduC9JgNy-S4htThQHL4AW2XO6RzInaup4fZ3tkaIdNTacQQwFcd-kJ3Bj049VcV2BkMR1oP2__P2siMQ8H3oD8IZAb9S0buFezp1KVNflKNW2fTQDXEESzFZi-aL4OxMSll6yujkXtKtjOZoMYZawNeuLGtltZQZ8BkhvzRTrwuBHWNcbhCN9-0qwC4YuBZ8FD1Rpd1vPNOPMpEMblq9BKf_wlGeXUMK0XzsVdQLfcBd6aDHAysFnt8Y961oYTX8kA.
Response to a Successful Request: Decrypted
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
{"_links": {
    "self": {
      "href": "/tms/v2/tokens/1CD10F58FB7C7DB8E063A2598D0A1405/payment-credentials"
    },
    "tokenized-cards": {
      "href": "/tms/v2/tokenized-cards/1CD10F58FB837DB8E063A2598D0A1405"
    }
  },
  "tokenizedCard": {
    "id": "1CD10F58FB837DB8E063A2598D0A1405",
    "state": "ACTIVE",
    "enrollmentId": "da1fb810b1b3e01db5b215de5261df01",
    "tokenReferenceId": "090673c4811a91960f021ad3a24e2e01",
    "number": "X895370017256311",
    "expirationMonth": "12",
    "expirationYear": "2031",
    "type": "visa",
    "cryptogram": "AwAAAADi9THGeHw4ARJ4QAoAAAA=",
    "eci": "07",
    "requestorId": "40010052236",
    "card": {
      "suffix": "7161",
      "expirationMonth": "12",
      "expirationYear": "2030"
    },
    "metadata": {
      "cardArt": {
        "combinedAsset": {
          "id": "8f64614def1a41d39ea8acae4616bf6f",
          "_links": {
            "self": {
              "href": "/tms/v2/tokens/1CD10F58FB7C7DB8E063A2598D0A1405/vts/assets/card-art-combined"
            }
          }
        },
        "brandLogoAsset": {
          "id": "00000000000000000000000000001071",
          "_links": {
            "self": {
              "href": "/tms/v2/tokens/1CD10F58FB7C7DB8E063A2598D0A1405/vts/assets/brand-logo"
            }
          }
        },
        "foregroundColor": "1af0f0"
      },
      "issuer": {
        "shortDescription": "shortDescription",
        "longDescription": "longDescription"
      }
    },
    "source": "ONFILE"
  },
  "card": {
    "number": "X622943123037161"
  },
  "issuer": {
    "paymentAccountReference": "V0010013024026372674590402581"
  },
  "processingInformation": {
    "commerceIndicator": "internet"
  }
}
For more information on decrypting data, see Encrypt and Decrypt Data.