Skip to main content
Version: v2

Manufacturer Card category configuration

Manufacturer cards are a unique category exclusive to card payment method.

The ability to use a MF card is now configurable as described below

Merchant level configuration

This configuration is at set at the merchant level and governs how MF cards are managed.

End users can add or make payments using MF cards only if this category is enabled.

info

Wallets are user-specific; So, users can view, edit & delete MF cards across merchant applications, regardless of merchant-level configuration.

Example

  • If Merchant A supports MF cards, users can perform all operations (add/edit/delete/update/make payment).
  • If Merchant B does not support MF cards, users can only view, edit, and delete MF cards.
// sample req payload: enable MF card configuration
{
"paymentMethodSettings": {
"paymentMethod": [
{
// CARD payment method type
"type": "CARD",
"channels": [
{
"type": "WEBFORM",
"order": 0,
"enabled": true
}
],
"cardCategories": [
{
// enable MF card support
"type": "MANUFACTURER_CARD",
"label" : "Manufacturer copay card"
}
]
}
]
}
}
info
  • cardCategories is an array of types that can be configured at the merchant only if payment method type is CARD.
  • Currently Allowed type on cardCategories is MANUFACTURER_CARD only.
  • label on cardCategories will set to Manufaturer copay card by default if not provided

Session level configuration

This configuration is at session-level and overrides merchant-level configurations.

  • If enabled at the merchant level, then session level takes precedence
  • If disabled at the merchant level, then session level configuration is ignored
// sample req payload: enable MF card configuration
{
"config": {
"cardCategories": [{
// enable MF card support
"type": "MANUFACTURER_CARD",
"label" : "Pharmacy MF Card",
"medications": [
{ "label": "Prescription-1", "value": "Med 1" },
{ "label": "Prescription-2", "value": "Med 2" },
{ "label": "Prescription-3", "value": "Med 3" }
]
}]
},
}

Configuration Applicability

Defines how MF card configuration is applied based on integration pattern

Exception: Legacy client

Legacy clients bypass MF card category configuration at both merchant and session levels, ensuring existing workflows are not disrupted