On This Page
FILTER BY TAG

Request Parameters

Your
getCards()
 request can include these parameters:

Request Parameters

Field
Required?
Description
version
Type
:
String
Required
Specifies which version of
Unified Click to Pay
 to use.
Maximum length: 60 characters.
targetOrigins
Type
:
List<String>
Required
Defines the website origins where
Unified Click to Pay
 is launched. Each entry must include scheme (protocol), hostname (domain), and optional port. Must use https://hostname (except http://localhost). Wildcards are not supported; all subdomains and ports must be explicitly listed. Any valid top‑level domain is supported (such as .com, .co.uk, .gov.br). If multiple nested iframes are used, the origins of all browser contexts must be included. 
targetOrigins: [ 
"https://example.com", 
"https://basket.example.com", 
"https://ecom.example.com" 
]
data
Type
:
object
Required
Required container object that holds
Unified Click to Pay
 configuration parameters.
allowedCardNetworks
Type
:
object
Required
Lists the card networks enabled for the
Unified Click to Pay
 transaction.
Currently supported values are:
  • VISA
  • MASTERCARD
  • AMEX
country
Type
:
string
Required
Country where the purchase originates (typically the merchant’s country). Must be a two‑character ISO 3166‑1 country code.
Examples:
  • US
  • GB
  • BR
locale
Type
:
string
Required
Defines the language and regional localization of the checkout experience. Must conform to ISO 639‑1 language codes combined with two‑character ISO country codes.
Refer to the list of Supported Locales for Unified Checkout.
Examples:
  • en_US
  • fr_FR
  • pt_BR
billingType
Type
:
string
Reqyured
Configures the level of billing address information collected during checkout.
Maximum length: 25 characters.
Supported values:
  • FULL
     – capture complete billing address
  • PARTIAL
     – capture first name, last name, country, and postal/zip code only
  • NONE
     – capture first name and last name only
billingCountries
Type
:
List<String>
Optional
List of countries from which billing addresses are accepted. Must use two‑character ISO 3166‑1 country codes.
shippingCountries
Type
:
List<String>
Optional
List of countries from which shipping addresses are accepted. Must use two‑character ISO 3166‑1 country codes.
consumerNationalIdentifierRequested
Type
:
boolean
Optional
Indicates whether to request the consumer’s national identifier during checkout. Applicable primarily for Brazil.
Defaults to
false
 if not provided.

data

Data Element
Required?
Description
orderInformation
Type
:
object
Required
Contains the order information for the transaction including the order amount and currency.

Order Information

Data Element
Required?
Description
amountDetails
Type
: object
Required
Contains the information about the transaction amount.

amountDetails

Data Element
Required?
Description
totalAmount
Type
: String
Required
This field defines the total order amount.
currency
Type
: String
Required
This field defines the currency applicable to the order.
RELATED TO THIS PAGE