Retrieve user data for Click to Pay for Visa - Marqeta Docs

GET/////

Use this endpoint to get user data for Click to Pay for Visa. For more information about this e-commerce checkout solution, see Click to Pay.

Header parameter

Fields	Description
req-sys-id string Required	Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. Allowable Values: 36 char max
external-consumer-id-owner-bid string Required	Visa Business Identifier (BID) of the entity that owns the `externalConsumerID`. Allowable Values: 1–8 chars

URL path parameters

Fields	Description
user_token string Required	Unique identifier of the cardholder. Allowable Values: Existing Visa Click To Pay User Token

Response body

Fields	Description
data array of objects Returned	Array of objects containing information of a Visa Click to Pay cardholder Allowable Values: Valid array of data objects
data[].intent object Returned	Intent of the Visa Click to Pay operation. Allowable Values: `type`, `value`
data[].intent.type string Returned	Type of the operation. Allowable Values: `PRODUCT_CODE`
data[].intent.value string Returned	Value of the operation. Allowable Values: `CLICK_TO_PAY`
data[].consumerInformation object Returned	Object containing cardholder details for Visa Click to Pay operation. Allowable Values: `externalConsumerID`, `externalConsumerIDOwnerBID`, `firstName`, `middleName`, `lastName`, `phones`, `emails`, `locale`, `countryCode`, `status`, `nationalIdentifiers`, `consent`
data[].consumerInformation.externalConsumerID string Returned	Unique identifier of the cardholder. Allowable Values: `externalConsumerID`
data[].consumerInformation.externalConsumerIDOwnerBID string Conditionally returned	Visa Business Identifier (BID) of the entity that owns the `externalConsumerID`. Allowable Values: 1–8 chars
data[].consumerInformation.firstName string Returned	First name of the cardholder. Allowable Values: `firstName`
data[].consumerInformation.middleName string Conditionally returned	Middle name of the cardholder. Allowable Values: `middleName`
data[].consumerInformation.lastName string Returned	Last name of the cardholder. Allowable Values: `lastName`
data[].consumerInformation.phones array of strings Returned	Phone numbers of the cardholder. Allowable Values: Array of valid phone numbers
data[].consumerInformation.emails array of strings Returned	Email addresses of the cardholder. Allowable Values: Array of valid email addresses
data[].consumerInformation.locale string Returned	Language and country in which the Visa Click to Pay service communicates with the cardholder, in ISO-639-1 format. Allowable Values: `locale`
data[].consumerInformation.countryCode string Returned	Country code of the cardholder. Allowable Values: `countryCode`
data[].consumerInformation.status string Conditionally returned	Status of the cardholder. Allowable Values: `ACTIVE`, `DISABLED`
data[].consumerInformation.nationalIdentifiers array of objects Conditionally returned	National identifiers of the cardholder. Allowable Values: 1–5 `nationalIdentifiers` objects
data[].consumerInformation.nationalIdentifiers[].type string Returned	Type of the national identifier. Allowable Values: `PASSPORT`, `DRIVING_LICENSE`, `NATIONAL_IDENTITY`
data[].consumerInformation.nationalIdentifiers[].value string Returned	Identification number of the cardholder. Allowable Values: 1–24 chars
data[].consumerInformation.consent object Conditionally returned	Consent details. Allowable Values: `timeOfConsent`, `presenter`, `version`
data[].consumerInformation.consent.timeOfConsent string Returned	Date and time from which the consent is valid. Allowable Values: Format: `YYYY-MM-DDThh:mm:ss.000Z`
data[].consumerInformation.consent.presenter string Conditionally returned	Name of the entity that presents the consent to the cardholder. Allowable Values: 1–30 chars
data[].consumerInformation.consent.version string Conditionally returned	Specific version of the terms and conditions that the cardholder accepts. Allowable Values: 1–9 chars
data[].paymentInstruments array of objects Returned	Array of objects containing details of payment instruments for Visa Click to Pay. Allowable Values: `type`, `accountNumber`, `nameOnCard`, `cardType`, `issuerName`, `expirationDate`, `tokenDetails`, `paymentAccountReference`, `panReferenceID`, `billingAddress`, `status`
data[].paymentInstruments[].type string Conditionally returned	Type of the payment instrument. Allowable Values: `CARD`
data[].paymentInstruments[].accountNumber string Conditionally returned	Masked account number of the payment instrument. Allowable Values: 16–19 chars
data[].paymentInstruments[].nameOnCard string Conditionally returned	Name on the card. Allowable Values: 1–120 chars
data[].paymentInstruments[].cardType string Conditionally returned	Card type description. Allowable Values: 1–70 chars
data[].paymentInstruments[].issuerName string Conditionally returned	Name of the card issuer. Allowable Values: 1–150 chars
data[].paymentInstruments[].expirationDate string Conditionally returned	Date of the expiration in the format YYYY-MM. Allowable Values: 7 chars
data[].paymentInstruments[].tokenDetails object Conditionally returned	Allowable Values: `tokenReferenceID`, `tokenRequestorID`
data[].paymentInstruments[].tokenDetails.tokenReferenceID string Returned	Unique reference identifier for the token. Allowable Values: 1–50 chars
data[].paymentInstruments[].tokenDetails.tokenRequestorID string Returned	Unique token requestor identifier. Allowable Values: 1–11 chars
data[].paymentInstruments[].paymentAccountReference string Conditionally returned	Reference of the payment account. Allowable Values: 29–50 chars
data[].paymentInstruments[].panReferenceID string Conditionally returned	Unique identifier for the card. Allowable Values: 1–32 chars
data[].paymentInstruments[].billingAddress object Conditionally returned	Billing address for Visa Click to Pay. Allowable Values: `addressLine1`, `addressLine2`, `addressLine3`, `city`, `state`, `country`, `postalCode`
data[].paymentInstruments[].billingAddress.addressLine1 string Returned	First line of the billing address. Allowable Values: 1–64 chars
data[].paymentInstruments[].billingAddress.addressLine2 string Conditionally returned	Optional second line of the billing address. Allowable Values: 1–64 chars
data[].paymentInstruments[].billingAddress.addressLine3 string Conditionally returned	Optional third line of the billing address. Allowable Values: 1–64 chars
data[].paymentInstruments[].billingAddress.city string Returned	City of the billing address. Allowable Values: 1–32 chars
data[].paymentInstruments[].billingAddress.state string Returned	State of the billing address. Allowable Values: 1–3 chars
data[].paymentInstruments[].billingAddress.country string Returned	Country of the billing address. Allowable Values: 3 chars
data[].paymentInstruments[].billingAddress.postalCode string Returned	Postal code of the billing address. Allowable Values: 1–9 chars
data[].paymentInstruments[].status string Conditionally returned	Status of the payment instrument. Allowable Values: `ACTIVE`, `INACTIVE`, `SUSPENDED`, `DELETED`

Sample response body

JSON

{
  "data": [
    {
      "intent": {
        "type": "PRODUCT_CODE",
        "value": "CLICK_TO_PAY"
      },
      "paymentInstruments": [
        {
          "type": "CARD",
          "status": "ACTIVE",
          "cardType": "Visa Platinum",
          "issuerName": "Bank A",
          "nameOnCard": "John Doe",
          "tokenDetails": {
            "tokenReferenceID": "hflasdhflsdkfhoin3y038yfwn",
            "tokenRequestorID": "1234567890"
          },
          "accountNumber": "4111111145551140",
          "billingAddress": {
            "city": "San Francisco",
            "state": "CA",
            "country": "USA",
            "postalCode": "94105",
            "addressLine1": "1000 Market Street",
            "addressLine2": "Building 56",
            "addressLine3": "Suite 101"
          },
          "expirationDate": "2030-01",
          "panReferenceID": "alikbndesfiluwbn1342fs",
          "paymentAccountReference": "paymentAccountReferenceValues"
        }
      ],
      "consumerInformation": {
        "emails": [
          "alex123@hotmail.com"
        ],
        "locale": "en_US",
        "phones": [
          "16504005555"
        ],
        "status": "ACTIVE",
        "consent": {
          "version": "1.0",
          "presenter": "Bank A",
          "timeOfConsent": "2026-05-05T12:12:12.000Z"
        },
        "lastName": "Miller",
        "firstName": "Alex",
        "middleName": "Robert",
        "countryCode": "USA",
        "externalConsumerID": "63421837-d597-4f0f-89e4-930c1a7b9e85",
        "nationalIdentifiers": [
          {
            "type": "PASSPORT",
            "value": "A123456"
          }
        ]
      }
    }
  ]
}