Unzer

This page provides an overview of the payments methods provided by the Unzer adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating Unzer within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

Payment Methods

Payment Method	Transaction Flows	Transaction Types
Invoice	Server-To-Server	Debit, Preauthorize, Capture, Void, Refund
Installment	Server-To-Server	Debit, Preauthorize, Capture, Void, Refund

Mandatory Parameters

Name	Type	Required	Description
currency	string	true	3 letters (ISO 4217)
amount	number	true	Transaction amount
additionalId1	string	false	Order ID
customer.identification	string	false	Customers identification
customer.firstname	string	true	Customers firstname
customer.lastname	string	true	Customers lastname
customer.birthdate	string	true	Customers birthdate (YYYY-mm-dd)
customer.email	string	true	Customers E-Mail
customer.gender	string	false	Customers E-Mail
customer.billingAddress1	string	true	Customers address
customer.billingCity	string	true	Customers city
customer.billingPostcode	string	true	Customers zip code
customer.billingState	string	false	Customers state
customer.billingCountry	string	true	Customers country 2 letters (ISO 3166-1 alpha-2)
customer.billingPhone	string	false	Customers phone number
customer.extraData.mobile	string	false	Customers mobile phone number
customer.shippingAddress1	string	true	Customers address
customer.shippingCity	string	true	Customers city
customer.shippingPostcode	string	true	Customers zip code
customer.shippingCountry	string	true	Customers country 2 letters (ISO 3166-1 alpha-2)
customer.shippingPhone	string	false	Customers phone number
customer.extraData.language	string	false	Customers language 2 letters (ISO 639-1)
items	object	true	The object containing cart items

Item

Name	Type	Required	Description
item.identification	string	true	The merchant's unique identifier for the product (no spaces allowed).
item.name	string	true	The merchant's name for the product.
item.quantity	number	true	The quantity being purchased (must be >0).
item.price	number	true	The unit price of the product.
item.description	string	false	The description of the product.
item.l2l3Data.unit	string	false	The unit description of the item.
item.l2l3Data.type	string	false	The type of the basket item.
item.l2l3Data.taxRate	number	true	Tax rate used for the tax amount. (can be 0 but not empty)
item.l2l3Data.discount	number	false	Discount (incl. VAT) granted on the basketItems
item.extraData.imageUrl	string	false	The imageUrl for the related basketItem.

Optional ThreatMetrix Parameters

You can find more information about the ThreadMatrix script here: Unzer API docs

Name	Type	Required	Description
customer.extraData.threatMetrixId	string	false	The ThreatMetrix session ID
customer.extraData.customerGroup	string	false	Customer classification for the customer if known
customer.extraData.confirmedAmount	string	false	The amount/value of the successful transactions paid by the end customer
customer.extraData.confirmedOrders	string	false	The number of successful transactions paid* by the end customer
customer.extraData.registrationLevel	string	false	Customer registration level
customer.extraData.registrationDate	string	false	Customer registration date in your shop

Additional Parameters for Installment

Name	Type	Required	Description
customer.iban	string	false	Customers IBAN (recommended)
customer.bic	string	false	Customers BIC
extraData.inquiryId	string	true	inquiryId of the installment plan (retrieved via option call installmentPlans)
extraData.numberOfRates	number	true	Number of rates (available rates retrieved via option call installmentPlans)

Options Request

You can find more information about the options request here: Options Request

Retrieving a list of available installment plans

Returns a list of available installment plans with the inquiryId

Please use installmentPlans as an option name e.g. POST /options/{apiKey}/installmentPlans.

Parameters

Name	Type	Required	Description
parameters.amount	number	true	Transaction amount
parameters.country	string	true	Customers country 2 letters (ISO 3166-1 alpha-2)
parameters.currency	string	true	3 letters (ISO 4217)
parameters.customerType	string	true	B2C or B2B