configuration

Update configuration

put/v1/configuration/{handle}

Request

  • Base URL
    https://checkout-api.frisbii.com
  • URL
    https://checkout-api.frisbii.com/v1/configuration/{handle}
  • Auth
    HTTP basic

Path parameters

handlestring required

Configuration handle

Request body

namestring

Descriptive name for configuration

logostring

Logo url. Must be hosted on a *.frisbii.com or *.reepay.com domain.

localestring

Locale to use if not provided when creating session. Defaults to account locale.

sitestring

Checkout site domain to use: reepay or frisbii

payment_methodsstring[]

Optional lists of payment methods to use for sessions with this configuration

co_branded_card_selectionboolean

Option to control if the cardholder should be able to choose which part of a co-branded card to use. Defaults to false.

co_branded_visa_dankort_preferencestring

Default selected part of a co-branded Visa-Dankort if co_branded_card_selection enabled and cardholder makes no specific selection.

amount_formatting'currency_code' | 'currency_symbol'

How to format amount and currency: currency_code - with currency code, e.g. 100 USD (default), or currency_symbol - with symbol, e.g. $100

payment_type_prioritystring[]

List of payment types giving the order in the checkout

show_test_hintsboolean

For test accounts, use this setting to control if info boxes with hints on how to perform testing should be shown in Checkout.

show_subscription_details_expandedboolean

A property, which shows if subscription details should be expanded in Checkout.

require_cardholder_nameboolean

Require name on card for credit card payments

Example request

{
  "name": "Campaign checkout form",
  "styleConfig": {
    "footerLogoColor": "grey"
  },
  "co_branded_visa_dankort_preference": "visa",
  "amount_formatting": "currency_code",
  "consent_configuration": {
    "consent_definitions": [
      {
        "text": "I have agreed on {{policyHandle}} and {{policyHandle:Custom text }}",
        "policies": [
          {
            "handle": "policy-123",
            "name": "Privacy Policy",
            "custom_name": "Additional private policy"
          }
        ]
      }
    ]
  }
}

Response

Successful operation

namestring

Descriptive name for configuration

logostring

Logo url. Must be hosted on a *.frisbii.com or *.reepay.com domain.

localestring

Locale to use if not provided when creating session. Defaults to account locale.

sitestring

Checkout site domain to use: reepay or frisbii

handlestring required
createdstring date-time
payment_methodsstring[]

Optional lists of payment methods to use for sessions with this configuration

co_branded_card_selectionboolean

Option to control if the cardholder should be able to choose which part of a co-branded card to use. Defaults to false.

co_branded_visa_dankort_preferencestring

Default selected part of a co-branded Visa-Dankort if co_branded_card_selection enabled and cardholder makes no specific selection.

amount_formatting'currency_code' | 'currency_symbol'

How to format amount and currency: currency_code - with currency code, e.g. 100 USD (default), or currency_symbol - with symbol, e.g. $100

payment_type_prioritystring[]

List of payment types giving the order in the checkout

show_test_hintsboolean

For test accounts, use this setting to control if info boxes with hints on how to perform testing should be shown in Checkout.

show_subscription_details_expandedboolean

A property, which shows if subscription details should be expanded in Checkout.

require_cardholder_nameboolean

Require name on card for credit card payments

Example response

{
  "name": "Campaign checkout form",
  "styleConfig": {
    "footerLogoColor": "grey"
  },
  "co_branded_visa_dankort_preference": "visa",
  "amount_formatting": "currency_code",
  "consent_configuration": {
    "consent_definitions": [
      {
        "text": "I have agreed on {{policyHandle}} and {{policyHandle:Custom text }}",
        "policies": [
          {
            "handle": "policy-123",
            "name": "Privacy Policy",
            "custom_name": "Additional private policy"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.