Checkout 3.0
Checkout 3 API Types
Customer Address
Name Type Description FirstName string 0-40 length LastName string 0-40 length Address1 string 0-100 length Address2 string 0-100 length Zip string 5 length City string 0-30 length Country string Mandatory if Branch setup contains ShowCountryInCheckoutForm set on true CareOfAddress bool True if address is ‘C/O’ type. Otherwise false
Company Address
Name Type Description Name string 0-40 length Address1 string 0-100 length Address2 string 0-100 length Zip string 5 length City string 0-30 length Country string Mandatory if Branch setup contains ShowCountryInCheckoutForm set on true CareOfAddress bool True if address is ‘C/O’ type. Otherwise false
Delivery Address
Name Type Description Type DeliveryAddressType Type of address (Private/Company) ViewType DeliveryAddressViewType State of address FirstName string 0-40 length LastName string 0-40 length Address1 string 0-100 length Address2 string 0-100 length Zip string 5 length City string 0-30 Country string Mandatory if Branch setup contais ShowCountryInCheckoutForm set on true CareOfAddress bool True if address is ‘C/O’ type. Otherwise false
Delivery Address Type
Name Value Description Default "Default"Delivery address type can not be changed. The Private type is used as default Private "Private"Delivery address type is set on Private Company "Company"Delivery address type is set on Company
Delivery Address View Type
Name Value Description Unchecked "Unchecked"Delivery address is not specified. InvalidEditable "InvalidEditable"Delivery address is in editable state ValidPreview "ValidPreview"Delivery address is specified and valid
Purchase Mode Type
Name Value Description B2C "B2C"The purchase is made on end-customer’s own name. B2B "B2B"The purchase is made on behalf of an organization.
Check-box state Type
Name Value Description Hidden "Hidden"Check-box input is hidden Unchecked "Unchecked" Check-box input is unchecked Checked "Checked" Check-box input is checked
Language
For language you can either use enum value or string value.
Name Value String Value Description English 0"English"English language Swedish 1 "Swedish"Swedish language Finnish 2"Finnish"Finnish language Norwegian 3"Norwegian"Norwegian language Estonian 4"Estonian"Estonian language Danish 5"Danish"Danish language Czech 6"Czech"Czech language Latvian 7"Latvian"Latvian language Slovak 9"Slovak"Slovak language Polish 10"Polish"Polish language
Payment Method Type
Name Value Invoice "Invoice"Loan "Loan"Card "Card"DirectPayment "DirectPayment"PartPayment "PartPayment"Swish "Swish"HighAmountLoan "HighAmountLoan"PayPal "PayPal"PayOnDelivery "PayOnDelivery"B2BInvoice "B2BInvoice"DirectInvoice "DirectInvoice"Masterpass "Masterpass"MobilePay "MobilePay"Vipps "Vipps"ZeroAmount "ZeroAmount"
Item
Property Data type Description Description string Item name / 0-35 length Notes string Item notes / 0-35 length Amount string Price of the product inclusive of tax TaxCode string Tax code TaxAmount string Tax amount Quantity decimal Quantity of the same product. If quantity is used, the amount and taxAmount parameter should be defined for a single item.
Checkout Setup
Property Data type Description SelectedPaymentMethodType PaymentMethodType Preselected payment method. (Setup is not applicable for the Sweden market ) RecurringPayments CheckBoxStateType List of item objects . Can be set only when Checkout site definition have allowed Recurring payments EmailInvoice CheckBoxStateType Setup of recurring send invoice by email check-box. Can be set only when Checkout site definition have allowed Email invoice Language Language In which language to display the checkout form. Mode PurchaseMode B2C or B2B. Default is B2C CompletedNotificationUrl string Callback URL called after complete payment DisplayItems bool Parameters that tells whether the item list should be displayed inside the checkout form. If true, checkout will contains view with purchase list of items. smsNewsletterSubscriptionText string Custom SMS newsletter subscription text visible when completing payment. This setup will replace default text. emailNewsletterSubscriptionText string Custom Email newsletter subscription text visible when completing payment. This setup will replace default text. SmsNewsletterSubscription CheckBoxStateType Whether to offer a SMS newsletter subscription and whether it should be selected by default. EmailNewsletterSubscription CheckBoxStateType Whether to offer a Email newsletter subscription and whether it should be selected by default. DifferentDeliveryAddress CheckBoxStateType Delivery address check-box setup. Checked can be only with valid delivery address TermsAndConditionsUrl string Custom T&C link. This setup replace set T&C link from Partner onboarding application IntegrityConditionsUrl string Custom integrity link. This setup replace set T&C link from Partner onboarding application EnableB2BLink bool Enable or disable b2b link visibility EnableCountrySelector bool Enable or disable country selector ShowThankYouPage bool Parameter to show or hide thank you page
B2C Info
Property Data type Description CustomerToken string Customer’s token InvoicingAddress AddressCustomer Customer’s invoicing address DeliveryAddress DeliveryAddress Customer’s delivery address UserInputs UserInputs User inputs
B2B Info
Delivery Address
Property Data type Description Address1 string 0-100 length Address2 string 0-100 length Zip string 5 length City string 0-30 length Country string Mandatory if Branch setup contains ShowCountryInCheckoutForm set on true FirstName string 0-40 length LastName string 0-40 length Type DeliveryAddressType Type of address (Private/Company)
Property Data type Description Phone string Customer’s phone number passed by a partner’s application. Email string Customer’s e-mail address passed by a partner’s application.
Property Data type Description Phone string Customer’s phone number passed by a partner’s application. Email string Customer’s e-mail address passed by a partner’s application. Reference string Custom customer’s reference for payment identifying
Property Data type Description OrderReference string Merchant custom ID reference LoyaltyNumber string Can be a number of a customer’s membership card. ProductGroup string Defined the product category. Attachment string Random merchant’s data (some kind of serialized JSON for example) Description string An optional description provided by partner. May be multi-line and may contain whatever the partner wants. ReferenceName string Merchant custom value Reference name PosId string Merchant custom PosId
Partner’s purchase identifiers
Name Data Type Description Description string An optional description provided by partner. May be multi-line and may contain whatever the partner want OrderReference string Merchant custom ID reference LoyaltyNumber string Can be a number of a customer’s membership card. ProductGroup string Just a string that defines the product category. Allow anything for now. Will be defined later. Attachment string Random merchant’s data (some kind of serialized JSON for example) ReferenceName string Merchant custom value Reference name
Name Data Type Description SiteCode string Code of the site in which the purchase has been made. CountryCode string The three-letters country code of the site. CurrencyCode string The three-letter code of the currency in which the purchase has been made.
B2C State
B2C Step
Name Data Type Description CustomerToken string Customer token Current B2CStepType Latest purchase state type RememberMe CheckBoxStateType Checkbox state of remember me SmsNewsletterSubscription CheckBoxStateType Checkbox state of sms newsletter subscription EmailNewsletterSubscription CheckBoxStateType Checkbox state of email newsletter subscription
Card State
Name Data Type Description MaskedCardNumber string If card payment method was selected, Masked card number used card CardBrand string If card payment method was selected, brand of used card CardExpirationDate string If card payment method was selected, expiration date of used card
Name Data Type Description Email string Customer’s e-mail address passed by a partner’s application. Zip string Customer’s zip code passed by a partner’s application. Ssn string Customer’s social security number Phone string Customer’s phone number passed by a partner’s application.
B2B State
B2B Step
Name Data Type Description Email string Customer’s e-mail address passed by a partner’s application. Zip string Customer’s zip code passed by a partner’s application. CompanySsn string Company social security number CustomerSsn string Referrer’s social security number Phone string Customer’s phone number passed by a partner’s application.
B2B Customer Info
Name Data Type Description FirstName string Referrer’s First name. LastName string Referrer’s Last name.
Authentication Type
Name Value Description None “None” No third party verification BankId “BankId” Verification pass via BankId Tupas “Tupas” Verification pass via Tupas
Form Payments
Payment Method
Name Type Description Type PaymentMethodType Type of Payment method RecurringPayment CheckBoxStateType State of recurring payment check-box RecurringPaymentToken string Generated recurring payment token
