--- title: "Initialize a transaction" method: POST path: "/v1/transactions" tags: ["/v1/transactions"] --- # Initialize a transaction `POST /v1/transactions` Securely send all the needed parameters to the transaction initialization API. The result of this API call is a `HTTP 201` status code with a `transactionId` in the response body and the `Location` header set. This call is required to proceed with our Redirect and Lightbox integration ## Request body - InitRequest - `amount` integer — The amount of the transaction in the currency’s smallest unit. For example use 1000 for CHF 10.00. Can be omitted for use cases where only a registration should take place (if the payment method supports registrations) - `currency` string, required — 3 letter ISO-4217 character code. For example `CHF` or `USD` - `refno` string, required — The merchant's reference number. It should be unique for each transaction. - `refno2` string — Optional customer's reference number. Supported by some payment methods or acquirers. - `customer` CustomerRequest — Whenever the payment method supports customer details, the `customer` object can be used. The required fields may vary depending on the payment method. For example, in some cases the field `birthDate` is mandatory. - `id` string — Unique customer identifier - `title` string — Something like `Ms` or `Mrs` - `firstName` string — The first name of the customer. - `lastName` string — The last name of the customer. - `street` string — The street of the customer. - `street2` string — Additional street information. For example: '3rd floor' - `city` string — The city of the customer. - `country` string — 2 letter ISO 3166-1 alpha-2 country code - `zipCode` string — Zip code of the customer. - `phone` string — Phone number of the customer. - `cellPhone` string — Cell Phone number of the customer. - `email` string — The email address of the customer. - `gender` string — Gender of the customer. `female` or `male`. - `birthDate` string, date — The birth date of the customer. Must be in ISO-8601 format (`YYYY-MM-DD`). - `language` string — The language of the customer. - `type` string — `P` or `C` depending on whether the customer is private or a company. If `C`, the fields `name` and `companyRegisterNumber` are required - `name` string — The name of the company. Only applicable if `type=C` - `companyLegalForm` string — The legal form of the company (AG, GmbH, ...) - `companyRegisterNumber` string — The register number of the company. Only applicable if `type=C` - `ipAddress` string — The ip address of the customer. - `billing` BillingAddress - `gender` string — Gender of the person - `title` string — Title of the person - `name` string — Name of the person - `firstName` string — First name of the person - `lastName` string — Last name of the person - `email` string — Email of the person - `street` string — Street of the person - `street2` string — Secondary street name of the person - `zipCode` string — Postal code of the person - `city` string — City of the person - `country` string — ISO 3166-1 alpha-3 country code of the person - `countrySubdivision` string — Country subdivision of the person - `sortingCode` string — The sorting code of the person - `phoneNumber` string — Phone number of the person - `shipping` ShippingAddress — The address where the article(s) should be sent to. - `gender` string — Gender of the person - `title` string — Title of the person - `name` string — Name of the person - `firstName` string — First name of the person - `lastName` string — Last name of the person - `email` string — Email of the person - `street` string — Street of the person - `street2` string — Secondary street name of the person - `zipCode` string — Postal code of the person - `city` string — City of the person - `country` string — ISO 3166-1 alpha-3 country code of the person - `countrySubdivision` string — Country subdivision of the person - `sortingCode` string — The sorting code of the person - `phone` string — Phone number of the person - `cellPhone` string — Cell phone number of the person - `carrier` string — Shipping carrier to be used. For example: `DHL`, `Express` - `price` integer — Value of all items in the basket, in smallest available unit. - `priceGross` integer — Gross value of all items in the basket, in smallest available unit. - `order` OrderRequest — If supported by the payment method, an order with one or more articles can be defined. - `articles` Article[] - `id` string — The article identifier. - `name` string — The name of the article. - `description` string — The description of the article. - `imageUrl` string — A https URL to the image of the article. - `price` integer — The line item price including the VAT. - `priceGross` integer — The article gross price including VAT. - `quantity` integer — The number of similar articles on the current invoice line item. - `tax` integer — This field is deprecated. Please use `taxAmount` for the tax amount and `taxPercent` for the tax rate. - `taxPercent` number, double — The tax rate in percent [%]. - `taxAmount` integer — The tax amount in the currency’s smallest unit. For example use 1000 for CHF 10.00. - `priceWithoutVAT` integer — The article price without VAT - `discount` integer — The article discount. - `type` string — The type of the article. Possible values vary per payment method. - `taxAmount` integer - `shippingAmount` integer - `discountAmount` integer - `autoSettle` boolean — Whether to automatically settle the transaction after an authorization or not. If not present with the init request, the settings defined in the dashboard ('Authorisation / Settlement' or 'Direct Debit') will be used. Those settings will only be used for web transactions and not for server to server API calls. - `option` OptionRequest - `createAlias` boolean — Whether an alias should be created for this transaction or not. If set to `true` an alias will be created. This alias can then be used to [initialize](#operation/init) or [authorize](#operation/authorize) a transaction. One possible use case is to charge the card of an existing (registered) cardholder. - `returnMaskedCardNumber` boolean — Whether to return the masked card number. Format: `520000xxxxxx0080` - `returnCustomerCountry` boolean — If set to `true`, the country of the customers issuer will be returned. - `authenticationOnly` boolean — Whether to only authenticate the transaction (3D process only). If set to `true`, the actual authorization will not take place. - `rememberMe` 'true' | 'checked' — Whether to show a checkbox on the payment page to let the customer choose if they want to save their card information. - `returnMobileToken` boolean — Indicates that a mobile token should be created. This is needed when using our Mobile SDKs. - `storeCustomerData` boolean — If `true`, the values passed in the customer object are stored and visiblein the web admin tool on the transaction details. If `false`, no customer data will bestored. - `language` 'en' | 'de' | 'fr' | 'it' | 'es' | 'el' | 'fi' | 'hu' | 'ko' | 'nl' | 'no' | 'da' | 'pl' | 'pt' | 'ru' | 'ja' | 'sk' | 'sl' | 'sv' | 'tr' | 'zh' — This parameter specifies the language (language code) in which the payment page should be presented to the cardholder. The ISO-639-1 two letter language codes listed above are supported - `redirect` RedirectRequest — The redirect object is used to customize the browser behaviour when using the payment page (Redirect or Lightbox Mode) to do a transaction. - `successUrl` string — The URL where the customer gets redirected to if the transaction was successful. - `cancelUrl` string — The URL where the customer gets redirected to if the transaction was canceled. - `errorUrl` string — The URL where the customer gets redirected to if an error occurred. - `startTarget` string — If the payment is started within an iframe or when using the Lightbox Mode, use value `_top`. This ensures a proper browser flow for payment methods who need a redirect. - `returnTarget` string — If the payment is started within an iframe or when using the Lightbox Mode, use `_top` if the redirect URLs should be opened full screen when payment returns from a 3rd party (for example 3D). - `method` 'GET' | 'POST' — The preferred HTTP method for the redirect request (`GET` or `POST`). When using GET as a method, the query string parameter `datatransTrxId` will be added to the corresponding return url upon redirection. In case of POST, all the query parameters from the corresponding return url will be moved to the application/x-www-form-urlencoded body of the redirection request along with the added `datatransTrxId` parameter. - `theme` Theme — The theme (including configuration options) to be used when rendering the payment page. - `configuration` ThemeConfiguration — Theme configuration options when using the default `DT2015` theme - `brandColor` string — Hex notation of a color - `textColor` 'white' | 'black' — The color of the text in the header bar if no logo is given - `logoType` 'circle' | 'rectangle' | 'none' — The header logo's display style - `logoBorderColor` string — Decides whether the logo shall be styled with a border around it, if the value is true the default background color is chosen, else the provided string is used as color value - `brandButton` string — Decides if the pay button should have the same color as the brandColor. If set to false the hex color #01669F will be used as a default - `payButtonTextColor` 'black' | 'white' — The color of the pay button - `logoSrc` string — An SVG image provided by the merchant. The image needs to be uploaded by using the Datatrans Web Administration Tool - `initialView` 'list' | 'grid' — Wheter the payment page shows the payment method selection as list (default) or as a grid - `brandTitle` boolean — If set to `false` and no logo is used (see `logoSrc`), the payment page header will be empty - `webhook` WebhookRequest — Used to define the webhook configuration. If not set, the webhook configuration from the merchant configuration will be used. - `url` string, required — The URL where the webhook has to be sent to. - `paymentMethods` string[] — An array of payment method shortnames. For example `["VIS", "PFC"]`. If omitted, all available payment methods will be displayed on the payment page. If the Mobile SDKs are used (`returnMobileToken`), this array is mandatory. - `card` union - object — Plain card authorization - `type` string, required - `number` string — Merchants that have the option to store card information on their end can use the `number` property instead of `alias`. Please note that this option is only available to merchants that fulfill the requirements by PCI DSS to store sensitive information on their side and only upon request. - `expiryMonth` string — The expiry month of the credit card. - `expiryYear` string — The expiry year of the credit card. - `cardOnFile` CardOnFileInit — Card On File (COF) parameters. COF usually is handled by Datatrans aliases. This feature is only for specific use cases where the Datatrans alias solution cannot be used. This feature needs to be enabled on the merchant configuration by Datatrans. - `enroll` boolean — If `true`, a Card On File (COF) enrollment is performed. The created card on file ID will be returned in the webhook after a successful authorization. This COF ID can be reused in subsequent MIT authorizations. - `id` string — The card on file ID to be used for this transaction. - `3D` CardInitThreeDSecure — If 3D authentication data is available, the `3D` object can be used to send the relevant 3D parameters. Please get in contact with us if you have a dedicated 3D provider. - `threeDSRequestor` ThreeDSRequestor - `threeDSRequestorAuthenticationInd` '01' | '02' | '03' | '04' | '05' | '06' - `threeDSRequestorAuthenticationInfo` ThreeDSRequestorAuthenticationInformation - `threeDSReqAuthMethod` '01' | '02' | '03' | '04' | '05' | '06' - `threeDSReqAuthTimestamp` string, date-time - `threeDSReqAuthData` string - `threeDSRequestorChallengeInd` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '82' | '90' - `threeDSRequestorDecReqInd` 'Y' | 'N' - `threeDSRequestorDecMaxTime` integer - `threeDSRequestorURL` string, url — Fully qualified URL of 3DS Requestor website or customer care site. This field is optional and it is recommended to be configured in the configuration. - `cardholderAccount` CardholderAccount - `cardExpiryDate` string - `acctInfo` CardholderAccountInformation - `chAccDate` string, date-time - `chAccChangeInd` '01' | '02' | '03' | '04' - `chAccChange` string, date-time - `chAccPwChangeInd` '01' | '02' | '03' | '04' | '05' - `chAccPwChange` string, date-time - `shipAddressUsageInd` '01' | '02' | '03' | '04' - `shipAddressUsage` string, date-time - `txnActivityDay` integer - `txnActivityYear` integer - `provisionAttemptsDay` integer - `nbPurchaseAccount` integer - `suspiciousAccActivity` '01' | '02' - `shipNameIndicator` '01' | '02' - `paymentAccInd` '01' | '02' | '03' | '04' | '05' - `paymentAccAge` string, date-time - `acctID` string - `cardholder` Cardholder - `addrMatch` 'Y' | 'N' - `billAddrCity` string - `billAddrCountry` string - `billAddrLine1` string - `billAddrLine2` string - `billAddrLine3` string - `billAddrPostCode` string - `billAddrState` string - `email` string - `homePhone` CardholderPhoneNumber - `cc` string - `subscriber` string - `mobilePhone` CardholderPhoneNumber - `cc` string - `subscriber` string - `workPhone` CardholderPhoneNumber - `cc` string - `subscriber` string - `cardholderName` string - `shipAddrCity` string - `shipAddrCountry` string - `shipAddrLine1` string - `shipAddrLine2` string - `shipAddrLine3` string - `shipAddrPostCode` string - `shipAddrState` string - `purchase` Purchase - `purchaseInstalData` integer - `merchantRiskIndicator` MerchantRiskIndicator - `shipIndicator` '01' | '02' | '03' | '04' | '05' | '06' | '07' - `deliveryTimeframe` '01' | '02' | '03' | '04' - `deliveryEmailAddress` string - `reorderItemsInd` '01' | '02' - `preOrderPurchaseInd` '01' | '02' - `preOrderDate` string, date-time - `giftCardAmount` integer - `giftCardCurr` string - `giftCardCount` string - `purchaseAmount` integer - `purchaseCurrency` string - `purchaseExponent` integer - `purchaseDate` string, date-time - `recurringExpiry` string, date-time - `recurringFrequency` integer - `transType` '01' | '03' | '10' | '11' | '28' - `merchant` MerchantData - `whiteListStatus` 'Y' | 'N' - `broadInfo` string - `browserInformation` Browser - `browserAcceptHeader` string - `browserIP` string - `browserJavaEnabled` boolean - `browserLanguage` string - `browserColorDepth` '1' | '4' | '8' | '15' | '16' | '24' | '32' | '48' - `browserScreenHeight` integer - `browserScreenWidth` integer - `browserTZ` integer - `browserUserAgent` string - `challengeWindowSize` '01' | '02' | '03' | '04' | '05' - `browserJavascriptEnabled` boolean - `threeRIInd` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '80' | '81' | '82' | '83' | '84' | '85' | '86' | '87' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '96' | '97' | '98' | '99' - `apply` boolean — Decides if the 3D secure process should be applied. - `challengeIndicator` string - object — Alias card authorization - `type` string, required - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `expiryMonth` string — The expiry month of the credit card alias. - `expiryYear` string — The expiry year of the credit card alias. - `cardOnFile` CardOnFileInit — Card On File (COF) parameters. COF usually is handled by Datatrans aliases. This feature is only for specific use cases where the Datatrans alias solution cannot be used. This feature needs to be enabled on the merchant configuration by Datatrans. - `enroll` boolean — If `true`, a Card On File (COF) enrollment is performed. The created card on file ID will be returned in the webhook after a successful authorization. This COF ID can be reused in subsequent MIT authorizations. - `id` string — The card on file ID to be used for this transaction. - `3D` CardInitThreeDSecure — If 3D authentication data is available, the `3D` object can be used to send the relevant 3D parameters. Please get in contact with us if you have a dedicated 3D provider. - `threeDSRequestor` ThreeDSRequestor - `threeDSRequestorAuthenticationInd` '01' | '02' | '03' | '04' | '05' | '06' - `threeDSRequestorAuthenticationInfo` ThreeDSRequestorAuthenticationInformation - `threeDSReqAuthMethod` '01' | '02' | '03' | '04' | '05' | '06' - `threeDSReqAuthTimestamp` string, date-time - `threeDSReqAuthData` string - `threeDSRequestorChallengeInd` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '82' | '90' - `threeDSRequestorDecReqInd` 'Y' | 'N' - `threeDSRequestorDecMaxTime` integer - `threeDSRequestorURL` string, url — Fully qualified URL of 3DS Requestor website or customer care site. This field is optional and it is recommended to be configured in the configuration. - `cardholderAccount` CardholderAccount - `cardExpiryDate` string - `acctInfo` CardholderAccountInformation - `chAccDate` string, date-time - `chAccChangeInd` '01' | '02' | '03' | '04' - `chAccChange` string, date-time - `chAccPwChangeInd` '01' | '02' | '03' | '04' | '05' - `chAccPwChange` string, date-time - `shipAddressUsageInd` '01' | '02' | '03' | '04' - `shipAddressUsage` string, date-time - `txnActivityDay` integer - `txnActivityYear` integer - `provisionAttemptsDay` integer - `nbPurchaseAccount` integer - `suspiciousAccActivity` '01' | '02' - `shipNameIndicator` '01' | '02' - `paymentAccInd` '01' | '02' | '03' | '04' | '05' - `paymentAccAge` string, date-time - `acctID` string - `cardholder` Cardholder - `addrMatch` 'Y' | 'N' - `billAddrCity` string - `billAddrCountry` string - `billAddrLine1` string - `billAddrLine2` string - `billAddrLine3` string - `billAddrPostCode` string - `billAddrState` string - `email` string - `homePhone` CardholderPhoneNumber - `cc` string - `subscriber` string - `mobilePhone` CardholderPhoneNumber - `cc` string - `subscriber` string - `workPhone` CardholderPhoneNumber - `cc` string - `subscriber` string - `cardholderName` string - `shipAddrCity` string - `shipAddrCountry` string - `shipAddrLine1` string - `shipAddrLine2` string - `shipAddrLine3` string - `shipAddrPostCode` string - `shipAddrState` string - `purchase` Purchase - `purchaseInstalData` integer - `merchantRiskIndicator` MerchantRiskIndicator - `shipIndicator` '01' | '02' | '03' | '04' | '05' | '06' | '07' - `deliveryTimeframe` '01' | '02' | '03' | '04' - `deliveryEmailAddress` string - `reorderItemsInd` '01' | '02' - `preOrderPurchaseInd` '01' | '02' - `preOrderDate` string, date-time - `giftCardAmount` integer - `giftCardCurr` string - `giftCardCount` string - `purchaseAmount` integer - `purchaseCurrency` string - `purchaseExponent` integer - `purchaseDate` string, date-time - `recurringExpiry` string, date-time - `recurringFrequency` integer - `transType` '01' | '03' | '10' | '11' | '28' - `merchant` MerchantData - `whiteListStatus` 'Y' | 'N' - `broadInfo` string - `browserInformation` Browser - `browserAcceptHeader` string - `browserIP` string - `browserJavaEnabled` boolean - `browserLanguage` string - `browserColorDepth` '1' | '4' | '8' | '15' | '16' | '24' | '32' | '48' - `browserScreenHeight` integer - `browserScreenWidth` integer - `browserTZ` integer - `browserUserAgent` string - `challengeWindowSize` '01' | '02' | '03' | '04' | '05' - `browserJavascriptEnabled` boolean - `threeRIInd` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '80' | '81' | '82' | '83' | '84' | '85' | '86' | '87' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '96' | '97' | '98' | '99' - `apply` boolean — Decides if the 3D secure process should be applied. - `challengeIndicator` string - object — Device token authorization - `type` string, required - `token` string, required — Device token value. - `expiryMonth` string, required — The expiry month of the network token. - `expiryYear` string, required — The expiry year of the network token. - `tokenType` 'APPLE_PAY' | 'GOOGLE_PAY' | 'SAMSUNG_PAY', required — The scheme which issued the network token. - `cryptogram` string — The cryptogram of the token - `eci` string — the Eci of the token - `ALP` AlipayRequest — Alipay+ specific parameters - `subtype` 'MINI_APP' — Specify MINI_APP to process a transaction from a mini program. - `paymentMethodType` 'ALIPAY_CN' | 'TRUEMONEY' | 'ALIPAY_HK' | 'TNG' | 'GCASH' | 'DANA' — The Alipay+ specific payment method type used for the transaction. - `appId` string - `AZP` AmazonPayRequest — Amazon Pay specific request parameters - `sellerNote` string — Represents a description of the billing agreement that is shown in emails to the buyer and on the Amazon Pay website. - `fraudContext` AmazonFraudContext — Supplementary data for fraud detection by amazon - `airlineMetaData` AirlineMetaData — Airline Meta Data - `version` string — The version of AirlineMetaData field (used for tracking schema changes to the field) - `airlineCode` string — IATA 2-letter airline code. It identifies the carrier. Example: AA (American Airlines) - `flightDate` string, date-time — Flight departure date. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). The time mentioned here is local time - `departureAirport` string — IATA 3-letter code of the departure airport. Example: CDG - `destinationAirport` string — IATA 3-letter code of the departure airport. Example: LUX - `classOfTravel` 'FIRST_CLASS' | 'BUSINESS_CLASS' | 'ECONOMY' | 'PREMIUM_ECONOMY' — travel class identifier. - `bookedLastTime` integer — Days since the buyer booked a flight to the same destination last time. Use value -1 if buyer books this destination for the first time. - `passengers` Passenger — Passengers information - `numberOfPassengers` integer — Number of passengers - `numberOfChildren` integer — The number of passengers who are children (ages 2 to 18) - `numberOfInfants` integer — The number of passengers who are under the age of 2 - `accommodationMetaData` AccommodationMetaData — AccommodationMetaData - `version` string — The version of AccommodationMetaData field (used for tracking schema changes to the field) - `lengthOfStay` integer — The number of nights that the accommodation was booked for. - `numberOfGuests` integer — The number of guests for which the accommodation is booked - `startDate` string, date-time — The date on which the accommodation starts. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). Internally, Amazon will store the number of days and hours between accommodation.startDate and time of the purchase. - `endDate` string, date-time — The date on which the accommodation ends. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). If accommodation.lengthOfStay is given, we default to an endDate derived from startDate and lengthOfStay. - `starRating` integer — Star rating of the accommodation. From 0 (for no star rating) to 5 (for five star hotels) - `bookedLastTime` integer — Days since the buyer booked the same accommodation last time. Use value -1 if buyer books this accommodation for the first time. - `city` string — The city where the accommodation is located. Example: Milan. - `countryCode` string — ISO 3166-1 alpha-2, two-letter country code, representing the country where the accommodation is located. Example: IT. - `zipCode` string — The zip code of the accommodation address. Example: 40127. - `accommodationType` string — Describes the type of accommodation, valid values:[Hotel] - `accommodationName` string — The name of the accommodation, as provided to the merchant by the accommodation itself. - `class` 'SUITE' | 'STANDARD' | 'DELUXE' — Suite, Standard or Deluxe accommodation - `buyerMetaData` BuyerMetaData — Buyer Meta Data - `version` string — The version of BuyerMetaData field (used for tracking schema changes to the field). - `isFirstTimeCustomer` boolean — True if the buyer is purchasing from the merchant for the first time. Else false. - `numberOfPastPurchases` integer — The number of purchases the buyer has made from the merchant in the past. - `numberOfDisputedPurchases` integer — The number of purchases that has been disputed by the buyer when making purchases from the merchant. - `hasOpenDispute` boolean — True if the buyer has an ongoing dispute regarding a past purchase. - `riskScore` string — The risk score which the merchant computes for a buyer. The value must be a decimal in the range between 0 (lowest risk) and 1 (highest risk). - `userAgent` string — The user agent of the browser used by the buyer to make the purchase on merchant site. Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.102 Safari/537.36. - `language` string — Language in which the buyer is viewing the site at the time of placing the order in 'language-LOCALE' format example: en-US. Use ISO 639-1:2002 code for the language part (en) and ISO 3166-1 alpha-2 for the LOCALE part (US). - `recipientEmailMatches` boolean — True, if the recipient email is exactly the same as the one on the amazon account used for payment, false otherwise. - `buyerIsATraveler` boolean — True, if the account holder of the amazon account is actually one of the travelers, false otherwise. - `orderMetaData` OrderMetaData — Order Meta Data - `version` string — The version of OrderMetaData field (used for tracking schema changes to the field). - `numberOfItems` integer — The number of items that the order contains. For example, two cups of coffee. - `type` 'PHYSICAL' | 'DIGITAL' | 'MIXED' — Type of items. Physical, Digital, Mixed - `relatedOrderReferenceId` string — Order ID of the related order. For the deposit this field will be empty, while for any subsequent payment related to the same booking this will be the order ID of the deposit transaction. - `BON` BoncardRequest — Boncard specific request parameters - `alias` string, required — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `cvv` string - `DVI` DeltaVistaData — DVI has no specific request parameters but we need an empty object here to handle it as a DVI request. - `ELV` ElvInitRequest — ELV specific payment parameters. - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `iban` string - `mandateId` string — The SEPA mandate reference - `mandateText` string - `EPS` EpsRequest — EPS specific request parameters - `bankbic` string — Identification of the customer’s (buyer’s) financial institution by a BIC. - `orderInfoText` string — Text between the beneficiary/merchant and the buyer which will not be part of the payment instruction. If submitted, the final orderInfoText will be: `refno + ' ' + orderInfoText` - `ESY` ESY - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `description` string — A description of the purchase. - `paymentInfo` string — The payment info of the service (also known as billing text). NOTE: The paymentInfo will be placed on the end user invoice bill. - `title` string — The title on top of the Swisscom Pay Payment Page. - `GPA` GPARequest — Giropay specific request parameters - `shoppingCartType` string — The shoppingCartType defines type of the shopping cart. The following values are allowed: PHYSICAL, DIGITAL, MIXED, ANONYMOUS_DONATION, AUTHORITIES_PAYMENT MIXED is the default value. - `INT` ByjunoAuthorizeRequest - `subtype` 'INVOICE' | 'INSTALLMENT' | 'BYJUNO-INVOICE' | 'MONTHLYINVOICE', required — The Byjuno specific payment method used for the transaction. - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `customerEmailConfirmed` boolean — Indicates that the customer email address is confirmed. - `verifiedEmail` boolean — Indicates that the customer email address is confirmed. - `emailVerificationType` 'MERCHANT' | 'CEMBRAPAY' | 'OTHER' — List of possible verification types for customer contacts: - MERCHANT: contact is verified by Merchant. - CEMBRAPAY: contact is verified by CembraPay. - OTHER: contact is verified by 3rd party or somehow else. - `mobileVerificationType` 'MERCHANT' | 'CEMBRAPAY' | 'OTHER' — List of possible verification types for customer contacts: - MERCHANT: contact is verified by Merchant. - CEMBRAPAY: contact is verified by CembraPay. - OTHER: contact is verified by 3rd party or somehow else. - `verifiedMobile` boolean — Indicates that the customer mobile number is confirmed. - `loggedIn` boolean — This field must be set to 'true' in case, if Customer is logged into Merchants system (Customer is known to Merchant). - `isAbove18` boolean — 'true' if Customer(person) is known as person above 18 years old - e.g. Customer had approved this in Merchants system. - `docValidTill` string — Validity date of verified document. ISO8601 Date Only in format 'yyyy-MM-dd'.. - `permitType` string — Type of Swiss Residence permission. Not expected for Customer(company) - `inSwitzerlandSince` string — Date from which Customer(person) lives in Swizerland. ISO8601 Date Only in format 'yyyy-MM-dd'.. Not expected for Customer(company). - `nationality` string — Nationality of Customer(person), ISO3166-1 alpha 2 code (two letters). Not expected for Customer(company) - `phoneBusiness` string — Business phone of the Customer - `payoutInfo` string — Additional Identifier that can be submitted during AUT or CHK and will be shown in CembraPay RAF (Reconciliation Advisory File) to merchant - `downpaymentToMerchantAmount` integer — In case Customer makes downpayment to merchant then it should be provided. This amount is part of the main Amount, so customer will be financed/blocked difference. Amount in smallest money unit for the Currency (cents for CHF). - `subscriptionType` string — If the purchased good is a subscription, the matching Validity should be given. Values: YEARLY, MONTHLY, OTHER - `requestedCreditLimit` integer — Optional amount of requested credit limit, which should be taken into account during Consumer onboarding (for new Consumers) - `customerInfo1` string — Customer information for credit check. - `customerInfo2` string — Customer information for credit check. - `deliveryMethod` string — Can be one of POST (Delivery by Swiss Post), SHOP (Point of Sale) or HLD (Home Delivery Service) - `transactionChannel` string — List of possible transaction channels: - WEB: purchase made via Merchant's web shop. - POS: purchase registered manually by Merchant's employee using Merchants portal provided by CembraPay. - APP: purchase made via Merchant's mobile app. - OTH: other (none of above). - `integrationModule` string — This is optional field to track Integration versioning on the client/merchant side. Used for debugging and traceability. - `deviceFingerprintId` string — Identification of the customer in the shop - `sessionIpPort` string — Source port number from Http Header (first 2 bytes) of the customer browser session should be provided. - `sessionId` string — Browser session id of the customer. - `paperInvoice` boolean — Whether or not to send a paper invoice. - `repaymentType` integer — Number from 1 to 20 to indicate the repayment schedule. This is used in combination with payment methods and defined per client configuration. - `cembraPayPaymentMethod` 'SINGLE-INVOICE' | 'SINGLE-INVOICE-RISKONMERCHANT' | 'CEMBRAPAY-INVOICE' | 'CEMBRAPAY-INVOICE-RISKONMERCHANT' | 'INSTALLMENT_3' | 'INSTALLMENT_4' | 'INSTALLMENT_6' | 'INSTALLMENT_12' | 'INSTALLMENT_24' | 'INSTALLMENT_36' | 'INSTALLMENT_48' | 'INSTALLMENT_3-RISKONMERCHANT' | 'INSTALLMENT_4-RISKONMERCHANT' | 'INSTALLMENT_6-RISKONMERCHANT' | 'INSTALLMENT_12-RISKONMERCHANT' | 'INSTALLMENT_24-RISKONMERCHANT' | 'INSTALLMENT_36-RISKONMERCHANT' | 'INSTALLMENT_48-RISKONMERCHANT' | 'WALLET' | 'CPMI' — Type of CembraPay product. Always required for requests of type REG and SCR. Also is required for requests of type AUT, when token is not provided. List of product types (can be extended by new products). - `riskOwner` 'IJ' | 'CLIENT' — Defines which party should take the risk. - `siteId` string — Can be used in case when client operates different legally separated stores / points of sale. - `verifiedDocument1Type` 'swiss-travel-pass' | 'other' — Indication if merchant is having verified documents from client request. - `verifiedDocument1Number` string — Verified document number. - `verifiedDocument1Issuer` string — Verified document issuer. - `customData` string[] — A list of custom data fields. It can accept up to 10 entries. - `firstRateAmount` integer — Amount of the first rate paid by the customer. - `orderDownpaymentToMerchantAmount` integer — In case Customer makes downpayment to merchant then it should be provided. This amount is part of the main Amount, so customer will be financed/blocked difference. Amount in smallest money unit for the Currency (cents for CHF). - `orderSubscriptionType` 'YEARLY' | 'MONTHLY' | 'OTHER' — If the purchased good is a subscription, the matching Validity should be given. - `customerConsents` CembraPayCustomerConsent[] — List of Customer consents. Mandatory except authorizations submitted by Token to CPMI payment method - `consentType` string — List of possible Consents, consumers can provide to CembraPay: - SCREENING: by providing this consent, consumer agrees that CembraPay can process screening data. Merchant must get this Consent from Consumer before send SCR request to CembraPay Api. - CEMBRAPAY-TC: by providing this consent, consumer agrees with CembraPay terms and conditions. - MARKETING: by providing this consent, consumer agrees that CembraPay can use his data for Marketing purposes. - `consentProvidedAt` string — List of possible Consent providing channels: - MERCHANT: consent collected by Merchant in Merchant web shop. Usually by additions in Merchants Shop terms and conditions. - MERCHANT-POS: consent collected at Merchants Pos - CEMBRAPAY-CHECKOUT: consent collected via CembraPay Checkout UI - CEMBRAPAY-REGISTRATION: consent collected via CembraPay Registration UI - AFFILIATE: consent collected by affiliate - OTHER: other way of collecting consent - `consentDate` string — DateTime when Consent was captured. ISO8601 Date with time in format 'yyyy-MM-ddTHH:mm:ssZ'. - `consentReference` string — The encoded base64 reference to the given consent (document version, URL, registration of agreed terms etc). - `msgExtensions` CembraPayMsgExtension[] — List of additional data entries. Only known Keys will be processed. Prior agreement with CembraPay required about data structure and usage - `key` string — Key is used to identify type of data, provided in Value field. - `value` string — Data provided additionally to common request structure. Value must be base64 encoded. - `KLN` KlarnaInitRequest - `subPaymentMethod` 'pay_now' | 'pay_later' | 'pay_over_time' | 'direct_debit' | 'direct_bank_transfer' — The Klarna specific payment method used for the transaction. - `events` KlarnaEvent[] — A list of Klarna events. - `name` string — The name of the event. - `company` string — The name of the company arranging the event. - `genre` string — The genre of the event. - `arena` KlarnaArena - `name` string — The name of the venue - `street` string — The street of the arena location - `zipCode` string — The postal code of the arena location - `city` string — The city of the arena location - `country` string — The country of the arena location - `start` string, date-time — The start date and time of the event. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `end` string, date-time — The end date and time of the event. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `accessControlledVenue` boolean — Tickets are digitally checked when entering the venue. - `ticketDeliveryMethod` 'PICK_UP' | 'EMAIL' | 'POST' | 'PHONE' — The ticket delivery method. - `ticketDeliveryRecipient` string — The name of the recipient the ticket is delivered to. If the method isEMAIL or PHONE, use either the email address or the phone number. - `affiliateName` string — The name of the affiliate that originated the purchase. - `marketplaceSellerInfo` KlarnaMarketplaceSellerInfo[] — A list of merchants selling goods in marketplaces. - `subMerchantId` string — A unique identifier of the selling or delivering merchant. Example: 1234567890qwertyuiopasdfg - `subMerchantName` string — The name of the selling or delivering merchant. Example: Marketbrick Ltd. - `subMerchantPostalCode` string — The ZIP code of the selling or delivering merchant. - `productCategory` string — The name of the general category to which the specific goods belong, according to the selling merchant's categorization. Example: Computers - `productName` string — The name of the purchased good. Example: Acer 5400 - `accountRegistrationDate` string, date-time — The date and time of the account's registration on the platform. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `accountLastModified` KlarnaAccountLastModified - `password` string, date-time — The date and time of the account's last modification. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `email` string, date-time — The date and time of the account's last email change. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `listing` string, date-time — The date and time of the last change in the listing details. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `login` string, date-time — The date and time of the last login details change. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `address` string, date-time — The date and time of the account's last physical address change. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `sellerRating` number, double — The seller's current rating according to the marketplace rating scale. Partners have to provide their rating scale upfront before the integration's go-live. Example: 4.5 - `numberOfTrades` integer — The number of trades the sub-merchant completed in the previous 12 months. Example: 23 - `digitalDownload` boolean — Set to true if the product being sold is a digital product and can be downloaded after the purchase. - `volumeOfTrades` integer — The volume of trades the sub-merchant completed in the previous 12 months. Example: 230 - `marketplaceWinnerInfo` KlarnaMarketplaceWinnerInfo[] — A list of customers purchasing goods in marketplaces. - `accountRegistrationDate` string, date-time — The date and time of the customer's account registration on the platform. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `accountLastModified` KlarnaAccountLastModified - `password` string, date-time — The date and time of the account's last modification. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `email` string, date-time — The date and time of the account's last email change. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `listing` string, date-time — The date and time of the last change in the listing details. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `login` string, date-time — The date and time of the last login details change. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `address` string, date-time — The date and time of the account's last physical address change. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `numberOfTrades` integer — The number of trades the winner completed in the last 12 months. Example: 5 - `volumeOfTrades` integer — The volume of trades the winner completed in the last 12 months. Example: 230 - `subscriptions` KlarnaSubscription[] — A list of Klarna subscriptions. - `name` string — The name of the product of the subscription - `start` string, date-time — The start date and time of the subscription. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `end` string, date-time — The end date and time of the subscription. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `autoRenewal` boolean — `true` if the subscription will be auto renewed upon expiry. - `affiliateName` string — The name of the affiliate that originated the purchase. - `accountInfos` KlarnaCustomerAccountInfo[] — A list of Klarna customer account infos. - `uniqueIdentifier` string — The unique identifier of the specific customer account. Example: 1234567890qwertyuiopasdfg Length: max 255 - `appId` string — The unique identifier of the user if the same unique_account_identifier is used across multiple systems. Length: max 255 - `loyaltyLevel` 'low' | 'intermediate' | 'high' — The customer's loyalty level with the merchant. This property must be mapped to the tiers in a specific loyalty program. - `customerEmail` string — The primary email associated with the merchant account. - `customerPhone` string — The primary phone number associated with the merchant account. - `customerRanking` integer — The customer's ranking reflecting the behavior in previous transactions. - `customerReviews` integer — The number of reviews registered for the customer. - `lastLoginTime` string, date-time — The date and time of the customer's last login to the platform. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `accountSecurity` KlarnaAccountSecurity — The security settings of the customer's account. - `lastVerificationMethod` string — The type of verification method active for the account. Example: OTP - `lastVerificationTime` string, date-time — The customer account's last verification time. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `deviceId` string — The device ID or fingerprint as tracked by the merchant on their web platform or the app used by the customer. - `fraudBehavior` boolean — Set to true if the merchant has seen any fraudulent behavior in the customer's account. - `devicesLinked` integer — The number of unique devices on which the account has been used. - `phoneVerified` boolean — Set to true if the customer's phone number has been verified. - `emailVerified` boolean — Set to true if the customer's email has been verified. - `failedTransactionsAttempts` integer — The number of failed transaction attempts by the customer in the last 6 months. - `registrationDate` string, date-time — The registration date and time of the account. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `lastModified` string, date-time — The date and time the account was modified the last time. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `historySimple` KlarnaPaymentHistorySimple[] — A list of simple history entries - `uniqueIdentifier` string — Unique name or number to identify the specific customer account. Max. 24 characters. - `paidBefore` boolean — Whether the customer has paid before or not. - `historyFull` KlarnaPaymentHistoryFull[] — A list of full history entries - `uniqueIdentifier` string — Unique name or number to identify the specific customer account. Max. 24 characters. - `paymentOption` 'CARD' | 'DIRECT_BANKING' | 'NON_KLARNA_CREDIT' | 'SMS' | 'OTHER' — The type of the line item - `paidPurchases` integer — The total number of successful purchases. - `totalAmountPaidPurchases` number, double — The total amount of successful purchases (in local currency). - `lastPaidPurchase` string, date-time — The date and time of the last paid purchase. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `firstPaidPurchase` string, date-time — The date and time of the first paid purchase. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `hotelReservationDetails` KlarnaHotelReservationDetail[] — A list of hotel reservation details - `pnr` string — Trip booking number, e.g. VH67899 - `hotelItinerary` KlarnaHotelItinerary[] — Hotel itinerary data, one per hotel stay - `hotelName` string — Name of hotel - `address` KlarnaAddress - `streetAddress` string — The street name and number - `postalCode` string — The postal code - `city` string — The name of the city - `country` string — The name of the country - `startTime` string, date-time — The start date and time of the reservation. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `endTime` string, date-time — The end date and time of the reservation. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `numberOfRooms` integer - `passengerId` integer[] - `ticketDeliveryMethod` 'pick_up' | 'email' | 'post' | 'phone' - `ticketDeliveryRecipient` string — The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number. - `hotelPrice` number — Local currency - `class` string - `insurance` KlarnaInsurance[] — Insurance data - `insuranceCompany` string - `insuranceType` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' - `insurancePrice` number, double - `passengers` KlarnaPassenger[] — Passenger data - `id` integer - `title` 'MR' | 'MRS' | 'MS' — Mr, Mrs, Ms or blank if under 12 years - `firstName` string — First name of the passenger - `lastName` string — Last name of the passenger - `affiliateName` string — Name of the affiliate that originated the purchase. If none, leave blank. - `trainReservationDetails` KlarnaTrainReservationDetail[] — A list of train reservation details - `pnr` string — Trip booking number, e.g. VH67899 - `trainItinerary` KlarnaTrainItinerary[] — Train itinerary data, one per train ride - `departure` string — City code or name - `departureCity` string - `arrival` string — City code or name - `arrivalCity` string - `carrier` string — Name of transportation company - `segmentPrice` integer — Local currency - `departureDate` string, date-time — Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `passengerId` integer[] - `ticketDeliveryMethod` 'pick_up' | 'email' | 'post' | 'phone' - `ticketDeliveryRecipient` string — The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number. - `class` string - `insurance` KlarnaTrainInsurance[] — Insurance data - `insuranceCompany` string - `insuranceType` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' - `insurancePrice` number, double - `passengers` KlarnaTrainPassenger[] — Passenger data - `id` integer - `title` 'MR' | 'MRS' | 'MS' — Mr, Mrs, Ms or blank if under 12 years - `firstName` string — First name of the passenger - `lastName` string — Last name of the passenger - `affiliateName` string — Name of the affiliate that originated the purchase. If none, leave blank. - `ferryReservationDetails` KlarnaFerryReservationDetail[] — A list of ferry reservation details - `pnr` string — Trip booking number, e.g. VH67899 - `ferryItinerary` KlarnaFerryItinerary[] — Ferry itinerary data, one per ferry ride - `departure` string — City code or name - `departureCity` string - `arrival` string — City code or name - `arrivalCity` string - `carrier` string — Name of transportation company - `segmentPrice` integer — Local currency - `departureDate` string, date-time — Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `ticketDeliveryMethod` 'pick_up' | 'email' | 'post' | 'phone' - `ticketDeliveryRecipient` string — The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number. - `passengerId` integer[] - `class` string - `insurance` KlarnaFerryInsurance[] — Insurance data - `insuranceCompany` string - `insuranceType` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' - `insurancePrice` number, double — Local currency - `passengers` KlarnaFerryPassenger[] — Passengers data - `id` integer - `title` 'mr' | 'mrs' | 'ms' | '' — Mr, Mrs, Ms or blank if under 12 years - `firstName` string — First name of the passenger - `lastName` string — Last name of the passenger - `affiliateName` string — Name of the affiliate that originated the purchase. If none, leave blank. - `vouchers` KlarnaVoucher[] — A list of purchased vouchers - `voucherName` string — The reference to the goods or services covered by the voucher. - `voucherCompany` string — The provider of the goods or services covered by the voucher. - `startTime` string, date-time — The date from which the voucher is valid. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `endTime` string, date-time — The date until which the voucher is valid. Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `affiliateName` string — Name of the affiliate that originated the purchase. If none, leave blank. - `customerTokens` KlarnaCustomerToken[] — A list of customer tokens used for subscription charges - `avgOrderValue` integer — The price of subscription service in non-negative minor units of the purchase currency. - `avgPurchaseFrequencyCount` integer — The number of subscription charges per interval specified in avg_purchase_frequency_interval. This information isn't required if you're sharing the subscription object on the order-line level when creating a payment session. - `avgPurchaseFrequencyInterval` 'day' | 'week' | 'month' | 'year' — The cadence unit for the subscription. This information isn't required if you're sharing the subscription object on the order-line level when creating a payment session. - `minOrderValue` integer — If the subscription can be modified, the lowest value offering in non-negative minor units of the purchase currency. - `maxOrderValue` integer — If the subscription can be modified, the highest value offering in non-negative minor units of the purchase currency. - `otherDeliveryAddresses` KlarnaOtherDeliveryAddress[] — A list of alternative non-residential delivery addresses - `shippingMethod` 'store pick-up' | 'pick-up point' | 'registered box' | 'unregistered box' — The shipping method selected for the shipment. - `shippingType` 'normal' | 'express' — The type of used shipping service. - `firstName` string — The recipient's first name specified for the selected shipping method. - `lastName` string — The recipient's last name specified for the selected shipping method. - `streetAddress` string — The recipient's street address specified for the selected shipping method. - `streetNumber` string — The recipient's street number specified for the selected shipping method. - `postalCode` string — The recipient's ZIP code specified for the selected shipping method. - `city` string — The recipient's city specified for the selected shipping method. - `country` string — The recipient's country specified for the selected shipping method. - `airReservationDetails` KlarnaAirReservationDetail[] — A list of air reservation details - `pnr` string — Trip booking number, e.g. VH67899 - `airItinerary` KlarnaAirItinerary[] — Air itinerary data, one per air ride - `departure` string — City code or name - `departureCity` string - `arrival` string — City code or name - `arrivalCity` string - `carrier` string — Name of transportation company - `segmentPrice` integer — Local currency - `departureDate` string, date-time — Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `ticketDeliveryMethod` 'pick_up' | 'email' | 'post' | 'phone' - `ticketDeliveryRecipient` string — The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number. - `passengerId` integer[] - `class` string — The service class. Example: economy - `insurance` KlarnaAirInsurance[] — Insurance data - `insuranceCompany` string - `insuranceType` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' - `insurancePrice` number, double — Local currency - `passengers` KlarnaAirPassenger[] — Passengers data - `id` integer - `title` 'mr' | 'mrs' | 'ms' | '' — Mr, Mrs, Ms or blank if under 12 years - `firstName` string — First name of the passenger - `lastName` string — Last name of the passenger - `affiliateName` string — Name of the affiliate that originated the purchase. If none, leave blank. - `busReservationDetails` KlarnaBusReservationDetail[] — A list of bus reservation details - `pnr` string — Trip booking number, e.g. VH67899 - `busItinerary` KlarnaBusItinerary[] — Bus itinerary data, one per bus ride - `departure` string — City code or name - `departureCity` string - `arrival` string — City code or name - `arrivalCity` string - `carrier` string — Name of transportation company - `segmentPrice` integer — Local currency - `departureDate` string, date-time — Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `ticketDeliveryMethod` 'pick_up' | 'email' | 'post' | 'phone' - `ticketDeliveryRecipient` string — The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number. - `passengerId` integer[] - `class` string — The service class. Example: economy - `insurance` KlarnaBusInsurance[] — Insurance data - `insuranceCompany` string - `insuranceType` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' - `insurancePrice` number, double — Local currency - `passengers` KlarnaBusPassenger[] — Passengers data - `id` integer - `title` 'mr' | 'mrs' | 'ms' | '' — Mr, Mrs, Ms or blank if under 12 years - `firstName` string — First name of the passenger - `lastName` string — Last name of the passenger - `affiliateName` string — Name of the affiliate that originated the purchase. If none, leave blank. - `inStorePayments` KlarnaInStorePayment[] — A list of in-store payments - `storeInfo` KlarnaStoreInfo — Information about the store where the purchase was completed. - `merchantStoreId` string — A unique identifier of the store specified by the merchant. Example: LONDON12 - `storeTerminalId` string — The identifier of a purchase terminal within the store with multiple terminals. Example: AD12342D - `storeAddress` KlarnaStoreAddress — The address of the store. - `city` string — The city where the store is located. Example: London - `country` string — The country where the store is located. The value must be a 2-letter country code in ISO 3166 alpha-2 standard. Example: GB - `postalCode` string — The store's ZIP code. Example: W1B 1JA - `streetAddress` string — The store's street and number. Example: New Burlington St 10 - `tripReservationDetails` KlarnaTripReservationDetail[] — A list of trip reservation details - `tripItinerary` KlarnaTripItinerary — The trip's itinerary details. - `startTime` string, date-time — Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `endTime` string, date-time — Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `initialCity` string — The city of departure. - `initialCountry` string — The country of departure. - `finalCity` string — The city of arrival. - `finalCountry` string — The country of arrival. - `tripPassengers` KlarnaTripPassenger[] — Information about the passengers. - `id` integer — The passenger's index number. - `firstName` string — The passenger's first name. - `lastName` string — The passenger's last name. - `birthDate` string, date — Date in ISO-8601 format (YYYY-MM-DD). - `gender` string — The passenger's gender. - `email` string — The passenger's email. - `uniqueId` string — The passenger's passport number, national ID number, or another unique identifier. - `specialNeeds` boolean — Set to true if the passenger reported any special needs. - `mainPassenger` boolean — Set to true if the the passenger is the trip's main passenger. - `minAge` integer — The minimum allowed age of passengers. - `maxAge` integer — The maximum allowed age of passengers. - `service` KlarnaTripService — The services included in the trip. - `travelInsurance` boolean — Set to true if the reservation covers insurance. - `hotel` boolean — Set to true if the reservation covers hotel booking. - `flight` boolean — Set to true the reservation includes the flight booking. - `cancellationService` boolean — Set to true if the reservation includes cancellation. - `sharedRoom` boolean — Set to true if the passengers agree on sharing rooms. - `affiliateName` string — Name of the affiliate that originated the purchase. If none, leave blank. - `carRentalReservationDetails` KlarnaCarRentalReservationDetail[] — A list of car reservation details - `pnr` string — The passenger name record (PNR)., e.g. 3411qsxqed23123 - `carItinerary` KlarnaCarRentalItinerary[] — The car rental itinerary data - `rentalCompany` string — The name of a car rental company. e.g Hertz - `driverId` integer[] — The array containing each driver's index passed in the drivers.id object. - `pickUpLocation` KlarnaCarRentalPickUpLocation — The address details of the pickup location. - `streetAddress` string — The street address of the pickup location. - `postalCode` string — The ZIP code of the pickup location. - `city` string — The city of the pickup location. - `country` string — The country of the pickup location. The value must be a 2-letter country code in ISO 3166 alpha-2 standard. e.g NL - `startTime` string, date-time — Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `dropOffLocation` KlarnaCarRentalDropOffLocation — The address details of the drop off location. - `streetAddress` string — The street address of the drop off location. - `postalCode` string — The ZIP code of the drop off location. - `city` string — The city of the drop off location. - `country` string — The country of the drop off location. The value must be a 2-letter country code in ISO 3166 alpha-2 standard. e.g NL - `endTime` string, date-time — Must be in ISO-8601 format (e.g. `YYYY-MM-DDTHH:MM:ss.SSSZ`). - `carPrice` integer — The rental price in minor units of the purchase currency. - `class` string — The rental class. Example: economy - `insurance` KlarnaCarRentalInsurance[] — Insurance data - `insuranceCompany` string — The name of the insurance company. Example: AON - `insuranceType` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' - `insurancePrice` number, double — Local currency - `drivers` KlarnaCarRentalDriver[] — Drivers data - `id` integer — The driver's index number. The value must be one of those specified in the car_rental_itinerary.drivers_id array. - `title` 'mr' | 'mrs' | 'ms' | '' — Mr, Mrs, Ms or blank if under 12 years - `firstName` string — First name of the driver - `lastName` string — Last name of the driver - `affiliateName` string — Name of the affiliate that originated the purchase. If none, leave blank. - `MBP` MobilePayRequest — MobilePay specific parameters - `mobilePayPhoneNumber` string — The registered cellphone number of the person that makes the payment. It can only contain numbers and has to be at least 8 and at most 15 numbers. It also needs to match the following format in order to be found in MobilePay: country code + cellphone number (without leading zero). E.g.: +4589371020 - `MDP` MDPInitRequest - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `MFA` MfaAuthorizeRequest — MFA specific parameters. At least an empty MFA object is required if MFA should be processed. Even if no additional parameters are sent. - `paycard` string — The paycard number if available. - `MFX` MFXRequest — MFX specific parameters - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `paycard` string - `invoiceOnDelivery` boolean — If set to `true`, The customers bank details (ESR data) are available from the Status API - `MPX` MPXRequest — MPX specific parameters - `alias` string, required — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `paycard` string - `invoiceOnDelivery` boolean — If set to `true`, The customers bank details (ESR data) are available from the Status API - `PAP` PayPalInitRequest — PayPal specific parameters - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `imageUrl` string — A https URL to the logo of the merchant. - `displayShippingDetails` boolean — Regulates whether the shipping details are displayed or not. (Note: `forwardCustomerDetails` and `displayShippingDetails` should be set to `no` if the shipping details should not be shown on the PayPal page. - `forwardCustomerDetails` boolean — `true` if the customer details (if submitted) should be forwarded to PayPal. Default is `false`. - `returnCustomerDetails` boolean — `true` if the customer details should be retrieved from PayPal. - `createOrder` boolean — `true` if a PayPal AC2 order is to be created. Default is `false`. - `fraudSessionId` string — The PayPal FraudNet session identifier as specified in the API documentation. - `transactionContext` TransactionContext — PayPal transaction context specific parameters. Use the same properties as you would for direct Transaction Context requests - `PFC` PfcInitRequest - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `PFP` PostfinancePayInitRequest - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `stepUp` boolean - `PLU` SBBHalbtaxPlusInitRequest - `reserved` string — Base64-encoded string of a JSON with optional properties: |Field Name|Description| |:---|:---| |mit| Defines whether the transaction is initiated by a merchant (true) or not. Field will be evaluated to true if, and only if, it is present in the header and its value is `true`| |clientCode| Contains the code of the NOVA client calling the service| |organizationCode| Contains the code of the Organization (TU) calling the service| - `token` string — Swisspass Token - `pointOfSale` integer — The point of sale that initiates the request (relevant for commercial aspects). - `pointOfDistribution` integer — The point of distribution that initiates the request (relevant for pricing). - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `paymentInstrument` PaymentInstrument — The payment instrument used in this transactions. - `paymentInstrumentID` string - `paymentType` 'ACCOUNT' - `PSC` PaysafecardRequest — Paysafecard specific request parameters - `merchantClientId` string — The merchantClientId identifies the Customer on Paysafecard's side. Specify the same merchantClientId for all transactions of a specific customer. If no merchantClientId is specified during your init requests, we will apply a random value. Please refer to the Paysafecard documentation for the guidelines of possible merchantClientIds. - `REK` RekaRequest — Reka card specific parameters - `alias` string, required — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `expiryMonth` string — The expiry month of the Reka card alias. - `expiryYear` string — The expiry year of the Reka card alias - `SWB` SwissBillingRequest — Swissbilling specific parameters. - `paymentPeriod` integer - `SWH` SwishRequest — Swish specific parameters - `payerAlias` string — The registered cellphone number of the person that makes the payment. It can only contain numbers and has to be at least 8 and at most 15 numbers. It also needs to match the following format in order to be found in Swish: country code + cellphone number (without leading zero). E.g.: 46712345678 - `paymentRequestMessage` string — Merchant supplied message about the payment/order. Max 50 characters. Common allowed characters are the letters a-ö, A-Ö, the numbers 0-9, and special characters !?=#$%&()*+,-./:;<'"@. In addition, the following special characters are also allowed: ^¡¢£€¥¿Š§šŽžŒœŸÀÁÂÃÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕØØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ - `SWP` SwissPassRequest — SwissPass specific parameters - `alias` string, required — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `card` string — The card number. - `zip` string — The zip code. - `TWI` TwintInitRequest - `alias` string — An alias (token) received from a previous transaction if `option.createAlias` was set to `true`. In order to retrieve the alias from a previous transaction, use the [Status API](#operation/status). - `orderDetailsUrl` string — URL to the order details page, where the merchant displays a summary of the order and/or allows other functionality that is relevant for the use case. - `messageTypeIdValidityHours` integer — Number of hours that messageTypeId (the Spotlight Message identifier provided by TWINT) will be valid. Spotlight message will be displayed during these validity hours. - `returnAppScheme` string — Parameter which needs to be appended to the URL used in Twint Browser-to-App switch for iOS. For example 'twint-issuer1'. - `returnAppPackage` string — Parameter which needs to be appended to the URL used in Twint Browser-to-App switch for Android. For example 'ch.twint.payment'. - `disableEnforceRegistrationWithDebit` boolean — The parameter is designed to make registration optional in Debit and UoF Registration cases. By default, this parameter is set to 'false. - `VPS` VippsRequest — Vipps specific parameters - `customerMobileNumber` string — Mobile number (eight digits) of the user who has to pay for the transaction from Vipps. - `paymentText` string — Text to be displayed to end user. - `WEC` WeChatRequest — WeChat specific parameters - `subtype` 'MINI_APP', required — Specify MINI_APP to process a transaction from a mini program. - `openId` string - `itemDescription` string - `dcc` DccInitRequest — For DCC data obtained from a previous DCC request for a given credit card, currency, and amount, use `correlationId`. Otherwise, for DCC data obtained from external sources, provide `currency`, `amount`, and `rate`. If DCC data is supplied, the payment page will bypass the DCC selection view and proceed directly to the 3D Secure process. Authorization will use the provided DCC data. If credit card details were used when obtaining the DCC data, they must also be provided. - `correlationId` string, uuid — The DCC correlation ID - `currency` string — The targeted currency - `amount` integer — The amount in your targeted currency - `rate` number, double — The conversion rate in your targeted currency (e.g. `0.1234`) - `mcp` InitMcpRequest - `currency` string, required — The targeted currency - `amount` integer, required — The amount in your targeted currency - `conversionRate` number, double — Conversion rate received from the currency rates endpoint. Required in case of dynamic MCP. - `transactionDate` string, date-time — Transaction datetime received from the currency rates endpoint - `retrievalReferenceNumber` string — RetrievalReferenceNumber received from the currency rates endpoint - `userId` string, required - `provider` string, required — The provider for multi currency processing - `reasonIndicator` string, required — If received from acquirer the reason indicator can be set - `metadata` Metadata — Merchant reference data - `userData1` string — Merchant description 1 - `userData2` string — Merchant description 2 - `userData3` string — Customer description 1 - `userData4` string — Customer description 2 - `airlineData` AirlineDataRequest — The airline data including ticket details. - `countryCode` string — Passenger country code in ISO-3166-1-alpha2 format. - `agentCode` string — IATA agency code - `pnr` string — PNR - `issueDate` string, date — Ticket issuing date. Must be in ISO-8601 format (`YYYY-MM-DD`). - `tickets` Ticket[] — A list of tickets for this purchase. Note: PAP only supports one ticket. - `ticketNumber` string — the number of the ticket - `passengerName` string — Name of passenger or person to whom the ticket was issued - `descriptionCode` string — Description code - `legs` Leg[] — List of ticket's legs - `departureAirport` string — The origin or departure airport code for this leg. - `arrivalAirport` string — The destination or arrival airport code for this leg. - `carrier` string — Carrier airline code(i.e.'OS') - `fareBasis` string — Fare basis (i.e. 'URRVP/OCF') - `flightNumber` string — Flight number (i.e. OS 834) - `flightDate` string, date — Date of flight. Must be in ISO-8601 format (`YYYY-MM-DD`). - `departureTime` LocalTime — Flight's arrival time. Must be in ISO-8601 format (`hh:mm`). - `hour` integer - `minute` integer - `second` integer - `nano` integer - `arrivalTime` LocalTime — Flight's arrival time. Must be in ISO-8601 format (`hh:mm`). - `hour` integer - `minute` integer - `second` integer - `nano` integer - `class` string — Class code (i.e.'U') - `emdTickets` EmdTicket[] — List of emd tickets - `relatedTicketNumber` string — the number of the related ticket - `reasonCode` string — the code of the reason - `reasonDescr` string — the description of the reason - `emds` Emd[] — List of emds - `reasonSubCode` string — the code of the reason - `reasonSubDescr` string — the description of the reason - `feeOwnerArline` string — the fee owner ArLine - `accertify` Accertify — Accertify decision (Accepted, Review, Declined - `threeRIData` ThreeRIData - `recurringExpiry` string, date-time - `recurringFrequency` integer - `threeRIInd` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '80' | '81' | '82' | '83' | '84' | '85' | '86' | '87' | '88' | '89' | '90' | '91' | '92' | '93' | '94' | '95' | '96' | '97' | '98' | '99' - `extensions` Extension — An object for additional data for customized processes. ## Response `201` Transaction successfully initialized - InitResponse - `transactionId` string — The `transactionId` to be used when using Redirect- or Lightbox Mode. If no further action happens with the `transactionId` after initialization, it will be invalidated after 30 minutes. - `mobileToken` string — Mobile token which is needed to initialize the Mobile SDKs. - `WEC` WeChatResponse — WeChat specific response parameters - `prepayId` string — The order prepayId. To be used by the Mini APP in the payment confirmation process. - `timestamp` string - `nonceString` string - `paySign` string - `TWI` TwintResponse — Twint specific response parameters - `ALP` AlipayResponse — Alipay+ specific response parameters - `normalUrl` string — The url used by the Mini APP in the payment confirmation process. - `3D` Secure3DResponse — The `3D` object is only present if init call was done with an `alias`. - `enrolled` boolean — Whether the used credit card alias (or card number) is 3D enrolled or not. ## Other responses - `400` — Invalid request --- [API](https://skmtc.net/pci-proxy/apis/pci-proxy-api-reference-datatrans-endpoints.md) · [All operations](https://skmtc.net/pci-proxy/apis/pci-proxy-api-reference-datatrans-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pci-proxy/pci-proxy-api-reference-datatrans-endpoints/versions/1f4f905fd175/schema)