Checkout Info

When the widget is opened, it will automatically make a request to the API to retrieve the checkout info for the store that is associated with the application token that is set on the widget. The checkout info is not a separate resource, but instead is a read-only collection of various configuration settings that are necessary for the widget to function.

The checkout info object

Fields
modestring
The mode of the application token that is set on the widget.
namestring
The store’s name.
logo_imagestring
A URI pointing to an image file that represents the store’s logo.
recurring_token_privilegestring
The recurring token privileges of the store. One of none, bounded, or infinite.
card_configuration.enabledboolean
Whether cards are enabled as a payment method on this store.
card_configuration.debit_enabledboolean
Whether debit cards are accepted.
card_configuration.prepaid_enabledboolean
Whether credit cards are accepted.
card_configuration.forbidden_card_brandsarray[string]
A list of card brands that are not allowed for use by this store.
card_configuration.allowed_countries_by_iparray[string]
A list of countries whose IP addresses are not allowed to make charges.
card_configuration.foreign_cards_allowedboolean
Whether foreign cards are accepted. A foreign card is a card whose country is not the same as the store’s country.
card_configuration.fail_on_new_emailboolean
Whether to allow cards that have been previously used with a specific email address, be rejected if a different email address is used.
card_configuration.allow_empty_cvvboolean
Whether to enable CVV checking for card charges.
card_configuration.card_limit.amountnumber
The amount to limit per card for the defined duration.
card_configuration.card_limit.currencystring (ISO-4217)
The currency in ISO-4217 format.
card_configuration.card_limit.durationstring (ISO-8601)
The duration in which to compare with the amount.
qr_scan_configuration.enabledboolean
Whether QR codes are usable as a payment method on this store.
qr_scan_configuration.forbidden_qr_scan_gatewaysarray[string]
A list of payment gateways that will not be used for processing QR code payments.
convenience_configuration.enabledboolean
Whether convenience store payments are usable as a payment method on this store.
theme.colors.main_backgroundstring (HexColor)
Main background color
theme.colors.secondary_backgroundstring (HexColor)
Secondary background color.
theme.colors.main_colorstring (HexColor)
Main color.
theme.colors.primary_textstring (HexColor)
Primary text color.
theme.colors.secondary_textstring (HexColor)
Secondary text color.
theme.colors.base_textstring (HexColor)
Base text color.
recurring_card_charge_cvv_confirmation.enabledboolean
Whether CVV confirmations are required for this store when using recurring tokens.
recurring_card_charge_cvv_confirmation.thresholdarray[MoneyAmount]
The maximum amount in the default currency of the store can charge without triggering a CVV confirmation.
supported_brandsarray[SupportedBrand]

MoneyAmount

Fields
amountnumber
The amount sans decimal point.
currencystring (ISO-4217)
The currency in ISO-4217 format.

SupportedBrand

Fields
brandstring
The supported brand, can be one of the following, depending on the payment_type:
card: visa, mastercard, american_express, jcb, diners_club, unionpay, discover, maestro
qr_merchant: alipay_merchant_qr, alipay_connect_mpm, pay_pay_merchant, we_chat_mpm
online: alipay_online, pay_pay_online, we_chat_online,
bank_transfer: aozora_bank
paidy: paidy
payment_typestring
Is one of card, qr_merchant, online, bank_transfer, paidy
support_auth_captureboolean
requires_full_nameboolean
support_dynamic_descriptorboolean
requires_cvvboolean
countries_allowedarray[string]
supported_currenciesarray[string]