On This Page

Create Tokenized Card Payment Credentials with Device Signed JWS

This section describes how to create tokenized card payment credentials with device signed JWS.

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 identifier of the tokenized card.

Required Fields for Creating a Tokenized Card Payment Credentials with Device Signed JWS

deviceInformation.ipAddress
merchantInformation.merchantDescriptor.name
merchantInformation.merchantDescriptor.url
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
orderInformation.billTo.address1
orderInformation.billTo.administrativeArea
orderInformation.billTo.country
orderInformation.billTo.email
orderInformation.billTo.firstName
orderInformation.billTo.lastName
orderInformation.billTo.locailty
orderInformation.billTo.postalCode
tokenInformation.tokenAuthenticationInformation.authenticatedIdentities.data
tokenInformation.tokenAuthenticationInformation.authenticatedIdentities.provider
tokenInformation.tokenAuthenticationInformation.authenticatedIdentities.userAuthenticationMethod: Required when
tokenInformation.tokenAuthenticationInformation.authenticatedIdentities.provider
is set to
CLIENT_DEVICE_CERT_JWS
.
transactionType

Optional Fields for Creating a Tokenized Card Payment Credentials with Device Signed JWS

orderInformation.billTo.firstName
orderInformation.billTo.lastName
orderInformation.billTo.email
orderInformation.billTo.address1
orderInformation.billTo.locality
orderInformation.billTo.administrativeArea
orderInformation.billTo.postalCode
orderInformation.billTo.country
deviceInformation.ipAddress

REST Example: Creating a Tokenized Card Payment Credentials with Device Signed JWS

Request with

authenticatedIdentities

{
  "clientReferenceInformation": {
    "code": "abc"
  },
  "paymentInformation": {
    "customer": {
      "id": "<id in payment-credentials url>"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "<orderInformation.amountDetails.totalAmount>",
      "currency": "<orderInformation.amountDetails.currency>"
    },
    "billTo": {
      "firstName": "<orderInformation.billTo.firstName>",
      "lastName": "<orderInformation.billTo.lastName>",
      "address1": "<orderInformation.billTo.address1>",
      "locality": "<orderInformation.billTo.locality>",
      "administrativeArea": "<orderInformation.billTo.administrativeArea>",
      "postalCode": "<orderInformation.billTo.postalCode>",
      "country": "<orderInformation.billTo.country>",
      "email": "<orderInformation.billTo.email>",
      "phoneNumber": "<orderInformation.billTo.phoneNumber>"
    }
  },
  "deviceInformation": {
    "ipAddress": "<deviceInformation.ipAddress>"
  },
  "merchantInformation": {
    "merchantDescriptor": {
      "name": "<merchantInformation.merchantDescriptor.name>",
      "url": "<merchantInformation.merchantDescriptor.url>"
    }
  },
  "tokenInformation": {
    "tokenAuthenticationInformation": {
      "authenticatedIdentities": [
        {
          "data": "<authenticatedIdentities[].data>",
          "provider": "CLIENT_DEVICE_CERT_JWS",
          "userAuthenticationMethod": "<authenticatedIdentities[].userAuthenticationMethod>"
        }
      ]
    }
  }
}

Request with Network Token & Cryptogram

{
  "clientReferenceInformation": {
    "code": "abc"
  },
  "paymentInformation": {
    "customer": {
      "id": "<id in payment-credentials url>"
    },
    "tokenizedCard": {
      "number": "411111111111XXXX",
      "expirationMonth": "12",
      "expirationYear": "2031",
      "cryptogram": "AceY+igABPs3jdwNaDg3MAACAAA=",
      "transactionType": "3"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "<orderInformation.amountDetails.totalAmount>",
      "currency": "<orderInformation.amountDetails.currency>"
    },
    "billTo": {
      "firstName": "<orderInformation.billTo.firstName>",
      "lastName": "<orderInformation.billTo.lastName>",
      "address1": "<orderInformation.billTo.address1>",
      "locality": "<orderInformation.billTo.locality>",
      "administrativeArea": "<orderInformation.billTo.administrativeArea>",
      "postalCode": "<orderInformation.billTo.postalCode>",
      "country": "<orderInformation.billTo.country>",
      "email": "<orderInformation.billTo.email>",
      "phoneNumber": "<orderInformation.billTo.phoneNumber>"
    }
  },
  "deviceInformation": {
    "ipAddress": "<deviceInformation.ipAddress>"
  },
  "merchantInformation": {
    "merchantDescriptor": {
      "name": "<merchantInformation.merchantDescriptor.name>",
      "url": "<merchantInformation.merchantDescriptor.url>"
    }
  }
}

Request with DCAP

{
  "paymentCredentialType": "CRYPTOGRAM",
  "transactionType": "ECOM",
  "orderInformation": {
    "billTo": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "phoneNumber": "4158880000",
      "address1": "1 Market St",
      "address2": "Edgewater",
      "locality": "San Francisco",
      "administrativeArea": "CA",
      "postalCode": "94105",
      "country": "USA"
    }
  },
  "deviceInformation": {
    "id": "f68a4f0f-d1a5-4ad4-b494-0dc4f1ffd176",
    "ipAddress": "24.156.99.202"
  }
}

Response to a Successful Request