Skip to content

Latest commit

 

History

History
299 lines (221 loc) · 11.7 KB

configurations.md

File metadata and controls

299 lines (221 loc) · 11.7 KB
description
Configure Payment Links UI

Note: Payment Links can currently only be configured via APIs. Configuration through the HyperSwitch dashboard is under development, and this section will be updated once it is available.

Available configurations

UI configurations

Payment link UI can be configured at a business profile level and the same configuration will be used when payment links are created for that profile. This UI can be configured during payment links creation as well, doing this overrides any configuration that was set in the business profile.

{% code %}

{
    theme: String, /// Primary color for the payment link
    logo: String, /// Logo displayed in the details section
    seller_name: String, /// Merchant's name in the details section
    transaction_details: Vec<PaymentLinkTransactionDetails>, /// Dynamic details related to merchant to be rendered in details section
    background_image: PaymentLinkBackgroundImageConfig, /// Configurations for the background image for details section
    details_layout: api_enums::PaymentLinkDetailsLayout, /// Custom layout for details section
    sdk_layout: String, /// Custom layout for the payment widget
    display_sdk_only: bool, /// Display only the payment widget
    enabled_saved_payment_method: bool, /// Render option to save the payment method for payment widget (works only in secure payment links)
    hide_card_nickname_field: bool, /// Hide card nickname field in payment widget
    show_card_form_by_default: bool, /// Show card form by default in payment widget
    payment_button_text: String, /// Custom text to be rendered on the SDK pay button
}

{% endcode %}

Primary color

The primary color of the payment link UI can be set using the theme field in the configuration. This color is represented as a hex value.

Example: #2167AE

Primary theme

Merchant logo

You can display a custom logo in the details section of the payment links by providing a URL.

Example: https://hyperswitch.io/favicon.ico

Primary theme

Merchant name

Customize the display name shown in the details section of the payment links.

Example: HyperSwitch Inc.

Custom seller name

Dynamic details

Include a list of key-value pairs in the details section of payment links. This list can be customized with optional configurations for each entry.

Note: The list is displayed in the specified order. Use the position attribute to control the sequence of entries.

Example: {% code %}

[
    {
        "key": "Business Country",
        "value": "Germany" 
    },
    {
        "key": "Policy Number",
        "value": "938478327648",
        "ui_configuration": {
            "is_key_bold": false,
            "is_value_bold": false,
            "position": 2
        }
    },
    {
        "key": "Product Name",
        "value": "Life Insurance Elite"
    }
]

{% endcode %}

Dynamic details

Background image

Customize the details section with a background image.

Example: {% code %}

{
  "url": "https://img.freepik.com/free-photo/abstract-blue-geometric-shapes-background_24972-1841.jpg",
  "position": "bottom",
  "size": "cover"
}

{% endcode %}

The url specifies the image source, while position and size define its placement and scaling.

For available options, refer to the API reference here.

Background image

Details section layout

Choose a layout for the details section of the payment links.

Default layout

Layout 2

Please reach out to our Support for adding any custom layouts needed for this.

SDK layout

Configure layout for the payment widget of the payment links. For a list of available options, refer to this section - SDK layouts.

Accordion layout

Render only payment widget

Set a boolean value to render only the payment widget in the payment links. Defaults to false.

Render only the payment widget

Saved payment methods

Enable rendering of saved payment methods and allow customers to save new ones in the payment widget. This is available only for secure payment links.

Save payment method checkbox

Saved payment methods

Hide card nickname input

Toggle the visibility of the card nickname input field in the payment widget.

Hidden card nickname field when card is requested to be saved

Visible card nickname field when card is requested to be saved

Show card form by default

Set a boolean value to control the default form rendered in the payment widget. Enabling this shows the card payment form by default when a payment link is opened.

Payment button text

Customize the text displayed on the "Pay Now" button in the payment widget.

Custom text for payment widget's button

Other configurations

These configurations can only be made at business profile level and cannot be overridden during payment links creation.

{% code %}

{
    domain_name: String, /// Custom domain name to be used for hosting the link
    business_specific_configs: HashMap<String, PaymentLinkConfigRequest>, /// List of UI configs for multi theme setup
    allowed_domains: HashSet<String>, /// A list of allowed domains (glob patterns) where secure links can be embedded in
    branding_visibility: bool, /// Toggle for HyperSwitch branding visibility
}

{% endcode %}

Domain name

A custom domain for hosting payment links.

Note: custom domains must be enabled before setting the custom domain name. Refer to this section for setting up custom domain names - custom domain name for payment links.

Multiple style IDs

This is for configuring multiple styles. This is a key value pair where key represents the style ID and value is the UI configurations which were mentioned above.

Example: {% code %}

{
    "style1": {
        "theme": "#3B845E",
        "logo": "https://hyperswitch.io/favicon.ico",
        "seller_name": "HyperSwitch Inc.",
        "display_sdk_only": true
    },
    "style2": {
        "theme": "#B202FF",
        "logo": "https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg",
        "seller_name": "Shopping Store",
        "enabled_saved_payment_method": true
    }
}

{% endcode %}

Style IDs are used during payment link creation, which can be specified using payment_link_config_id in the create request.

Allowed domains

This is a list of trusted domains where payment links can be embedded in an iframe. This is used only for secure payment links. More info on secure links here.

Example: ["localhost:5500", "my.custom.domain.com"]

Branding visibility

A boolean value for toggling the visibility of HyperSwitch branding in the payment links.

Visible branding (default behaviour)

Hidden branding

Configure Payment links in business profile

Use the API to configure payment link settings at the business profile level. These settings are automatically applied to any payment link created for the associated profile.

Refer to API reference for updating business profile here.

{% code %}

curl --location '{{BASE_URL}}/account/{{MERCHANT_ID}}/business_profile/{{PROFILE_ID}}' \
    --header 'Content-Type: application/json' \
    --header 'api-key: {{ADMIN_API_KEY}}' \
    '{
        "payment_link_config": {
            "theme": "#4E6ADD",
            "logo": "https://hyperswitch.io/favicon.ico",
            "seller_name": "HyperSwitch Inc.",
            "sdk_layout": "accordion",
            "display_sdk_only": true,
            "enabled_saved_payment_method": true,
            "hide_card_nickname_field": true,
            "show_card_form_by_default": true,
            "payment_button_text": "Proceed to Payment!",
            "transaction_details": [
                {
                    "key": "Policy Number",
                    "value": "297472368473924",
                    "ui_configuration": {
                        "position": 5,
                        "is_key_bold": true,
                        "is_value_bold": true
                    }
                }
            ],
            "business_specific_configs": {
                "style1": {
                    "theme": "#3B845E",
                    "logo": "https://hyperswitch.io/favicon.ico",
                    "seller_name": "HyperSwitch Inc.",
                    "display_sdk_only": true
                },
                "style2": {
                    "theme": "#B202FF",
                    "logo": "https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg",
                    "seller_name": "Shopping Store",
                    "enabled_saved_payment_method": true
                }
            },
            "allowed_domains": [
                "localhost:5500"
            ],
            "domain_name": "my.custom.domain.com",
            "branding_visibility": false
        }
    }'

{% endcode %}

List of defaults for the payment link UI config

{% code %}

{
    theme: "#212E46",
    logo: "https://live.hyperswitch.io/payment-link-assets/Merchant_placeholder.png",
    seller_name: "merchant_name", /// merchant name configured during account creation with HyperSwitch,
    transaction_details: null,
    background_image: null,
    details_layout: "layout1",
    sdk_layout: "tabs",
    display_sdk_only: false,
    enabled_saved_payment_method: false,
    hide_card_nickname_field: false,
    show_card_form_by_default: true,
    payment_button_text: "Pay Now", /// This text is available in the requested locale
}

{% endcode %}

Next step:

{% content-ref url="./create.md" %} Create Payment links {% endcontent-ref %}