Accept Unzer Invoice with UI components

Use Unzer UI component to add Unzer Invoice payment to your checkout page.

If you are using payment types invoice or invoice-secured, note that these methods are now deprecated. They are currently supported but there are no further developments planned for them.

If you want to access the relevant documentation, see Unzer Invoice and Unzer Invoice Secured.

Overview

Using UI components for Unzer Invoice, you create a paylater-invoice payment type resource that is used to make the payment. The form of this payment type consists of a checkbox for the client to accept the terms and conditions. You can check a demo version of the component here. Basic steps for integrating using UI components are the same for all payment methods and you can read about them here.

With Unzer Invoice you need to provide information about the customer via a customer resource and the purchased products via a basket resource when you make the transaction. This is required for customer assessment and transaction approval. You will also need the customer information to create the invoice document. You are responsible for gathering this data during the checkout.

Before you begin

Check the basic integration requirements.
Familiarize yourself with general guide on integrating using UI components.

You must use basket v2 for Unzer Invoice payment method.

Step 1: Add UI components to your payment page
client side

First, you need to initiate our UI components library and add the payment form to your payment page.

Initiate UI component

Load our JS script and CSS stylesheet

Include Unzer’s script and stylesheet on your website.

Always load the script and stylesheet directly from Unzer:

<link rel="stylesheet" href="https://static.unzer.com/v1/unzer.css" />
<script type="text/javascript" src="https://static.unzer.com/v1/unzer.js"></script>

Faster load time
To make your website load faster, insert JavaScript scripts at the bottom of your HTML document.

Importing Unzer styles
To minimize the risk of Unzer styles affecting the styles of your webpage, we suggest putting unzer.css on top of other imported CSS files.

Create an Unzer instance

Create an unzer instance with your public key:

// Creating an unzer instance with your public key
var unzerInstance = new unzer('s-pub-xxxxxxxxxx');

Placeholder keys
In the previous example, we used a placeholder API key for example purposes. You should replace it with your public key.

Localization and languages

We support localization with locale option parameters. Check the Localization page for a list of all the supported locales.

The auto option (applied by default) uses the client’s browser language.

Here you can see how to set the language, in our case ‘de-DE’ - to do so, add a comma separated parameter to your unzer instance:

// Creating an unzer instance with your public key
var unzerInstance = new unzer('s-pub-xxxxxxxxxx', {locale: 'de-DE'});

Implement the payment form

Option 1: Implement with customer form

If you don’t have information about the customer (and the corresponding customerID) or want to update information of an already existing customer, you can do so using customer form. Check Customer UI component page for more information.

Insert the customer form

To use the customer form effectively, you must insert it into your payment form. We recommend placing it above the payment elements.

Here is a short example:

<form id="payment-form">
    <div id="customer" class="field">
        <!-- The customer form UI element will be inserted here -->
    </div>
    <div id="example-paylater-invoice">
        <!-- ... The Payment form UI element (opt-in text and checkbox) will be inserted here -->
    </div>
    <div id="error-holder" class="field" style="color: #9f3a38">
        <!-- Errors will be inserted here -->
    </div>
    <button class="unzerUI primary button fluid" id="submit-button" type="submit">
      Pay
    </button>
</form>

Create the customer resource

A customer resource is created like a payment type with the UI components. Please make sure to set the option paymentTypeName to “paylater-invoice” in order to allow rendering a specialized form for this payment type.

let customer = unzerInstance.Customer();
customer.create({
    containerId: 'customer',
    paymentTypeName: 'paylater-invoice'
    });

let customer = unzerInstance.B2BCustomer();
customer.create({
    containerId: 'customer',
    paymentTypeName: 'paylater-invoice'
});

Update the customer resource

In Order to render the customer form, you will need to call the Customer.update() function instead of Customer.create(). Please make sure to set the option paymentTypeName to “paylater-invoice” in order to allow rendering a specialized form for this payment type. In case you wish to initialize the form with the data of an already created customer, you will need to call the Customer.initFormFields() function. This has to be done before calling Customer.update().

let customer = unzerInstance.Customer();

// Initialize customer form with existing B2C customer data
customer.initFormFields({
  "lastname": "Universum",
  "firstname": "Peter",
  "salutation": "mr",
  "birthDate": "1987-12-20",
  "address": {
    "street": "Hugo-Junkers-Str. 5",
    "state": "DE-BO",
    "zip": "60386",
    "city": "Frankfurt am Main",
    "country": "DE"
  },
  "shippingAddress": {
    "street": "Hugo-Junkers-Str. 5",
    "state": "DE-BO",
    "zip": "60386",
    "city": "Frankfurt am Main",
    "country": "DE"
  }
})

// Call the update function that will initialize the form with existing customer data
// You need to pass the customerId, the containerId and the paymentTypeName set to 'paylater-invoice'
customer.update('s-cst-7f0910d26396', {
  containerId: 'customer',
  paymentTypeName: 'paylater-invoice'
})

let customer = unzerInstance.B2BCustomer()

// Initialize customer form with existing B2B customer data
customer.initFormFields({
  "lastname": "Universum",
  "firstname": "Peter",
  "salutation": "mr",
  "company": "unzer GmbH",
  "birthDate": "1987-12-20",
  "email": "john.doe@unzer.com",
  "billingAddress": {
    "name": "Peter Universum",
    "street": "Hugo-Junkers-Str. 5",
    "state": "DE-BO",
    "zip": "60386",
    "city": "Frankfurt am Main",
    "country": "DE"
  },
  "companyInfo": {
    "registrationType": "not_registered",
    "function": "OWNER",
    "commercialSector": "AIR_TRANSPORT",
    "commercialRegisterNumber": "de-423fsdf-zz"
  },
})

// Call the update function that will initialize the form with existing customer data
// You need to pass the customerId, the containerId and the paymentTypeName set to 'paylater-invoice'
customer.update('s-cst-7f0910d26396', {
  containerId: 'customer',
  paymentTypeName: 'paylater-invoice'
})

Optionally, you can add a custom event listener that sends the validation result of all input fields

// Note: the event listener has to be called before the `update()` call
customer.addEventListener('validate', function(e) {
  if (e.success) {
    // run some code (for example, enable the `pay` button)
  } else {
    // run some code (for example, disable the `pay` button)
  }
})

Option 2: Create the customer on the server side

You can also use the customer data provided by your shop system to create the customer resource on the server side. This way you can omit rendering the customer form in the front end and just create the resource and use the ID in your transaction request. This might not be feasible in case of B2B customer resource creation. Refer to the section Create customer resource for details on this approach.

In that case you just need to render the payment type form and create a simple HTML button on the client side:

<form id="payment-form">
    <div id="example-paylater-invoice"></div>
    <div id="error-holder" class="field" style="color: #9f3a38">
        <!-- Errors will be inserted here -->
    </div>
    <button class="unzerUI primary button fluid" id="submit-button" type="submit">
        Pay
    </button>
</form>

Create the payment type resource

To create a payment type resource – in this case an Unzer Invoice instance, call the unzerInstance.PaylaterInvoice() function. You should also call the create function to render the opt-in form. Please make sure to pass a valid customerType (B2B/B2C) to the create function, in order to show the consent link.

let paylaterInvoice = unzerInstance.PaylaterInvoice();

// Render the opt-in input form field
paylaterInvoice.create({
  containerId: 'example-paylater-invoice',
  customerType: 'B2C', // or B2B
})

Please make sure to pass valid parameters to the create function.

Parameter	Type	Description	Default value
`containerId` required	`String`	The HTML ID of the DOM element, where the UI component will be inserted.	-
`customerType`	`String`	Customer type (`B2C` or `B2B`) to show the consent link.	-
`threatMetrixId`	`String`	A unique identifier for the transaction. For more details, see Add the ThreatMetrix script. If set, the ThreatMetrix script shall be called automatically after after successful payment type form rendering.	-

ThreatMetrix

If you are using our UI components, you can just pass along the unique session ID (threatMetrixId), as described above. The UI components will automatically load and invoke the threatMetrix scripts for you.

If you decide to not use our ThreatMetrix integration (for example, if you are using custom ui components), then you need to proceed as described in the Add the ThreatMetrix script section.

Add an event listener and submit the form

Option 1: Without the customer form

Get the HTML form by its unique ID and add an event listener.

Inside, create a Promise on the PaylaterInvoice object. The Promise gets either resolved or rejected:

let form = document.getElementById('payment-form');
form.addEventListener('submit', function(event) {
    event.preventDefault();

    paylaterInvoice.createResource()
        .then(function(result) {
            let typeId = result.id;
            // submit the payment type ID to your server-side integration
        })
        .catch(function(error) {
          document.getElementById('error-holder').innerText = error.customerMessage || error.message || 'Error'
        })
});

Option 2: With the customer create/update form

Get the HTML form by its unique ID and add an event listener.

Create a Promise for the customer and the PaylaterInvoice object and handle them with Promise.all(). Please Check Customer form with payment for more information for more information.

let form = document.getElementById('payment-form');
    form.addEventListener('submit', function(event) {
        event.preventDefault();

        let customerPromise = customer.createCustomer();
        let paylaterInvoicePromise = paylaterInvoice.createResource();
        Promise.all([paylaterInvoicePromise, customerPromise])
            .then(function(values) {
                let typeId = values[0].id;
                let customerId = values[1].id;
                // Submit the IDs to your server-side integration.
            })
            .catch(function(error) {
              document.getElementById('error-holder').innerText = error.customerMessage || error.message || 'Error'
            })
    });

let form = document.getElementById('payment-form');
    form.addEventListener('submit', function(event) {
        event.preventDefault();

        let customerPromise = customer.updateCustomer();
        let paylaterInvoicePromise = paylaterInvoice.createResource();
        Promise.all([paylaterInvoicePromise, customerPromise])
            .then(function(values) {
                let typeId = values[0].id;
                let customerId = values[1].id;
                // Submit the IDs to your server-side integration.
            })
            .catch(function(error) {
              document.getElementById('error-holder').innerText = error.customerMessage || error.message || 'Error'
            })
    });

Step 2: Make a payment
server side

Besides an always mandatory step of creating the paymentType resource, Unzer paylater-invoice also requires a customer and a basket resource.

Create the customer resource

This step is applicable only if you didn’t create a customer resource yet, on the client side.

B2C customer creation

To process transactions for B2C customers, the following customer fields are available:

Parameter	Type	Description
`firstname` (required)	`string`	The customer’s first name
`lastname`(required)	`string`	The customer’s last name
`salutation`	`string`	Specify the customer’s Salutation. Available values are `mr`, `mrs`, `unknown`
`customerId`	`string`	Customer’s Unique ID. It identifies the customer and can be used within the GET request. It must be unique.
`birthDate` (required)	`string`	The birth date of the customer in ‘YYYY-MM-DD’ format.
`email` (required)	`string`	The customer’s email address
`language`	`string`	The language for customer correspondence. Must be in ISO 639 alpha-2 code format.
`billingAddress` (required)	`object`	The customer’s billing address
`billingAddress.name`	`string`	The customer’s name for the billing address
`billingAddress.street`	`string`	The customer’s street including house number
`billingAddress.state`	`string`	The customer’s state
`billingAddress.zip`	`string`	The customer’s postal code
`billingAddress.city`	`string`	The customer’s city
`billingAddress.country`	`string`	The customer’s country in ISO country code ISO 3166 ALPHA-2 (only for billing address)
`shippingAddress` (required if different from the billing address)	`object`	The customer’s shipping address.
`shippingAddress.name`	`string`	Name of person for the shipping address
`shippingAddress.street`	`string`	The customer’s street including house number
`shippingAddress.state`	`string`	The customer’s state
`shippingAddress.zip`	`string`	The customer’s postal code
`shippingAddress.city`	`string`	The customer’s city
`shippingAddress.country`	`string`	The customer’s country in ISO country code ISO 3166 ALPHA-2
`shippingAddress.shippingType`	`string`	The shipping type, valid values are `equals-billing`, `different-address`, `branch-pickup`, `post-office-pickup`, `pack-station`

POST https://api.unzer.com/v1/customers

{
"lastname": "Paylater",
"firstname": "Peter",
"salutation": "mr",
"company": "unzer GmbH",
"customerId": "{{customer_external_id}}",
"birthDate": "1987-12-20",
"email": "John.Doe@unzer.com",
"phone": "+49 6221 64 71 100",
"mobile" : "+49 172 123 456",
    "language": "de",
    "billingAddress" : {
      "name" : "Peter Paylater",
      "street" : "Hugo-Junkers-Str. 5",
      "state" : "DE",
      "zip" : "60386",
      "city" : "Frankfurt am Main",
      "country" : "DE"
    },
    "shippingAddress" : {
      "name" : "Peter Paylater",
      "street" : "Hugo-Junkers-Str. 5",
      "state" : "DE",
      "zip" : "60386",
      "city" : "Frankfurt am Main",
      "country" : "DE",
      "shippingType": "equals-billing"
    }
 }

The response looks similar to the following example:

{
  "id":"s-cst-c552940bca23"
}

B2B customer creation

To process transactions for B2B customers, the following customer fields are available:

Parameter	Type	Description
`firstname` (required)	`string`	The customer’s first name
`lastname` (required)	`string`	The customer’s last name
`salutation`	`string`	Specify the customer’s salutation. Available values are `mr`, `mrs`, `unknown`
`company` (required)	`string`	The customer’s company name
`customerId`	`string`	Customer’s Unique ID. It identifies the customer and can be used within the GET request. It must be unique.
`birthDate`	`string`	The birth date of the customer in ‘YYYY-MM-DD’ format
`email` (required)	`string`	The customer’s email address
`billingAddress` (required)	`object`	The customer’s billing address
`billingAddress.name`	`string`	The customer’s name for the billing address
`billingAddress.street`	`string`	The customer’s street
`billingAddress.state`	`string`	The customer’s state
`billingAddress.zip`	`string`	The customer’s postal code
`billingAddress.city`	`string`	The customer’s city
`billingAddress.country`	`string`	The customer’s country in ISO country code ISO 3166 ALPHA-2 (only for billing address)
`shippingAddress` (required if different from the billing address)	`object`	The customer’s shipping address.
`shippingAddress.name`	`string`	Name of the customer for the shipping address
`shippingAddress.street`	`string`	The customer’s street including house number
`shippingAddress.state`	`string`	The customer’s state
`shippingAddress.zip`	`string`	The customer’s postal code
`shippingAddress.city`	`string`	The customer’s city
`shippingAddress.country`	`string`	The customer’s country in ISO country code ISO 3166 ALPHA-2
`shippingAddress.shippingType`	`string`	The shipping type, valid values are `equals-billing`, `different-address`, `branch-pickup`, `post-office-pickup`, and `pack-station`
`companyInfo.companyType`	`string`	The company type. Valid values are `authority`, `association`, `sole`, `company`, `other`
`companyInfo.registrationType`	`string`	B2B is registered or not registered as a customer
`companyInfo.function`	`string`	Must be OWNER for NOT_REGISTERED, restricted ‘<’ and ‘>’
`companyInfo.commercialSector`	`string`	Mandatory if companyInfoModel.registrationType is REGISTERED, restricted ‘<’ and ‘>’
`companyInfo.owner.firstname` (conditional)	`string`	The first name of the company owner. This is only required if the `companyInfo.companyType` type is`sole`.
`companyInfo.owner.lastname` (conditional)	`string`	The last name of the company owner. This is only required if the `companyInfo.companyType` type is`sole`.
`companyInfo.owner.birthDate` (conditional)	`string`	The birth date of the company owner. This is only required if the `companyInfo.companyType` type is`sole`.

POST https://api.unzer.com/v1/customers

{
    "firstname": "John",
    "lastname": "Doe",
    "salutation": "mr",
    "company": "Unzer GmbH",
    "customerId": "12345678",
    "birthDate": "1987-12-20",
    "email": "John.Doe@unzer.com",
    "billingAddress": {
        "name": "John Doe",
        "street": "Hugo-Junkers-Str. 5",
        "state": "DE-BO",
        "zip": "60386",
        "city": "Frankfurt am Main",
        "country": "DE"
    },
    "shippingAddress": {
        "name": "John Doe",
        "street": "Hugo-Junkers-Str. 5",
        "state": "DE-BO",
        "zip": "60386",
        "city": "Frankfurt am Main",
        "country": "DE",
        "shippingType": "equals-billing"
    },
    "companyInfo": {
        "registrationType": "not_registered",
        "function": "OWNER",
        "commercialSector": "AIRPORT",
        "companyType": "sole",
        "owner": {
            "firstname": "SoleFirst",
            "lastname": "SoleLast",
            "birthdate": "1995-06-21"
        }
    }
}

$unzer      = new UnzerSDK\Unzer('s-priv-xxxxxxxxxx');

$shippingAddress = (new Address())
    ->setName('John Doe')
    ->setStreet('Hugo-Junkers-Str. 5')
    ->setZip('60386')
    ->setCity('Frankfurt am Main')
    ->setCountry('DE')
    ->setState('DE-BO')
    ->setShippingType(ShippingTypes::EQUALS_BILLING);

$billingAddress = (new Address())
    ->setName('John Doe')
    ->setStreet('Hugo-Junkers-Str. 5')
    ->setZip('60386')
    ->setCity('Frankfurt am Main')
    ->setCountry('DE')
    ->setState('DE-BO');

$companyOwner = (new CompanyOwner())
    ->setFirstname("SoleFirst")
    ->setLastname("SoleLast")
    ->setBirthdate("1995-06-21");

$customer = CustomerFactory::createNotRegisteredB2bCustomer(
    'John',
    'Doe',
    '2001-12-12',
    $billingAddress,
    'John.Doe@unzer.com',
    'Unzer GmbH',
    CompanyCommercialSectorItems::AIR_TRANSPORT
);

$customer->setShippingAddress($shippingAddress);
$customer->getCompanyInfo()->setOwner($companyOwner);

$unzer->createCustomer($customer);

Unzer unzer = new Unzer("s-priv-xxxxxxxxxx");

Shipping shippingAddress = (ShippingAddress) new ShippingAddress()
        .setShippingType(Type.EQUALS_BILLING);
        .setName("John Doe")
        .setStreet("Hugo-Junkers-Str. 5")
        .setZip("60386")
        .setCity("Frankfurt am Main")
        .setCountry("DE")
        .setState("DE-BO")

Address billingAddress = new Address()
        .setName("John Doe")
        .setStreet("Hugo-Junkers-Str. 5")
        .setZip("60386")
        .setCity("Frankfurt am Main")
        .setCountry("DE")
        .setState("DE-BO")
        
CustomerCompanyData.Owner owner = (new CustomerCompanyData.Owner())
        .setFirstname("SoleFirst")
        .setLastname("SoleLast")
        .setBirthdate(new SimpleDateFormat("yyyy-MM-dd").parse("1995-06-21"));
        
CustomerCompanyData companyData = new CustomerCompanyData()
        .setOwner(owner)
        .setCommercialSector(CommercialSector.AIR_TRANSPORT)
        .setRegistrationType(RegistrationType.NOT_REGISTERED)
        
Customer customer = new Customer("John", "Doe")
        .setBirthDate(new SimpleDateFormat("yyyy-MM-dd").parse("1995-06-21"))
        .setBillingAddress(billingAddress)
        .setShippingAddress(shippingAddress)
        .setEmail("John.Doe@unzer.com")
        .setCompany("Unzer GmbH")
        .setCompanyData(companyData)

unzer.createCustomer(customer);

The response looks similar to the following example:

{
    "id": "s-cst-b9acaba781f3"
}

For a full description of customer resource, refer to the relevant server-side-integration documentation page: Manage customer (direct API calls).

Create a basket resource

The basket resource stores information about the purchased products, used vouchers, and the shipment costs.

Note that you must send the basket resource within the payment request.

POST https://api.unzer.com/v2/baskets

{
  "currencyCode": "EUR",
  "basketItems": [
    {
      "basketItemReferenceId": "item-1",
      "quantity": 1,
      "amountPerUnitGross": 40,
      "vat":"1",
      "title": "Phone"
    },
    {
      "basketItemReferenceId": "item-2",
      "quantity": 3,
      "amountPerUnitGross": 20,
      "vat":"1",
      "title": "Cables"
    }
  ]
}

$unzer = new Unzer('s-priv-xxxxxxxxxx');

$basketItem = (new BasketItem())
    ->setBasketItemReferenceId('Item-d030efbd4963')
    ->setQuantity(10)
    ->setUnit('m')
    ->setAmountPerUnitGross(20.00)
    ->setAmountDiscountPerUnitGross(1.00)
    ->setVat(19.0)
    ->setTitle('SDM 6 CABLE')
    ->setSubTitle('This is brand new Mid 2019 version')
    ->setImageUrl('https://a.storyblok.com/f/91629/x/1ba8deb8cc/unzer_primarylogo__white_rgb.svg')
    ->setType(BasketItemTypes::GOODS);

$basket = (new Basket())
    ->setTotalValueGross(190.00)
    ->setCurrencyCode('EUR')
    ->setOrderId('Order-12345')
    ->setNote('Test Basket')
    ->addBasketItem($basketItem);

$unzer->createBasket($basket);

BasketItem basketItem = new BasketItem()
        .setBasketItemReferenceId("Item-d030efbd4963")
        .setQuantity(BigDecimal.valueOf(10))
        .setUnit("m")
        .setAmountPerUnitGross(BigDecimal.valueOf(20.00))
        .setAmountDiscountPerUnitGross(BigDecimal.valueOf(1.00))
        .setVat(BigDecimal.valueOf(19.0))
        .setTitle("SDM 6 CABLE")
        .setSubTitle("This is brand new Mid 2019 version")
        .setImageUrl(new URL("https://a.storyblok.com/f/91629/x/1ba8deb8cc/unzer_primarylogo__white_rgb.svg"))
        .setType(BasketItem.Type.GOODS);

Basket basket  = new Basket()
        .setTotalValueGross(BigDecimal.valueOf(190.00))
        .setCurrencyCode(Currency.getInstance("EUR"))
        .setOrderId("Order-12345")
        .setNote("Test Basket")
        .addBasketItem(basketItem);

Unzer unzer = new Unzer("s-priv-xxxxxxxxxx");
unzer.createBasket(basket);

The response looks similar to the following example:

{
    "id": "s-bsk-49277b9f7ee0"
}

For a full description of basket resource, refer to the relevant server-side-integration documentation page: Direct API integration.

Add the ThreatMetrix script

We use ThreatMetrix for fraud prevention to protect your business from potential fraudsters. For this, insert a code snippet with a unique(!) parameter on your payments page and later, send this parameter as threatMetrixId in the authorize request to us. The next steps are managed by us and no additional steps are required from you.

Define a 128 byte long and unique variable as identifier for this transaction. Make sure it only consists of the following characters:
- upper and lowercase English letters ([a-z], [A-Z])
- digits (0-9)
- underscore (_)
- hyphen (-)
Use this variable in the ThreatMetrix script (next step) in the GET parameter session_id and store it temporarily so that you can also send it in the authorize request later on.
Add the ThreatMetrix script to your payment page. To get full fraud protection, use both the JavaScript part in thesection and the iFrame version in the body section of your page.

<html>
<head>
    <script type="text/javascript" async
         src="https://h.online-metrix.net/fp/tags.js?org_id=363t8kgq&session_id=[SessionID]">
    </script>
</head>

<body>
<noscript>
<iframe 
    style="width: 100px; height: 100px; border: 0; position: absolute; top: -5000px;" 
    src="https://h.online-metrix.net/fp/tags?org_id=363t8kgq&session_id=[SessionID]">
</iframe>
</noscript>
</body>

Recommendations for creation of session ID

Use a merchant identifier (URL without domain additions), append an existing session identifier from a cookie, append the date and time in milliseconds to the end of the identifier, and then applying a hexadecimal hash to the concatenated value to produce a completely unique Session ID.
Use the org_id=363t8kgq as a static value that does not change for each ThreatMetrix script or for an individual merchant.
Use a merchant identifier (URL without domain additions), append an existing session identifier from the web application, and apply a hexadecimal hash to the value to obfuscate the identifier.
Example: merchantshop_cd-695a7565-979b-4af9
The session_id must be stored temporarily for later/subsequent request.

Do a risk check for the customer
server side

Customer risk check is an optional step after the payment method is selected. It is used for the risk evaluation of the end customer data. When sending the request, you must also add the x-CLIENTIP=<YOUR Client's IP> attribute in the header.

This operation is not part of the payment process. Like credit card check, it is used to pre-check customer data immediately after the payment method selection step in the checkout. This way customer receives direct feedback before finishing the order, avoiding irritation. The riskCheck request contains customer resource’s reference and transactional details.

POST: https://api.unzer.com/v1/types/paylater-invoice/risk-check
{
    "amount": "100",
    "currency": "EUR",
    "orderId": "ORD-123456",
    "invoiceId" : "INV-123456",
    "resources": {
        "customerId": "s-cst-b9acaba781f3", 
        "typeId": "s-piv-zex7c9iibpek",
        "basketId": "s-bsk-49277b9f7ee0"
    },
    "additionalTransactionData": {
      "riskData": {
        "threatMetrixId": "merchantshop_cd-695a7565-979b-4af9",
        "customerGroup":"TOP",
        "confirmedAmount":"2569",
        "confirmedOrders":"14",
        "registrationLevel":"1",
        "registrationDate":"20160412"
      }
    }
}

{
    "id": "GHZC-PQVK-RLGP",
    "timestamp": "2024-04-09 12:46:00",
    "isSuccess": true,
    "isPending": false,
    "isResume": false,
    "isError": false
}

{
    "id": "s-err-70a411aa69854880a727eb27e6f",
    "isSuccess": false,
    "isPending": false,
    "isResumed": false,
    "isError": true,
    "url": "https://sbx-api.unzer.com/v1/types/paylater-invoice/risk-check",
    "timestamp": "2024-04-09 12:47:09",
    "traceId": "fd58542dd6d6e2ad681a98dc692c5c45",
    "errors": [
        {
            "code": "API.901.100.300",
            "merchantMessage": "Invalid amount.invalid amount (probably too large) [details: Amount 1000000.00 outside transaction limits: [1.00, 5000.00]]",
            "customerMessage": "An error occurred. Please contact us for more information."
        }
    ]
}

Make an authorize transaction

Now, make an authorize transaction with the paylater-invoice resource that you created earlier. You must also add the x-CLIENTIP=<YOUR Client's IP> attribute in the header. With a successful authorize transaction, the amount is authorized and a payment resource is created. At this point no money has been transferred.

Parameter	Type	Description
`amount` (required)	float	The authorization amount
`currency` (required)	string	The authorization currency, in the ISO 4217 alpha-3 format (for example, `EUR`)
`orderId`	string	Your customer facing order number (if available at that point)
`customerId` (required)	string	The ID of the `customers` resource to be used (for example, `s-cst-e692f3892497`)
`basketId` (required)	string	The basket ID for the payment
`typeId` (required)	string	The ID of the payment type resource to be used (such as `s-piv-voi3gcbwinos`)

Provide the customer risk information

To increase the acceptance rate of your invoice payments, we strongly recommend that you provide additional information about your customer. The following fields can be provided to allow us to apply a detailed risk check:

Parameter	Type	Description
`threatMetrixId`	string	The ThreatMetrix session ID
`customerGroup`	string	Customer classification for the customer if known valid values: TOP: Customers with more than 3 paid* transactions GOOD: Customers with more than 1 paid* transactions BAD: Customers with defaulted/fraudulent orders NEUTRAL: Customers without paid* transactions
`confirmedAmount`	string	The amount/value of the successful transactions paid by the end customer
`confirmedOrders`	string	The number of successful transactions paid* by the end customer
`registrationLevel`	string	Customer registration level 0=guest, 1=registered
`registrationDate`	string	Customer registration date in your shop (YYYYMMDD)

*paid: A paid transaction is a transaction where you have the payment status of the customer for previous transactions (external factoring invoice, installment or direct debit transactions must be excluded because you might have no information about the actual payment status of the customer).

POST: https://api.unzer.com/v1/payments/authorize

Body
{
    "amount": "100",
    "currency": "EUR",
    "orderId": "ORD-123456",
    "invoiceId" : "INV-123456",
    "resources": {
        "customerId": "s-cst-472f919218b5", 
        "typeId": "s-piv-zex7c9iibpek",
        "basketId": "s-bsk-49277b9f7ee0"
    },
    "additionalTransactionData": {
      "riskData": {
        "threatMetrixId": "f544if49wo4f74ef1x",
        "customerGroup":"TOP",
        "confirmedAmount":"2569",
        "confirmedOrders":"14",
        "registrationLevel":"1",
        "registrationDate":"20160412"
      }
    }
}

$unzer     = new UnzerSDK\Unzer('s-priv-xxxxxxxxxx');

$riskData = (new RiskData())
    ->setThreatMetrixId('f544if49wo4f74ef1x')
    ->setCustomerGroup('TOP')
    ->setConfirmedAmount('2569')
    ->setConfirmedOrders('14')
    ->setRegistrationLevel('1')
    ->setRegistrationDate('20160412');
    
$authorizationInstance = (new Authorization(100.00, 'EUR', $returnUrl))
    ->setRiskData($riskData)
    ->setInvoiceId('INV-123456');
    
$paymentType = new PaylaterInvoice();

$transaction = $unzer->performAuthorization($authorizationInstance, $paymentType, $customer, null, $basket);

Unzer unzer = new Unzer("s-priv-xxxxxxxxxx");

RiskData riskData = (new RiskData())
    .setThreatMetrixId("f544if49wo4f74ef1x")
    .setCustomerGroup("TOP")
    .setConfirmedAmount("2569")
    .setConfirmedOrders("14")
    .setRegistrationLevel("1")
    .setRegistrationDate(new Date());
    
Authorization authorizationInstance = (new Authorization())
        .setAmount(BigDecimal.valueOf(100.))
        .setCurrency(Currency.getInstance("EUR"))
        .setRiskData(riskData)
        .setInvoiceId("INV-123456");

Authorization transaction = unzer.authorize(authorizationInstance);

The response looks similar to the following example:

GET: https://api.unzer.com/v1/payments/{{random_Order_Id}}/authorize/{{auth-Id}}

Body
{
    "id": "s-aut-1",
    "isSuccess": true,
    "isPending": false,
    "isError": false,
    "message": {
        "code": "COR.000.000.000",
        "merchant": "Transaction succeeded",
        "customer": "Your payments have been successfully processed."
    },
    "amount": "100.0000",
    "currency": "EUR",
    "returnUrl": "",
    "date": "2022-06-29 11:55:55",
    "resources": {
        "customerId": "s-cst-472f919218b5",
        "paymentId": "s-pay-124",
        "basketId": "s-bsk-49277b9f7ee0",
        "traceId": "fd58542dd6d6e2ad681a98dc692c5c45",
        "typeId": "s-piv-zex7c9iibpek"
    },
    "additionalTransactionData": {
        "riskData": {
            "threatMetrixId": "f544if49wo4f74ef1x",
            "customerGroup": "TOP",
            "confirmedAmount": "2569",
            "confirmedOrders": "14",
            "registrationLevel": "1",
            "registrationDate": "20160412"
        }
    },
    "orderId": "ORD-123456",
    "invoiceId": "INV-123456",
    "paymentReference": "",
    "processing": {
        "iban": "AT611904300234573201",
        "bank": "Bank Frick Name",
        "uniqueId": "Tx-bxahqq6dmxy",
        "shortId": "Tx-bxahqq6dmxy",
        "descriptor": "BKPB-QCCJ-KKQG",
        "holder": "John Doe",
        "traceId": "fd58542dd6d6e2ad681a98dc692c5c45"
    }
}

For more details on managing Unzer Invoice payments, see Manage Unzer Invoice payments.

Step 3: Check status of the payment
server side

Once the transaction is made, you can fetch the payment details from the API, by using the resources.paymentId from the charge response above to handle the payment according to its status, such as s-pay-124. Check all possible payment states here.

GET: https://api.unzer.com/v1/payments/s-pay-xxxxxxx

$unzer    = new UnzerSDK\Unzer('s-priv-xxxxxxxxxx');
$payment  = $unzer->fetchPayment('s-pay-xxxxxxx');

Unzer unzer = new Unzer("s-priv-xxxxxxxxxx");
Payment payment = unzer.fetchPayment("s-pay-xxxxxxx");

Step 5: Display the payment result
client side

Use the information from the Check status of the payment step to display the payment result to your customer.
This can be the success or error page of your shop. If something went wrong, you can use the client message from the API response and show it to the customer.

Manage payment
server side

For more details on managing Unzer Invoice payments, see Manage Unzer Invoice payments.

Notifications

We recommend subscribing to the payment event to receive notifications about any changes to the payment resource. As soon as the event is triggered you should fetch the payment and update the order status in your shop according to its status.

  {
    "event":"payment.pending",
    "publicKey":"s-pub-xxxxxxxxxx",
    "retrieveUrl":"https://api.unzer.com/v1/payments/s-pay-774",
    "paymentId":"s-pay-774"
  }

For more details on implementing webhooks to receive notifications, see Notifications page.

Error handling

All requests to the API can result in an error that should be handled. Refer to the Error handling guide to learn more about Unzer API (and other) errors and handling them.

Test & go live

You should always test your integration before going live. First perform test transactions using test data. Next, check against Integration checklist and Go-live checklist to make sure the integration is complete and you’re ready to go live.

Important information

Accept Unzer Invoice with UI components

Overview

Before you begin

Step 1: Add UI components to your payment page
client side

Initiate UI component

Load our JS script and CSS stylesheet

Create an Unzer instance

Localization and languages

Implement the payment form

Option 1: Implement with customer form

Option 2: Create the customer on the server side

Create the payment type resource

Add an event listener and submit the form

Option 1: Without the customer form

Option 2: With the customer create/update form

Step 2: Make a payment
server side

Create the customer resource

B2C customer creation

B2B customer creation

Create a basket resource

Add the ThreatMetrix script

Do a risk check for the customer
server side

Make an authorize transaction

Provide the customer risk information

Step 3: Check status of the payment
server side

Step 5: Display the payment result
client side

Manage payment
server side

Notifications

Error handling

Test & go live

See also

Accept Unzer Invoice with UI components

Step 2: Make a payment server side

Do a risk check for the customerserver side

Step 3: Check status of the paymentserver side

Step 5: Display the payment resultclient side

Manage paymentserver side

Step 2: Make a payment
server side

Do a risk check for the customer
server side

Step 3: Check status of the payment
server side

Step 5: Display the payment result
client side

Manage payment
server side