Introduction

Klarna is a global leader in flexible payment solutions. Klarna Debit Risk provides high-risk partners a fast, secure bank transfer product with high acceptance rates via Pay Now.

Supported Countries

• Austria
• Belgium
• Finland
• Germany
• Netherlands
• Spain
• Sweden
• Switzerland
• United Kingdom

Supported Currencies

• CHF
• EUR
• GBP
• SEK

REST API 1.0

Payment Flow

1. Generate a sessionToken.
   For details, see Authentication.

2. Perform the payment by sending a /payment request with the following mandatory parameters:

• • userTokenId
  • amount
  • currency
  • paymentOption.alternativePaymentMethod class containing:
    • paymentMethod: “apmgw_Sofort”
  • deviceDetails class containing:
    • • ipAddress

Example /payment Request

{
  "sessionToken":"<sessionToken from /getSessionToken>",
  "merchantId":"<your merchantId>",
  "merchantSiteId":"<your merchantSiteId>",
  "clientRequestId":"<unique request ID in merchant system>",
  "amount":"200",
  "currency":"EUR",
  "userTokenId":"<unique customer identifier in merchant system>",
  "clientUniqueId":"<unique transaction ID in merchant system>",
  "paymentOption":{
    "alternativePaymentMethod":{
      "paymentMethod":"apmgw_Sofort"
    }
  },
  "deviceDetails":{
    "ipAddress":"<customer's IP address>"
  },
  "billingAddress":{
    "firstName":"John",
    "lastName":"Smith",
    "country":"DE",
    "email":"[email protected]"
  },
  "userDetails":{
    "firstName":"John",
    "lastName":"Smith",
    "country":"DE",
    "email":"[email protected]"
  },
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

The response returns a redirectUrlto redirect the customer to the payment page, as well as a userPaymentOptionId (UPO) for use in future transactions.

Example /payment Response

{
  "orderId":"341413598",
  "userTokenId":"Usertoken01",
  "paymentOption":{
    "redirectUrl":"https://apitest.nuvei.com/Home?PaymentToken=F355F191C8B97D1D3B8453B283258C66.13560826",
    "userPaymentOptionId":"83246818"
  },
  "transactionStatus":"REDIRECT",
  "sessionToken":"f43d774a-a180-4935-bbc1-1315bb4dc203",
  "internalRequestId":549917488,
  "status":"SUCCESS",
  "errCode":0,
  "reason":"",
  "merchantId":"2439523627382132721",
  "merchantSiteId":"224428",
  "version":"1.0",
  "clientRequestId":"20221104131500"
}

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to the URL provided in urlDetails.notificationUrl, which Nuvei recommends including in the /payment request.

Payout Flow

Perform a /payout via the following options:

• Use the “apmgw_Sofort” UPO to process the /payout.
• Collect account details from the deposit and use them with another supported payment method, including ‘SEPA Payouts’.
  • For example, use the IBAN received in the DMN to create a ‘SEPA Payouts’ /payout request.

1. Register a userTokenId.
   
   A userTokenId is a field in the Nuvei system containing the user identifier in the merchant system.

2. Create a UPO by sending an /addUPOAPM request that includes the following parameter:
   • “apmgw_Sofort”

3. Send a /payout request and include the userPaymentOptionId (UPO), which contains the user’s previously stored APM account details.
   
   For an example, see Payout.

   After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payout request.

REST API 2.0

Payment Flow

1. Perform the payment by sending a /payments request with the following mandatory parameters:

• • amount
  • currency
  • paymentOption.aleternativePaymentMethod class containing:
    • name: “klarnaDebitRisk”
  • deviceDetails class containing:
    • ipAddress
  • buyerDetails.billingAddress class containing:
    • countryCode
  • buyerDetails class containing:
    • buyerId
    • firstName
    • lastName
    • email

Example /payments Request

{
  "processingEntityId": "<<processing entity id>>",
  "amount": 12,
  "currency": "EUR",
  "transactionType": "Sale",
  "paymentOption": {
    "alternativePaymentMethod": {
      "name": "klarnaDebitRisk"
    }
  },
  "custom": {
    "description": "Some description"
  },
  "deviceDetails": {
    "deviceType": "desktop",
    "deviceName": "iPhone 5s",
    "deviceOS": "iOs 10.2",
    "ipAddress": "192.168.2.38"
  },
  "buyerDetails": {
    "buyerId": "JohnSmith123",
    "firstName": "John",
    "lastName": "JSmith",
    "companyName": "Nuvei Corp",
    "locale": "bg-BG",
    "dateOfBirth": "1978-01-01",
    "email": "[email protected]",
    "phone": "+1234567889",
    "billingAddress": {
      "address": "30 Alenbi st",
      "zip": "1234",
      "city": "Berlin",
      "countryCode": "DE",
      "phone": "+1234567889",
      "addressMatch": true
    },
    "shippingAddress": {
      "sameAsBilling": true,
      "address": "30 Alenbi st",
      "zip": "1234",
      "city": "Berlin",
      "countryCode": "DE",
      "phone": "+1234567889"
    }
  }
}

The response returns a redirect URL to redirect the customer to the payment page as well as a payment token paymentTokenId for use in future transactions.

Example /payments Response

{
  "paymentId": "a26e7096e4ce4a64ba7ad2cd7314f740",
  "amount": 12,
  "currency": "EUR",
  "transactionType": "Sale",
  "result": {
    "status": "redirect"
  },
  "redirectUrl": "https://www.directebanking.com/payment/start?...",
  "paymentOption": {
    "alternativePaymentMethod": {
      "name": "klarnaDebitRisk",
      "paymentTokenId": "d18dce0f16a84bfeb5f35d2acf5873e0"
    }
  }
}

After the transaction is processed, Nuvei sends a webhook (DMN) that includes the result of the transaction to the URL provided in urlDetails.webhookUrl, which Nuvei recommends including in the /payments request.

Payout Flow

Submit a /payouts request with one of the following parameters:

• paymentOption.alternativePaymentMethod
• paymentOption.alternativePaymentMethod class containing:
  • name: “klarnaDebitRisk”

Example Request

{
  "processingEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 60,
  "currency": "EUR",
  "paymentOption": {
    "alternativePaymentMethod": {
      "name": "klarnaDebitRisk"
    }
  },
  "buyerDetails": {
    "buyerId": "buyerId123",
    "firstName": "John",
    "lastName": "JSmith",
    "companyName": "Nuvei Corp",
    "locale": "bg-BG",
    "dateOfBirth": "1978-01-01",
    "email": "[email protected]",
    "phone": "+1234567889",
    "billingAddress": {
      "state": "TX",
      "city": "Austin",
      "zip": "78652",
      "countryCode": "US"
    },
    "shippingAddress": {
      "sameAsBilling": true
    }
  }
}

Initiating Payout via paymentTokenId

Use paymentToken.paymentTokenId to perform the /payouts using a previously stored alternativePaymentMethod account.

Example /payouts Request via paymentTokenId

{
  "processingEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 60,
  "currency": "EUR",
  "paymentOption": {
    "paymentToken": {
      "paymentTokenId": "abc123def456ghi789jkl012mno345pq"
    }
  },
  "buyerDetails": {
    "buyerId": "buyerId123",
    "firstName": "John",
    "lastName": "JSmith",
    "companyName": "Nuvei Corp",
    "locale": "bg-BG",
    "dateOfBirth": "1978-01-01",
    "email": "[email protected]",
    "phone": "+1234567889",
    "billingAddress": {
      "state": "TX",
      "city": "Austin",
      "zip": "78652",
      "countryCode": "US"
    },
    "shippingAddress": {
      "sameAsBilling": true
    }
  }
}

After the transaction is processed, Nuvei sends a webhook that includes the result of the transaction to the URL provided in urlDetails.webhookUrl, which Nuvei recommends including in the /payouts request in order to receive asynchronous notifications.

User Experience

• 1. The user is redirected to Klarna. The user confirms the payment details and selects Pay with Klarna.
     
  2. The user signs in to the online banking application.
     
  3. The user provides the one-time password (OTP) and confirms the payment.
     
  4. If the user entered the correct details, the transaction is complete and the merchant receives a notification with the success status.
     The customer is redirected to the merchant return URL.
     

Testing

To test the Klarna Pay Now payment method successfully, use the following test data.

Data	Value
Email for Austria:	Approved: [email protected] Denied: [email protected]
Email for Germany:	Approved: [email protected] Denied: [email protected]
Email for United Kingdom:	Approved: [email protected] Denied: [email protected]
First Name:	Enter any name. Example: Doe
Last Name:	Enter any name. Example: Test
Phone Number for Austria:	Approved: +4306762600456 Denied: +4306762600745
Phone Number for Germany:	Approved: +49017614284340 Denied: +49017610927312
Phone Number for United Kingdom:	Approved: +447755564318 Denied: +447355505530
City	Enter any city. Example: London
Street	Enter any street. Example: Great Russell
Zip Code	Enter any valid zip code. Example: WC1B 3DG
Date of Birth	Enter any date.
Available countries:	AT, DE, GB