Klarna

Recurring

Note

For guest checkout integrations after March 2026, please refer to Klarna.

This previous version of Klarna is for recurring integrations (and for guest checkout integrations existing before March 2026).

In this case, the recurring functionality allows you to save a token which represents your customer's data and use this across multiple requests to 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 a period of up to 36 months (with financing)
pay the full amount immediately with "Pay Now" for card, local domestic or local bank transfer payments
spread the cost over three (four in some markets) equal interest-free installments

Klarna manages the relationship and collection of future installment payments directly with your customer. You receive full funding upfront and are protected from the risk of unpaid installments.

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. We 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

Use our API reference and set your headers.

Request

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

Example request

Apply APM payment details directly using our APMs API, or use our Components SDK to create a session.

Collect the APM details and send an API request with these details to create a payment.

application/json

{
  "transactionReference": "Memory265-13/08/1876",
  "orderReference": "apm-order-12345",
  "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"
      }
    },
    "customerAgreement": {
      "type": "recurring",
      "description": "monthly Subscription",
      "agreementName": "trial1",
      "startDate": "2024-09-10",
      "endDate": "2025-09-10",
      "affiliateName": "partner a"
    },
    "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

For Bizum transactions, please follow this extra regex [a-zA-Z0-9]{4,12}

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

A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:

the total amount for a single order is split across multiple payments
you use a single reference for each payment in a recurring agreement or split shipment scenario

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"ach"

Discriminator

instruction.valueobject(ValueV2)required

The value of the payment.

instruction.value.currencystringrequired

The supported ISO 4217 currency codes.

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

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: 1234

instruction.narrativeobject(NarrativeV2)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(AchPaymentInstrumentV2)required

instruction.paymentInstrument.typestringrequired

Enum"direct""checkout"

Discriminator

instruction.paymentInstrument.accountTypestringrequired

Account type.

Enum"checking""savings""corporate""corporateSavings"

Example: "checking"

instruction.paymentInstrument.accountNumberstring[ 1 .. 17 ] characters^[0-9]*$required

Account number of direct debit account.

Example: "123456789"

instruction.paymentInstrument.routingNumberstring= 9 characters^[0-9]*$required

Routing number of direct debit account.

Example: "123456789"

instruction.paymentInstrument.checkNumberstring[ 1 .. 15 ] characters^[0-9]*$

Check number of the direct debit account.

Example: "123456789"

instruction.paymentInstrument.companyNamestring[ 1 .. 40 ] characters

Company name if a corporate account.

Example: "Joe Plumbing Ltd."

instruction.paymentInstrument.billingAddressobject(AchBillingAddress)required

instruction.paymentInstrument.billingAddress.address1string[ 1 .. 80 ] charactersrequired

First line of the address.

instruction.paymentInstrument.billingAddress.address2string[ 1 .. 80 ] characters

Second line of the address.

instruction.paymentInstrument.billingAddress.address3string[ 1 .. 80 ] characters

Third line of the address.

instruction.paymentInstrument.billingAddress.postalCodestring[ 1 .. 15 ] charactersrequired

Postal code.

instruction.paymentInstrument.billingAddress.citystring[ 1 .. 50 ] charactersrequired

City.

instruction.paymentInstrument.billingAddress.statestring[ 1 .. 30 ] characters

State code of the billing address in ISO 3166-2 format.

Example: "US-OH"

instruction.paymentInstrument.billingAddress.countryCodestringrequired

The supported ISO 3166-1 alpha-2 country codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AN""AO""AQ"

instruction.customerobject(CustomerDetailsAch)required

instruction.customer.emailstring[ 1 .. 128 ] characters^(.+@.+\..+)?$

Your customer's email address.

Example: "customer@example.com"

instruction.customer.firstNamestring[ 1 .. 22 ] charactersrequired

Your customer's first name.

instruction.customer.lastNamestring[ 1 .. 22 ] charactersrequired

Your customer's last name.

instruction.customer.customerIdstring[ 1 .. 15 ] characters[a-zA-Z0-9]*

Your unique reference for the customer so that the 'pay faster next time' function can be used during checkout. This allows your customer's chosen bank to be stored for their next payment.

Example: "44528abcd"

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

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": "klarna/token"
  },
  "commandId": "cmdEy5vwB0krLe9eMwAcE66c0"
}

Schema

paymentIdstring

The identifier of the payment resource.

lastEventstring

Enum"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""sentForAuthorization""settlementFailed""chargebackReversed""chargedBack""disputeExpired"

_linksobject(Links)

Links to resources related to the request.

_actionsobject(ActionsV2)

redirectstring

The URL to redirect your customer to, or a QR code in Base64 to show to your customer, in order to complete the transaction.

commandIdstring

An action ID generated by us, identifying a single merchant interaction.

Example: "cmdYNdIHBPJwbkjLiykzTx0"

paymentInstrumentAll others (object) or PayPal (object) or SEPA DD (object) or Klarna (recurring) token (object)(PaymentInstrument)

Payment instrument details for the payment response.

One of:

Payment instrument for: ACH, Alipay China, Alipay Hong Kong, Alipay Plus, BANCOMAT Pay, Bancontact, Bizum, BLIK, EFT, Euteller, iDEAL guest, iDEAL recurring, Klarna, Klarna (recurring), Konbini, Multibanco, MyBank, Open Banking, PaysafeCard, Pix, Przelewy24, SafetyPay, Satispay, Swish, Trustly, China UnionPay, WeChat Pay.

transactionCodestring

For Pix payments - display to your customer for them to copy and paste in the Pix app.

For Swish payments - use this value as the {token} in the custom URL scheme: swish://paymentrequest?token={token}&callbackurl={callbackURL}. This will prompt the app to open, allowing your customer to complete their payment.

Example: "IZQ3iUfePwiWiwldJlipl8NGVA7w5IUg"

Errors

Check out our API reference for more responses or error codes.

Next steps

Manage your Klarna (recurring) payment

Klarna

Capabilities

Brand and marketing guidelines

Feature summary

Acceptance currencies

Get started

Request

Example request

Parameters

Response

Example response

Schema

Errors

Do you like our page?