Klarna

Klarna is a "Buy Now, Pay Later" payment method allowing your customer to pay in installments.

Note

Make yourself familiar with our API Principles to ensure a resilient integration.

Product overview

Capabilities

defer payment by 30 days
spread the cost over three (four in some markets) equal interest-free installments
spread the cost up to 36 months (with financing)
pay the full amount immediately with "Pay Now" for card, local domestic or local bank transfer payments

Brand and marketing guidelines

Follow the link for the latest guidelines from Klarna.

Feature summary

Payment type	Countries	Recurring	Reversals	Partial Reversals	Disputes	Auth only
Pay Now, Pay in Parts, Pay Later, Financing	AT,BE,FI,DE,NL,NO,ES,SE,CH	❌	✅	Partial refund - yes Partial cancel- No	Handled directly via Klarna. Worldpay will deduct the funds if the dispute is lost.	✅

Note

Refunds are completed through Klarna to your customer's account within 365 days and you can submit multiple partial refunds for one payment.

Acceptance currencies

Currency	Currency Codes
Czech Koruna	CZK
Danish Krone	DKK
Euro	EUR
Norwegian Krone	NOK
Polish Złoty	PLN
Pound Sterling	GBP
Swedish Krona	SEK
Swiss Franc	CHF

Get started

Get started using our API Reference and set your headers.

Request

POST https://try.access.worldpay.com/apmPayments

Example request

application/json

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "klarna",
    "value": {
      "amount": 2468,
      "currency": "GBP"
    },
    "narrative": {
      "line1": "MindPalace"
    },
    "paymentInstrument": {
      "type": "direct",
      "country": "GB",
      "language": "en",
      "billingAddress": {
        "address1": "221B Baker Street",
        "address2": "Marylebone",
        "address3": "Westminster",
        "postalCode": "NW1 6XE",
        "city": "London",
        "state": "Greater London",
        "countryCode": "GB"
      }
    },
    "resultUrls": {
      "cancel": "https://worldpay.com/cancel",
      "failure": "https://worldpay.com/failure",
      "pending": "https://worldpay.com/pending",
      "success": "https://worldpay.com/success"
    },
    "shipping": {
      "method": "registered box",
      "timeFrame": "normal",
      "firstName": "James",
      "lastName": "Moriarty",
      "phone": "00000000000",
      "email": "test@email.com",
      "address": {
        "address1": "221B Baker Street",
        "address2": "Marylebone",
        "address3": "Westminster",
        "postalCode": "NW1 6XE",
        "city": "London",
        "state": "Greater London",
        "countryCode": "GB"
      }
    },
    "customer": {
      "firstName": "James",
      "lastName": "Moriarty",
      "email": "moriarty@example.com",
      "phone": "00000000000",
      "dateOfBirth": "1999-01-01"
    },
    "order": {
      "orderTotalTaxAmount": 0,
      "termsUrl": "https://example.com",
      "items": [
        {
          "type": "physical",
          "productCode": "fff1223",
          "name": "Red Hat",
          "quantity": 1,
          "unitOfMeasure": "per unit",
          "unitCost": 1234,
          "taxRate": 1,
          "totalTaxAmount": 0,
          "totalAmount": 1234,
          "totalDiscountAmount": 0,
          "productUrl": "https://example.com",
          "imageUrl": "https://example.com"
        },
        {
          "type": "physical",
          "productCode": "fff1256",
          "name": "Blue Hat",
          "quantity": 1,
          "unitOfMeasure": "per unit",
          "unitCost": 1234,
          "taxRate": 1,
          "totalTaxAmount": 0,
          "totalAmount": 1234,
          "totalDiscountAmount": 0,
          "productUrl": "https://example.com",
          "imageUrl": "https://example.com"
        }
      ]
    }
  }
}

Information

You must settle the payment, using next action links, when using Klarna with a token.

Parameters

transactionReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required

merchantobject(MerchantV2)required

merchant.entitystring[ 3 .. 32 ] characters^([a-zA-Z0-9\- ]*)$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"

instructionobject(InstructionV2)required

Object that contains the payment type and details.

instruction.methodstringrequired

Type of payment method

Value"alipay_cn"

Discriminator

instruction.valueobject(Value)required

The value of the payment.

instruction.value.amountinteger(int64)[ 1 .. 2147483647 ]required

The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.

Example: 12

instruction.value.currencystringrequired

The supported ISO 4217 currency codes.

Enum"AED""AFN""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD"

instruction.narrativeobject(NarrativeBase)required

instruction.narrative.line1string[ 1 .. 24 ] characters^[a-zA-Z0-9-., ]*$required

The description shown on your customer's bank statement for the payment.

Example: "MindPalace"

instruction.paymentInstrumentobject(AlipayCnInstrumentV2)required

instruction.paymentInstrument.typestringrequired

Type of instruction

Value"direct"

instruction.paymentInstrument.languagestring

Your customer's language.

Enum"aa""ab""ae""af""ak""am""an""ar""as""av"

instruction.resultUrlsobject(ResultUrlsAlipay)required

instruction.resultUrls.cancelstring

The URL your customer is redirected to, after a cancelled payment outcome.

Example: "https://worldpay.com/cancel"

instruction.resultUrls.failurestringrequired

The URL your customer is redirected to, after a failed payment outcome.

Example: "https://worldpay.com/failure"

instruction.resultUrls.pendingstringrequired

The URL your customer is redirected to, after a pending payment outcome.

Example: "https://worldpay.com/pending"

instruction.resultUrls.successstringrequired

The URL your customer is redirected to, after a successful payment outcome.

Example: "https://worldpay.com/success"

instruction.deviceDataobject(DeviceData)

instruction.customerobject(CustomerWithName)

Recommendation

We suggest you provide the cancelURL,failureURL, pendingURL and successURL attribute to redirect your customer to, once you have received the payment result.

Response

Successful response

an HTTP code 201
an id which is unique to the payment - we recommend storing the "id" as this can be used to manage the payment later
a url to redirect your customer to the APM provider to complete the payment
a link to query the payment status
an object which will give flow information such as method (e.g. klarna), type (e.g. direct for the Redirect URL flow)
an action id generated by us identifying a single merchant interaction (e.g. cmdYNdIHBPJwbkjLiykzTx0)

Example response

{
  "paymentId": "uK9Oh5zz4yKhGuFofhhnC056-K6qn-w8Krt2pRT2oSzwh_KRcHUrrs1qJtQso9gjgJ_wwjT869eMBB_T4PM4D6HdjtgfjDBh7htEkjHxp4Q_KzkRIENkZoejad--FtjVrMslJn1mvz4mwr-TuKlP9ZAhBEzSApkfhL__fXCo-vMkR1a2Zrj_R8rGSgu6m2Wd",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/uK9Oh5zz4yKhGuFofhhnC056-K6qn-w8Krt2pRT2oSzwh_KRcHUrrs1qJtQso9gjgJ_wwjT869eMBB_T4PM4D6HdjtgfjDBh7htEkjHxp4Q_KzkRIENkZoejad--FtjVrMslJn1mvz4mwr-TuKlP9ZAhBEzSApkfhL__fXCo-vMkR1a2Zrj_R8rGSgu6m2Wd"
    }
  },
  "_actions": {},
  "redirect": "https://secure-test.worldpay.com/jsp/test/shopper/APMSTSimulator.jsp?customerRef=3417843726&amp;paymentMethod=KLARNA_PAYNOW&amp;country=DE",
  "paymentInstrument": {
    "method": "klarna",
    "type": "direct"
  },
  "commandId": "cmdEy5vwB0krLe9eMwAcE66c0"
}

Errors

Check out our API reference for the full error code schema.

Next steps

Manage your Klarna payment