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 | |
|---|---|
| mode | string The mode of the application token that is set on the widget. |
| name | string The store’s name. |
| logo_image | string A URI pointing to an image file that represents the store’s logo. |
| recurring_token_privilege | string The recurring token privileges of the store. One of none, bounded, or infinite. |
| card_configuration.enabled | boolean Whether cards are enabled as a payment method on this store. |
| card_configuration.debit_enabled | boolean Whether debit cards are accepted. |
| card_configuration.prepaid_enabled | boolean Whether credit cards are accepted. |
| card_configuration.forbidden_card_brands | array[string] A list of card brands that are not allowed for use by this store. |
| card_configuration.allowed_countries_by_ip | array[string] A list of countries whose IP addresses are not allowed to make charges. |
| card_configuration.foreign_cards_allowed | boolean 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_email | boolean 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_cvv | boolean Whether to enable CVV checking for card charges. |
| card_configuration.card_limit.amount | number The amount to limit per card for the defined duration. |
| card_configuration.card_limit.currency | string (ISO-4217) The currency in ISO-4217 format. |
| card_configuration.card_limit.duration | string (ISO-8601) The duration in which to compare with the amount. |
| qr_scan_configuration.enabled | boolean Whether QR codes are usable as a payment method on this store. |
| qr_scan_configuration.forbidden_qr_scan_gateways | array[string] A list of payment gateways that will not be used for processing QR code payments. |
| convenience_configuration.enabled | boolean Whether convenience store payments are usable as a payment method on this store. |
| theme.colors.main_background | string (HexColor) Main background color |
| theme.colors.secondary_background | string (HexColor) Secondary background color. |
| theme.colors.main_color | string (HexColor) Main color. |
| theme.colors.primary_text | string (HexColor) Primary text color. |
| theme.colors.secondary_text | string (HexColor) Secondary text color. |
| theme.colors.base_text | string (HexColor) Base text color. |
| recurring_card_charge_cvv_confirmation.enabled | boolean Whether CVV confirmations are required for this store when using recurring tokens. |
| recurring_card_charge_cvv_confirmation.threshold | array[MoneyAmount] The maximum amount in the default currency of the store can charge without triggering a CVV confirmation. |
| supported_brands | array[SupportedBrand] |
MoneyAmount
| Fields | |
|---|---|
| amount | number The amount sans decimal point. |
| currency | string (ISO-4217) The currency in ISO-4217 format. |
SupportedBrand
| Fields | |
|---|---|
| brand | string The supported brand, can be one of the following, depending on the payment_type:card: visa, mastercard, american_express, jcb, diners_club, unionpay, discover, maestroqr_merchant: alipay_merchant_qr, alipay_connect_mpm, pay_pay_merchant, we_chat_mpmonline: alipay_online, alipay_plus_online, pay_pay_online, we_chat_online, bank_transfer: aozora_bankpaidy: paidy |
| payment_type | string Is one of card, qr_merchant, online, bank_transfer, paidy |
| support_auth_capture | boolean Whether this brand supports authorizations and captures |
| requires_full_name | boolean Whether this brand requires a full name |
| support_dynamic_descriptor | boolean Whether this brand supports dynamic descriptor |
| requires_cvv | boolean Whether this brand requires a CVV |
| countries_allowed | array[string] The countries this brand supports |
| supported_currencies | array[string] The currencies this brand supports |
| cvv_auth | boolean Whether this brand supports pre authorization of the CVV |
| dynamic_info | boolean Whether this brand provides additional dynamic information |