Checkout parameter reference

This page contains all available parameters and properties that you can use to initialize and customize Paybyrd Checkout.

Query parameters

These parameters are part of the Checkout URL. Use them to generate and customize the payment gateway.

Parameter	Type	Required	Description
`orderId`	GUID	Yes	Identifies the order that the user sees during checkout. Generated during order creation.
`checkoutKey`	GUID	Yes	Identifies the checkout session that the user accesses. Generated during order creation.
`configs`	JSON object encoded to base64 string	No	Enables further customization for the payment gateway. See Checkout customization.

Pathname properties

Use this property in the pathname of the checkout URL to set any of the 4 display variants.

Property Type Required Example value Description

Property	Type	Required	Example value	Description
`https://chk.paybyrd.com/<variant>?checkoutKey=...`	pathname	No	`https://chk.paybyrd.com/detailed?checkoutKey=...`	Set any of the 3 display variants. The accepted values are `default`, `immersive`, `detailed`, `minimal`. When not set, falls back to `default`.

https://chk.paybyrd.com/<variant>?checkoutKey=...

pathname

https://chk.paybyrd.com/detailed?checkoutKey=...

Set any of the 3 display variants.

The accepted values are default, immersive, detailed, minimal.

When not set, falls back to default.

Usage example

Load a Checkout instance using the ...

default display variant, with no pathname property: https://chk.paybyrd.com/?checkoutKey=<…>&orderId=<…>&configs=<…>
immersive display variant: https://chk.paybyrd.com/immersive?checkoutKey=<…>&orderId=<…>&configs=<…>
detailed display variant: https://chk.paybyrd.com/detailed?checkoutKey=<…>&orderId=<…>&configs=<…>
minimal display variant: https://chk.paybyrd.com/minimal?checkoutKey=<…>&orderId=<…>&configs=<…>

Visit the Checkout guide to see how the different display variants look like.

Checkout customization parameters

Add these parameters to the configs object during initialization to further customize the checkout experience. The configs object should be encoded to base64 format and then used as a query parameter in the checkout URL.

Learn how to set these parameters in the Checkout usage guide.

Parameter	Type	Required	Example value	Description
`locale`	string / enum	No	EN	Define the display language of Checkout. The available values are: `en-US`, `en-UK`, `pt-PT`, `pt-BR` Defaults to `en-US`, English.
`logoUrl`	string / uri	No	https://domain.com/files/logo.png	A URL that points to your logo. Accepted file mime types are `JPG`, `PNG`, and `SVG`. We recommend keeping the file sizes minimized to avoid slowing down page loads.
`hideLogo`	boolean	No	true or false	Define whether your logo is visible for the end user within the payment gateway.
`showHeader`	boolean	No	true or false	Show or hide header. Defaults to `true`.
`showFooter`	boolean	No	true or false	Show or hide footer. Defaults to `true`.
`showCancelButton`	boolean	No	true or false	Define whether you want to display a "Cancel Payment" button. Pushing this button automatically changes the status of the order to Cancelled and redirects the user to the `redirectUrl`. Defaults to `false`.
`showOrderSummary`	boolean	No	true or false	Define whether you want to display a summary of the order for the end user. This screen is displayed at the beginning of the payment process. Defaults to `true`.
`fullscreenModals`	boolean	No	true or false	Enables displaying external modals in full screen. Examples include 3DSecure checks or any other MFA methods that open up in an external modal. Defaults to `false`.
`defaultPaymentMethod`	string / enum	No	CARD	Redirect the user to a predefined payment method. If the `defaultPaymentMethod` you define is not available, the user sees the default payment list. When there is only one available payment method, Checkout automatically redirects the user to that method. `defaultPaymentMethod` is ignored in this case. When you define `defaultPaymentMethod` but there is more than one method available, the user is redirected to the defined payment method, and Checkout shows a back button. This enables the user to select a different payment method. Default is undefined. Accepted values are: `AMEX`, `APPLE`, `ELO`, `MASTER`, `MASTERDEBIT`, `MASTERCARD`, `PAYPAL`, `VISAELECTRON`, `VISADEBIT`, `VISA`, `DISCOVER`, `SIBS_MULTIBANCO`, `MULTIBANCO`, `SIBS_MBWAY`, `MBWAY`, `IDEAL`, `MAESTRO`, `CARTEBANCAIRE`, `DANKORT`, `DINERS`, `JCB`, `VPAY`, `SEPA`, `MULTICAIXA`, `MULTICAIXA_REF`, `MULTICAIXAEXPRESS`, `BANKTRANSFER`, `PICKUP`, `FLOA`, `FLOA3X`, `FLOA4X`, `FLOA1XD`, `PIX`, `REVOLUTPAY`, `SAMSUNGPAY`, `APPLEPAY`, `NUPAY`, `CREDITCARD`, `KLARNA`, `HIPERCARD`, `UNIONPAY`
`redirectUrl`	string / uri	Yes	https://domain.com/payment-validation	Redirects the user to this URL after the payment is finished.
`autoRedirect`	boolean	No	true or false	Define whether you redirect the user after a payment in the payment gateway to the address you set in `redirectUrl`. When set to false, the user sees the Paybyrd payment validation page. Defaults to `false`.
`skipATMSuccessPage`	boolean	No	true or false	When `true`, redirects the user to the `redirectUrl` instead of displaying the entity and reference values used for ATM payments. This enables you to handle the payment process manually. Defaults to `false`.
`skipMBWayWaitingForPaymentScreen`	boolean	No	true or false	Show or skip the polling screen for phone payments, specifically for MBWay. When set to `true`, redirects the user to the `redirectUrl`. Defaults to `false`.

Usage example

Form the URL using this pattern:

 https://chk.paybyrd.com/?checkoutKey={CHECKOUT_ID}&orderId={ORDER_ID}&configs={CONFIGS}

Where {CONFIGS} is a JSON object encoded to base64 format:

{
   "redirectUrl":"https://your-site-url/payment-finished",
   "locale":"en_US",
   "theme":{
      "backgroundColor":"#F0F0F0",
      "formBackgroundColor":"#3C3C3C",
      "primaryColor":"#CCCCCC",
      "textColor":"#FFFFFF",
      "effectsBackgroundColor":"#DBDBDB"
   },
   "autoRedirect":true,
   "showCancelButton":false
}

ewogICAicmVkaXJlY3RVcmwiOiJodHRwczovL3lvdXItc2l0ZS11cmwvcGF5bWVudC1maW5pc2hlZCIsCiAgICJsb2NhbGUiOiJlbl9VUyIsCiAgICJvcmRlcklkIjoiMTNhOGExNTctODFjOS00NmVhLTg0YjQtMmJlZjZkYWFkM2ZhIiwKICAgImNoZWNrb3V0S2V5IjoiZXlKUGNtUmxja2xrSWpvaU16RmhNRFl6TW1JdE9EY3hNeTAwTmpJd0xUaGlaakl0TURkaU4yVXlaVGs1TVRSaklpd2lUM0prWlhKU1pXWWlPaUkwTVRBeE1qQTNNVFUwSWl3aVVHVnljMjl1U1dRaU9qRXdMQ0pNYVhabElqcG1ZV3h6WlN3aVJXNTBhWFI1U1dRaU9pSXpNV0V3TmpNeVlpMDROekV6TFRRMk1qQXRPR0ptTWkwd04ySTNaVEpsT1RrZU5HTWlMQ0pCYlc5MWJuUWlPaUkxTUM0d01DSXNJa04xY25KbGJtTjVJam9pUlZWU0luMD0iLAogICAidGhlbWUiOnsKICAgICAgImJhY2tncm91bmRDb2xvciI6IiNGMEYwRjAiLAogICAgICAiZm9ybUJhY2tncm91bmRDb2xvciI6IiMzQzNDM0MiLAogICAgICAicHJpbWFyeUNvbG9yIjoiI0NDQ0NDQyIsCiAgICAgICJ0ZXh0Q29sb3IiOiIjRkZGRkZGIiwKICAgICAgImVmZmVjdHNCYWNrZ3JvdW5kQ29sb3IiOiIjREJEQkRCIgogICB9LAogICAiYXV0b1JlZGlyZWN0Ijp0cnVlLAogICAic2hvd0NhbmNlbEJ1dHRvbiI6ZmFsc2UsCn0=