Skip to main content
Version: v2

Wallet

Overview​

Manage Wallet feature allows customers to manage their wallets by adding, editing, or removing payment methods. Agents can also use this feature to manage a customer's wallet.

When to use it​

Manage Wallet widget designed for customers to exclusively manage their wallets.

Pre requisites​

  1. Merchants are required to have an account on the CCG Platform and complete the technical integration process.
  2. After completing the onboarding process, merchants will receive a valid merchantId, which must be included in the header of all requests to CCG APIs, as outlined in the next section.
  3. Merchants must also obtain a valid JWT token for authentication purposes. This token should be included in the header of all request to CCG APIs, as outlined in the next section

Supported Experiences​

Usage​

Create a Session​

  • To create a session, send a request object specifying the customer details, configuration modes.

Example Request​

Headers required:​

  • Authorization: Bearer xxxxx
  • Content-Type: application/json
  • X-Upstream-Env: stage (Specify the env value, Only required for Non-Prod)
  • X-Merchant-Id: (MerchantId obtained during onboarding)
{
  "customer": {
    "enterpriseId": "enterprise id",
    "hsid": "hsid",
    "firstName": "first name",
    "lastName": "last name",
    "email": "email",
    "ssnLastFour": "1234",
    "phoneNumber": {
      "number": "1234567890",
      "countryCode": "1"
    },
    "dateOfBirth": "dob",
    "zip5": "23124",
    "metadata": {
      "patientId": "rx-patient-id"
    }
  },
  "config": {
    "modes": ["WALLET"],
    "paymentMethodChannel": {
      "card": [
        "TEXT",
        "EMAIL",
        "WEBFORM",
        "TELEPHONIC_ENTRY"
      ],
      "bankAccount": [
        "TEXT",
        "EMAIL",
        "WEBFORM"
      ]
    }
  },
  "agent": {
    "firstName": "First Name",
    "lastName": "Last Name",
    "userId": "msId",
    "isAccessVerified": true
  }
}

More info Note: Use hostedURL from the session response to launch the hosted experience.

Explanation on above Request Payload​
  1. customer: Represents the customer object.
    • A valid customer identifier (i.e., hsid or enterpriseId, rx-patientId etc.,) is must required for Payment with wallet widget in order to perform the payment using the stored payment methods in wallet.
  2. config.modes: Defines the mode of the CCG widget, which is set to WALLET.
  3. config.paymentMethodChannel: Specifies the types of payment methods displayed on the customer's wallet screen when the session is created.
    • config.paymentMethodChannel.card - Specifies the channels through which card payment method details can be captured. The available options are:
    • TEXT: Captures card details via SMS.
    • EMAIL: Captures card details via email.
    • WEBFORM: Captures card details via web form.
    • TELEPHONIC_ENTRY: Captures card details via telephonic entry.
    • config.paymentMethodChannel.bankAccount - Specifies the channels through which bank account payment method details can be captured. The available options are:
      • TEXT: Captures bank account details via SMS.
      • EMAIL: Captures bank account details via email.
      • WEBFORM: Captures bank account details via web form.
    • TEXT, EMAIL, and TELEPHONIC_ENTRY channels are available exclusively for agent-assisted sessions.
    • WEBFORM channel is available for both agent-assisted and self-service sessions.
    • WEBFORM channel is set to default to self-service sessions.
    • Note: The channels specified in the request must be enabled during the onboarding process. If a channel is not enabled, it will not be available for use.
  4. agent: Applied for agent assisted sessions.
    • Agents can capture payment method details from customers through various channels, including TEXT, EMAIL, and TELEPHONIC_ENTRY.
    • The agent must be part of the WS2 group (i.e., the AZU_PCI_Workstation_2 secure group) to capture card details from customers if the merchant has opted for ws2Check during onboarding as part of PCI compliance.
FAQs:​

  1. What is the WALLET mode? Manage Wallet feature allows customers to manage their wallets by adding, editing, or removing payment methods.

  2. What happens if there are no saved payment methods in the customer's wallet? If the customer's wallet contains no saved payment methods, the screen prompts them to manage their wallet and add a payment method.

  3. What happens if an invalid CCG customer identifier is used? If an invalid CCG customer identifier is provided, the session creation will fail and return a response stating that the customer identifier is missing.

  4. What are the different integration patterns available for launching the "Manage Wallet" widget? The Manage Wallet widget can be launched in various forms of CCG’s integration patterns such as hosted, modal, inline, drawer, inline with modal, inline with drawer experiences.

  5. What happens if I add a card that is already in my wallet? If a user adds a card that is already present in the wallet, the fields "Name on Card," "Expiration Date," "Nickname," and "Zip Code" are updated in the existing card.

  6. What happens if I add a bank account that is already in my wallet? If a user adds a bank account that already exists in the wallet, the fields "Account Type," "Name on Account," and "Bank Account Nickname" are updated in the existing bank account.