Skip to main content
Version: v2

Session Configurations

Quick Reference
  • Purpose: Customize the session experience for customers.
  • Key Object: config
  • Common Options:
    • modes: Session modes (e.g., PAYMENT, PAYMENT_WITH_WALLET)
    • paymentMethodChannel: Supported channels for card/bank account
    • privacyPolicyUrl: Custom privacy policy link
    • senderEmailAddress: Sender email for notifications
    • options: Save/payment method options, language
    • merchant: Merchant-specific info
  • Usage: Place the config object in your session request to enable these features.
  • See Also: Session Request documentation

Session configurations allow merchants to customize the widget experience for customers. The config object supports options such as session modes, payment method channels, preferred language, privacy policy URL, sender email address, and more.

Supported Configurations​

Modes​

  • Available Session Modes: Modes
Config - Modes
"config": {
    "modes": [
        "PAYMENT_WITH_WALLET"
    ]
}

Payment Method Channel​

  • Available Payment Method Types:

    • CARD
    • BANK_ACCOUNT

  • Available Payment Method Channel:

    • Card: WEBFORM, TEXT, EMAIL , GOOGLE_PAY , APPLE_PAY , TELEPHONIC_ENTRY
    • Bank Account: WEBFORM, TEXT, EMAIL
Config - Payment Method Channel
"config": {
    "paymentMethodChannel": {
        "card": ["WEBFORM"]
    }
}

Preferred Language​

Config - Preferred Language
"config": {
    "options":{
        "preferredLanguage":"es"
    }
}

Privacy Policy URL​

Config - Privacy Policy URL
"config": {
    "privacyPolicyUrl":"www.policyurl.com"
}

Sender Email Address​

Config - Sender Email Address
"config": {
    "senderEmailAddress":"merchant@domain.com"
}

Merchant Object​

Config - Merchant Object
"config": {
    "merchant": {
      "name": "string"
    }
}

PaymentMethod SaveMode​

Config - paymentMethodSaveMode
  • Type: string
  • Default: "ALLOW_SAVE"
  • Description: Controls how a card or bank account is saved as a payment method after a successful payment.
  • Supported Modes: PAYMENT
  • Note: Do not use both 'paymentMethodSaveMode' & 'saveDisabled' simultaneously.
Enum ValueDescription
ALLOW_SAVEDisplays the option to save the payment method.
DISABLE_SAVEHides the save payment method option.
AUTO_SAVEAutomatically saves the payment method without displaying the save option.
"config": {
    "options":{
        "paymentMethodSaveMode":"DISABLE_SAVE"
    }
}

Card Categories​

Card Categories Configuration
  • Type: MANUFACTURER_CARD
  • Label: Manufacturer copay card
  • Medications:
    • label: Pharacetamol
    • value: 100mg
"cardCategories": [
    {
        "type": "MANUFACTURER_CARD",
        "label": "Manufacturer copay card",
        "medications": [
            {
                "label": "Pharacetamol",
                "value": "100mg"
            }
        ]
    }
]