Onboard partners

Streamline partner onboarding with Klarna by using the Onboarding API, ensuring accurate data submission, compliance, and seamless access to Klarna Payment Services.

To start offering Klarna Payment Services to their Partners, Acquiring Partners must first onboard them to Klarna.

During this process, it's crucial to define the appropriate structure based on the Partner's business model, as detailed in the in Determine account structure.

To onboard a Partner, the Acquiring Partner must use the Onboard APIAPI endpoint and specify the following parameters:

Onboard
API
POST:/v2/distribution/onboard
Show recommended
ParameterRequiredDescription
partner_account_reference
Yes

Provide a unique string reference for the Partner account to identify it within the integrator system without relying on Klarna-generated IDs. This reference is used to associate requests with the correct Partner account. Ensure the referen...

partner_account_name
Yes

A human-readable name that represents the current partner, such as the company conglomerate name, a brand, or similar. Not used for customer interactions.

partner_account_contact
Yes

Provide the key contact details for the Partner account. The server validates that this field contains a non-empty, valid object representing the contact. Ensure the object includes the required contact attributes.

-email
Yes

E-mail address. Regex ^(?=.{1,64}@.{1,255}$)(?:[a-zA-Z0-9!#$%&'+/=?^_{|}~\p{IsLatin}\p{N}\p{S}-&&[^<>]]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_{|}~\p{IsLatin}\p{N}\p{S}-&&[^<>]]+)|"(?:[\x01-\x08\x0B\x0C\x0E-\x1F\x21\x23-\x5B\x5D-\x7F]|\[\x01-\x09...

partner_business_entities
Yes

Provide details about the business entities associated with the Partner account, including legal entity information. This information is used to verify and manage the Partner’s legal identity and compliance status. Ensure the value is a non...

-partner_business_entity_reference
Yes

Provide a unique reference used by the integrator to identify a specific Partner entity within their system. This reference is used to associate requests with the correct Partner entity.

-legal_registered_entity_name
Yes

Provide the official registered name of the Partner’s legal entity to identify the organization in legal and compliance contexts. The server stores this name as part of the Partner’s legal entity data. Ensure the value is a non-empty string...

-legal_registration_country
Yes

Provide the two-letter country code in ISO 3166‑1 alpha‑2 format for the indicated address. The system accepts only predefined country codes such as US, DE, SE, and AU. Treat the country code as an opaque string, do not parse or interpret i...

products
Yes

Information about which products are being configured for this merchant

-type
Yes

The type of product available to the merchant or partner.

Values:

  • PAYMENT: Klarna's payment services
-payment_profile_id
Yes

The payment profile identifier. Previously known as Distribution Profile ID

-payment_accounts
Yes

List of Payment Accounts. Payment accounts connect a set of configuration data points to an integrator-defined reference that can be used to operate Klarna's payment products.

--payment_account_reference
Yes

A unique string reference for the payment account, used by the partner to identify the payment account without relying on Klarna-generated IDs.

--payment_acquiring_account_id
Yes

Unique account identifier assigned by Klarna to the Acquiring Account.

--default_merchant_category_code
Yes

The Merchant Category Code (MCC) is a four-digit number that is used to classify the type of goods or services offered by a business. [Read more here]( https://docs.klarna.com/klarna-network-distribution/manage-partners/onboard-and-manage-p...

Showing 15 of 27
Back to Top
Here you can find all required parameters for this operation onboard
API

Selecting a payment product will activate all related payment services in all markets where Klarna is available, allowing a Partner to offer Klarna as a payment method.

It is essential Acquiring Partners provide all relevant and available Partner information as specified in the data transfer and cooperation agreement with Klarna.

Sharing correct and accurate data allows Klarna to perform a better assessment of the risk associated with your Partners, enabling a safer experience to all parties.

It's also important to have in mind the following about the onboarding properties:

  • References should map to the identifier for the same object type on the Acquiring Partner systems. These identifiers can be used later on to integrate to other parts of the Klarna APIs
  • Some identifiers are setup and provided by Klarna and must be configured on the integration. For example, Klarna will provide Payment Profile IDs and Acquiring Account IDsthat match the required complexity on the Acquiring Partner structure.

Sample request

JSON
{
  "partner_account_reference": "M123786123412",
  "partner_account_name": "John Doe Stakehouse",
  "partner_account_contact": {
    "given_name": "John",
    "family_name": "Doe",
    "email": "john.doe@example.com",
    "phone": "+18445527621"
  },
  "partner_business_entities": [

When a Partner is successfully onboarded with Klarna, Klarna will create an account for the Partner and return an partner_account_id in the onboarding response. At this point, they are ready to begin transacting in all markets where Klarna is available.

Remember to store the partner_account_id associated with the Partner as it is a required parameter for the integration of the Partner Product API.

The combination of acquiring_account_id and payment_account_reference may also be used later for the integration of the Partner Product API, in cases where multiple Payment Accounts exist for the same Partner Account.

Other references, such as for Stores, Store Groups and similar, may also be relevant later on when integrating with other APIs, which emphasize the importance of setting the correct identifiers during onboarding

Sample response

JSON
{
  "partner_account_id": "krn:partner:global:account:test:MABCDEFG",
  "partner_account_reference": "M123786123412",
  "partner_account_name": "John Doe Stakehouse",
  "state": "PARTIALLY_OPERATIONAL",
  "state_reason": "INITIAL_SETUP"
}

The example provided here is for illustrative purposes only. The parameters required for onboarding may vary based on your commercial agreement and the parameters available to you.

Once the onboarding is executed, the account is ready to transact, but might still be set up in Klarna systems, the details about this process is available on the Account Lifecycle Webhooks page.

During the onboarding, there are some data points and connections that are immutable and cannot be changed. Make sure the information provided is accurate:

Payment Account:

  • Connection to Partner Legal Entity
  • Connection to Payment Acquiring Account

Payment Product:

  • Connection to Payment Profile

Partner Legal Entity:

  • Legal registration name
  • Legal registration country

Integrating Klarna Payment Services requires accurate and complete Partner data to ensure seamless transaction processes and fraud prevention. This section covers the essential steps and protocols activated when discrepancies in Partner data are detected during the onboarding process.

Klarna's Partner management API performs real-time validations on all incoming data. In most of the cases when data fields are missing or incorrect, the system triggers an automated response outlining the specific issues. These validations cover critical information such as business details, tax IDs, and contact information.

Whenever incomplete or invalid data for a brand is submitted during the onboarding, Klarna will trigger a account brand data incomplete webhook to which you can subscribe to:

EVENT NAMEWHEN

partner.account.brand.data-incomplete

to receive notifications when the brand data submitted during account onboarding is invalid or incomplete

The partner.account.brand.data-incomplete webhook event will notify Partners when the brand data submitted during account onboarding is invalid and any invalid or incomplete brand will be removed, while valid brand information will be persisted.

While this webhook is informational and does not block onboarding, Klarna highly recommends that the invalid information is updated with corrected elements to ensure optimal brand representation.