PSP Onboarding API - MoR (v1)

Download OpenAPI specification:Download

psp-onboarding-controller

suspendMid

suspend merchant

Request
path Parameters
mid
required
string
header Parameters
Klarna-Correlation-Id
string

A unique identifier carried through Klarna's service flows that helps with request tracing. Helpful for support cases.

Responses
200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

post/onboarding-psp/v1/merchant/{mid}/suspend
Request samples
curl -i -X POST \
  'https://api.klarna.com/onboarding-psp/v1/merchant/{mid}/suspend' \
  -H 'Klarna-Correlation-Id: string'

patchMerchantByMid_1

Update data of a Merchant according to JSON Merge Patch specification. When a field is absent, its previous value will remain. Some fields can be set explicitly to null to delete the previous value without setting a new one.

Request
path Parameters
mid
required
string
header Parameters
Klarna-Idempotency-Key
string

Calling an API endpoint with the same Klarna-Idempotency-Key more than once, produces the exact same response as the first call, without any effect on Klarna's side. Useful if you want to ensure "only once" operations, for example retrying a call after a client-side timeout.

Klarna-Correlation-Id
string

A unique identifier carried through Klarna's service flows that helps with request tracing. Helpful for support cases.

Partner-Override-Id
string

Needs to be send only if there is more then one distribution partner id

Request Body schema: application/json
object (OnboardingBusinessInformationDto)
object (Store)
Array of objects (StakeholderDto)
platform
string

The platform of the merchant. E.g. WooCommerce, shopify, etc.

Responses
200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

patch/onboarding-psp/v1/merchant/{mid}
Request samples
application/json
{
  • "business": {
    },
  • "store": {
    },
  • "stakeholders": [
    ],
  • "platform": "string"
}

requestTemporaryMIDs

Pick reserved merchant from prepared pool

Request
header Parameters
Klarna-Idempotency-Key
string

Calling an API endpoint with the same Klarna-Idempotency-Key more than once, produces the exact same response as the first call, without any effect on Klarna's side. Useful if you want to ensure "only once" operations, for example retrying a call after a client-side timeout.

Klarna-Correlation-Id
string

A unique identifier carried through Klarna's service flows that helps with request tracing. Helpful for support cases.

Partner-Override-Id
string

Needs to be send only if there is more then one distribution partner id

Request Body schema: application/json
bank_account_preset_id
integer <int32>

Identifier of bank account preset set up for the merchant. Required only when multiple exist. Otherwise, optional.

price_plan
string

Name of price plan to set up for the merchant. Required only when multiple exist. Otherwise, optional.

object (OnboardingBusinessInformationDto)
object (Store)
Array of objects (StakeholderDto)
platform
string

The platform of the merchant. E.g. WooCommerce, shopify, etc.

Responses
200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

post/onboarding-psp/v1/merchant
Request samples
application/json
{
  • "bank_account_preset_id": 0,
  • "price_plan": "string",
  • "business": {
    },
  • "store": {
    },
  • "stakeholders": [
    ],
  • "platform": "string"
}
Cookies
Terms of Service
© Klarna 2024