Shopper Info

info

shopperInfo is used to request specific information from the shopper during the checkout process, such as their SSN, email address, or phone number.

You can define whether a field is required, optional, or hidden.
If prefilled values are available, they can also be provided. Prefilled values cannot be altered by shopper.

This information can be used for verification, record-keeping, or integration with your internal systems.

Request Example

{
  "type": "PayByLink",
  "terminalIdentifier": "1adfe4a1",
  "amount": 48900,
  "currency": "ISK",
  "shopperInfo": [
    {
      "field": "Ssn",
      "requirementType": "Required",
      "prefilledValue": null
    },
  ]
}

Request Field

Field	Subfield	Type	Required	Description	Example	Allowed Values
items		Array	Optional	List of shopper fields to request during checkout.	-	200
	field	String	Required	Name of the shopper field to collect.	Ssn	Ssn, FullName, Address, PostCode, City, Country, Telephone, EmailAddress, Comments
	requirementType	String	Required	Defines whether the field is Required, Optional, or Hidden.	Required	Hidden, Optional, Required, Prefilled
	prefilledValue	String	Optional	Value that will be pre-filled in the field if available. Must match field format and validation rules.	-	Only when requirementType is 'Prefilled'