On This Page

Use Case Dictionary

The following is a list of additional information for UCTP use cases.

Recognized Click to Pay Customer – Remember Me

The customer must select the checkbox in the UI to be remembered before making the payment using the

checkout()

API. This allows integrators to assess the expected flow (remember me).

To enable the remember me flow in

Click to Pay

SDKs, add the following to your checkout request payload:

Checkout Request – checkout()

{
  "srcDigitalCardId": "f4ae684f-dfbf-60c1-c922-135e4ec66301",
  "payloadTypeIndicatorCheckout": "FULL",
  "complianceSettings": {
    "complianceResources": [
      {
        "complianceType": "REMEMBER_ME",
        "uri": "https://merchant.com/remember-me"
      }
    ]
  }

Recognized Click to Pay Customer – Unrecognized Device

When the customer enters an email or phone number recognized by

Click to Pay

, the system sends an OTP. Integrators must use the

getCards

API twice, first to trigger the OTP and second to pass the OTP to the request payload.

Below are samples for managing unrecognized devices:

Trigger OTP – getCards()

{
  "consumerIdentity": {
    "identityProvider": "SRC",
    "identityValue": "consumer@example.com",
    "identityType": "EMAIL_ADDRESS"
  }
}

Submit OTP – getCards()

{
  "consumerIdentity": {
    "identityProvider": "SRC",
    "identityValue": "consumer@example.com",
    "identityType": "EMAIL_ADDRESS"
  },
  "validationData": "847291"
}

New Customer Enrollment - Link Card

If the

Click to Pay

system does not find the customer, the UI prompts the customer to add a new card and link it to

Click to Pay

Checkout Request – checkout()

{
  "consumer": {
    "emailAddress": "XXXXXXXX@gmail.com",
    "consumerIdentity": {
      "identityProvider": "SRC",
      "identityValue": "XXXXXXXX@gmail.com",
      "identityType": "EMAIL_ADDRESS"
    },
    "mobileNumber": {
      "phoneNumber": "XXXXXXXXXXX",
      "countryCode": "1"
    },
    "countryCode": "US",
    "locale": "en",
    "firstName": "XXXX",
    "lastName": "XXXXXXX",
    "fullName": "TestTool SampleData"
  },
  "payloadTypeIndicatorCheckout": "FULL",
  "encryptedCard": "eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIiwia2lkIjoiVzBQWjhWWFVWRUJVOTVKTzZaRFkxM3NxNUotZHhUbjU2ZkliRFg2Tm1jM1pqOVdxYyJ9.qRQ8DS3aV1G3pNYZIvcLU6NUwyGpTYNMNsQXq90FX5Cry0d4U-fHT1VyRq8OG13koZHnpe1tD......."
}

Refer to the encrypted card payload for linking or adding a card to the existing customer:

Encrypted Card Payload

{
  "cardholderFullName": "XX XXXXX",
  "primaryAccountNumber": "4XXXXXXXXXXXX011",
  "panExpirationMonth": "XX",
  "panExpirationYear": "20X7",
  "cardSecurityCode": "X06",
  "billingAddress": {
    "name": "TestTool SampleData",
    "line1": "1004 NW 65th Ave",
    "city": "Miami",
    "state": "FL",
    "zip": "33126",
    "countryCode": "US"
  }
}

Switch ID

When the customer needs to log out of their

Click to Pay

account, they must use the switch id option in the UI.

Integrators must call

unbindAppInstance

when switch id is clicked.

Unbind App Instance – unbindAppInstance()

unbindAppInstance();

Re-Trigger One Time Password

To resend an OTP, call the

initiateIdentityValidation()

method. This sends an OTP to the customer.

Initiate Identity Validation – initiateIdentityValidation()

initiateIdentityValidation();