Skip to main content
Version: v2

Payment Method Entry

Overview​

Payment Method Entry widget enables customers to save payment methods, such as cards and bank accounts. It provides a user interface for entering either card or bank account details, with card payment method entry selected as the default option. Customers can access the 'Add Card' or 'Add Bank Account' forms, while agents have the option to send a link to the customer via text or email.

When to use it​

Payment Method Entry widget is designed for scenarios where customers need to save payment methods. It provides a convenient way for merchants to allow customers to save payment methods, which can then be showcased during checkout or highlighted as a preferred option for future transactions. Customers must enter valid card or bank account details to save a payment method. When making a payment, customers can select a saved payment method from their wallet to complete the transaction seamlessly.

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": ["PAYMENT_METHOD_ENTRY"],
    "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 Method Entry Widget.
  2. config.modes: Defines the mode of the CCG widget, which is set to PAYMENT_METHOD_ENTRY.
  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 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 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.
    • The TEXT, EMAIL, and TELEPHONIC_ENTRY channels are available exclusively for agent-assisted sessions.
    • The WEBFORM channel is available for both agent-assisted and self-service sessions.
    • The 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 PAYMENT_METHOD_ENTRY mode? The PAYMENT_METHOD_ENTRY mode is a feature of the CCG widget that enables customers to save their payment methods, such as credit/debit cards and bank accounts. It offers a user interface for securely entering and storing payment details.

  2. When should PAYMENT_METHOD_ENTRY mode be used? The PAYMENT_METHOD_ENTRY mode is intended for scenarios where customers need to save their payment methods on the CCG platform. It helps enable faster transactions in the future and allows preferred payment methods to be highlighted during checkout.

  3. What additional options are available for agents using PAYMENT_METHOD_ENTRY mode? Agents can utilize additional channels to assist the customers with payment method entry, using WEBFORM for on-screen entry, EMAIL for sending a link via email, TEXT for sending a link via text, TELEPHONIC_ENTRY for capturing the PCI complaint data securely.

  4. What are the prerequisites for merchants to use PAYMENT_METHOD_ENTRY mode? Merchants are required to have an account on the CCG Platform and complete the technical integration process. Additionally, they must obtain a valid merchantId and ensure that payment methods are configured with the appropriate channels during the onboarding process.

  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.