Parameters description

This Page contains descriptions of the Checkout widget parameters.

Session parameters

Parameter NameDescription
cashier_keyCredentials provided by BridgerPay that identify a merchant when creating a Cashier session.
order_idTransaction ID within the merchant's system.
currencyCurrency in which a customer's transaction (deposit) will be originated; designated according to ISO 4217 β€” Currency Codes (e.g. "USD", "CNY", or "EUR").
countryCountry where the payment transaction will be made; designated according to ISO 3166-1 β€” Country Codes (e.g. "US", "CN", or "BE").

🚧

The parameters described above are mandatory and checkout will not be generated without them.


Customer's personal and contact information:

Parameter NameDescription
fist_nameCustomer's first name. The value is concatenated to fill the read-only "Card Holder Name" field on the UI in case the customer plans to pay with a debit or credit card.
last_nameCustomer's last name. The value is concatenated to fill the read-only "Card Holder Name" field on the UI in case the customer plans to pay with a debit or credit card.
emailCustomer's email address.
addressCustomer's residential address.
stateCustomer's country (i.e., the state where the payment transaction will be made; applicable to the USA, Canada, and Australia. The format must be in ISO format.)
cityCustomer's city.
zip_codeCustomer's ZIP code.
phoneCustomer's international phone number i.e. +3271440600.

Business Information:

Parameter NameDescription
amountTransaction amount. If not specified, a default varying value is assigned and shown on the UI.
affiliate_idAffiliate or intermediary ID.
tracking_idTracking ID associated with the affiliate or intermediary.
platform_idMerchant's platform ID.

Business Restrictions:

Parameter NameDescription
single_payment_methodThe parameter enabling customers to make payments using a designated method, with potential values "credit_card," "apm," "wire_transfer," "crypto," and "external_link."
single_payment_providerThe parameter facilitating customer payments via a designated Payment Service Provider (PSP), such as "Stripe".
single_payment_mid_aliasThe parameter enabling customers to make payments using a designated MID, such as "Stripe-CreditCard-MID-1"
currency_lockProhibit the alteration of currency value by the customer.
amount_lockProhibit the alteration of amount value by the customer.
direct_payment_methodParameter defining which payment method will be suggested to the customer by default (e.g., "credit_card", "apm", "crypto").
languageThe language utilized within the Cashier interface, specified in accordance with ISO 639-1 Language Codes.
hide_languages_dropdownHides the language selection option on the Cashier widget.
hide_headerHides the welcome back message.
themeChange the theme of the checkout. Can be "dark" , "light", "transparent" or "bright".
deposit_button_textThe textual content displayed on the payment button.
button_modeThe Checkout widget can be statically embedded in a merchant's website or can be invoked by clicking a button. (e.g., "modal" - the widget opens as a pop-up window. "tab": it opens in the active web page replacing the existing content, or in a new tab if the appropriate attribute of "_blank" has been added. "spot": it opens in the active web page but right below the invoking button as a separate module, without replacing the existing content.)
button_textThe textual content displayed on the button mode.
splash_screen_image_urlA URL pointing to a static or animated image that will replace the default image when opening a Checkout widget. Please note that this parameter does not apply if you utilize a button to initiate the Cashier widget (refer to "button_mode") or integrate the widget as an iFrame.
validate_inputs_on_focus_outThe parameter signifies the presence of invalid data within an input field. When set to 'true', the field will be visually highlighted as soon as the customer removes the cursor from it.
always_visible_inputs_for_providersThis parameter provides the ability to define the visibility of specific fields on the checkout for credit card solutions, even if they are included in the session creation. For example, you can use the following format: { "address": ["credit_card"] }
pay_modeThis parameter overwrites the default "Deposit" button text on the cashier widget with "Pay". The acceptable values for this parameter are "true" or "false":

Optional Parameters:

Parameter NameDescription
tick_save_credit_card_checkbox_by_defaultThe parameter indicating that the checkbox for saving the debit or credit card is preselected by default.
hide_save_credit_card_checkboxThe parameter hides the checkbox for saving the debit or credit card as a token within the Cashier widget.
show_placeholder_for_cvvThis parameter enables the addition of a placeholder for the CVV code within the Cashier widget.
dont_render_card_holder_name_in_uppercaseThis parameter prevents the cardholder's name from being rendered in uppercase within the Cashier widget.
hide_payment_methodsThis parameter hides specific payment methods from the checkout, such as "crypto" and "apm".
hide_payment_providersThis parameter hides specific payment providers from the checkout, such as "hayvn_pay" and "skrill".
hide_card_holder_name_when_full_name_is_availableThis parameter conceals the cardholder's name in the event that both the first and last names are provided within the request.

Checkout Theme Options:

Parameter NameDescription
themeChange the theme of the checkout. Can be "dark" , "light", "transparent" or "bright".