Vendor Merchants

Vendor merchants determine which vendor is available for that merchant and payment methods are available to vendor and through which channels they can be accessed. These settings allow merchants to customize the payment experience by enabling or disabling specific payment methods (like credit cards or bank accounts) and controlling how they are presented across different channels (such as email, text, or web forms) for the vendor.

The configuration supports a tailored checkout experience that aligns with merchant business requirements and customer preferences. By properly configuring these settings, merchants can ensure that customers have access to appropriate payment options through the most relevant channels.

Overview

The vendor determine the vendor type

The vendorMerchantId determine the vendor connect account id Refer Connect Account ID

The paymentMethod configuration controls two main aspects:

• Which payment methods are available (CARD, BANK_ACCOUNT, HEALTH_SAVINGS_ACCOUNT etc.)
• Which channels can be used for each payment method (TEXT, EMAIL, WEBFORM, etc.)

Each payment method can be configured with different channel settings, including:

• Whether the channel is enabled
• The display order of the channel
• Any channel-specific configurations

For card payments, additional categories can be defined to provide specialized card types, such as manufacturer copay cards.

Example Configuration

[
  {
    "vendor":"STRIPE",
    "paymentMethod":[
      {
        "type":"CARD",
        "channels":[
          {
            "type":"WEBFORM",
            "order":1,
            "enabled":true
          },
          {
            "type":"TEXT",
            "order":2,
            "enabled":true
          }
        ]
      },
      {
        "type":"BANK_ACCOUNT",
        "channels":[
          {
            "type":"WEBFORM",
            "order":1,
            "enabled":true
          }
        ]
      }
    ],
    "vendorMerchantId":"26n2k3w0mT"
  },
  {
    "vendor":"OPTUM_BANK",
    "paymentMethod":[
      {
        "type":"HEALTH_SAVINGS_ACCOUNT",
        "channels":null
      }
    ],
    "vendorMerchantId":"JGcAkFpcux"
  }
]

Configuration Vendor Reference

The following table provides a reference for vendor configuration:

Root is an array of vendor configurations to support multiple vendor

Parameter	Location	Required	Description	Example Value
vendor	under each vendor array	Yes	Type of the vendor	STRIPE,OPTUM_BANK
paymentMethod	under each vendor array	Yes	paymentMethod only contains method-specific details (type, channels)	see the Configuration paymentMethod.
vendorMerchantId	under each vendor array	Yes	Vendor connect account	Example JGcAkFpcux

Configuration PaymentMethod Reference

The following table provides a comprehensive reference for all parameters in the paymentMethod configuration:

Parameter	Location	Required	Description	Example Value
paymentMethod	Root	Yes	Array of payment method configurations	[{...}, {...}]
type	Within paymentMethod	Yes	Type of payment method	"CARD", "BANK_ACCOUNT" , "HEALTH_SAVINGS_ACCOUNT
cardCategories	Within CARD paymentMethod	No	Array of specialized card categories	[{...}, {...}]
type	Within cardCategories	Yes	Type of card category	"MANUFACTURER_CARD"
label	Within cardCategories	Yes	Display label for the card category	"Manufacturer copay card"
channels	Within paymentMethod	Yes	Array of channel configurations	[{...}, {...}]
type	Within channel	Yes	Type of channel	"TEXT", "EMAIL", "WEBFORM", "GOOGLE_PAY", "APPLE_PAY", "TELEPHONIC_ENTRY"
order	Within channel	Yes	Display order (lowest first)	0, 1, 2
enabled	Within channel	Yes	Whether the channel is enabled	true or false

Payment Method Types

Type	Description	Available Channels
CARD	Credit/Debit card payments	TEXT, EMAIL, WEBFORM, GOOGLE_PAY, APPLE_PAY, TELEPHONIC_ENTRY
BANK_ACCOUNT	ACH/Direct debit payments	TEXT, EMAIL, WEBFORM
HEALTH_SAVINGS_ACCOUNT	Health saving account payments	None

Card Categories

Type	Label	Description
MANUFACTURER_CARD	Manufacturer copay card	Special payment card issued by pharmaceutical manufacturers to help patients cover copayment costs

Manufacturer Card Configuration

• Manufacturer Card

Channel Types

Type	Description	Compatible with
TEXT	SMS text message link	CARD, BANK_ACCOUNT
EMAIL	Email link	CARD, BANK_ACCOUNT
WEBFORM	Direct web form entry	CARD, BANK_ACCOUNT
GOOGLE_PAY	Google Pay integration	CARD
APPLE_PAY	Apple Pay integration	CARD
TELEPHONIC_ENTRY	Phone-based entry system	CARD

Best Practices

• Enable only the channels that align with your customer experience strategy
• Consider the order of channels to prioritize preferred payment methods
• Ensure that all enabled channels are properly supported in your implementation
• Test the customer experience for each enabled channel
• Configure card categories when specialized payment cards need to be identified separately