Klarna Settlements API (1.0.0-rc2)

Download OpenAPI specification:Download

The Settlements API helps you with the reconciliation of payments, made by Klarna to your bank account. Every payment has a unique payment_reference that can be found in the settlement reports and on your bank statement.

Read more on Settlement reports.

Authentication

basic_auth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

payouts

Get summary of payouts

Returns a summary of payouts for each currency code in a date range.

Request
query Parameters
start_date
required
string <date-time>

ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. For example 2020-01-23 -> 2020-01-23T00:00:00Z. For this reason we recommend too use the full datetime like 2020-01-23T00:00:00Z.

end_date
required
string <date-time>

ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. This might lead to unwanted side effects like when the start date and end date might be the same because it would request payouts between 2020-01-23T00:00:00Z and 2020-01-23T00:00:00Z. Instead we advise to use a full datetime like 2020-01-23T23:59:59Z.

currency_code
string

An optional currency code to filter the result for different currencies. If not provided the result returned in the response might include multiple results grouped by the currency. The currency should be provided by an ISO 4217 Currency Code like USD, EUR, AUD or GBP.

Responses
200

Payout summaries

400

Bad request

get/payouts/summary
Request samples
curl -i -X GET \
  'https://api.klarna.com/settlements/v1/payouts/summary?start_date=2019-08-24T14%3A15%3A22Z&end_date=2019-08-24T14%3A15%3A22Z&currency_code=string'
Response samples
application/json
[
  • {
    }
]

Get payout

Returns a specific payout based on a given payment reference.

Request
path Parameters
payment_reference
required
string

The reference id of the payout. Normally this reference can be found on your payment slip statement of your bank.

Responses
200

A payout

400

Bad request

404

Not found

get/payouts/{payment_reference}
Request samples
curl -i -X GET \
  'https://api.klarna.com/settlements/v1/payouts/{payment_reference}'
Response samples
application/json
{
  • "totals": {
    },
  • "payment_reference": "XISA93DJ",
  • "payout_date": "2016-12-14T07:52:26Z",
  • "currency_code": "USD",
  • "currency_code_of_registration_country": "EUR",
  • "merchant_settlement_type": "NET",
  • "merchant_id": "string",
}

Get all payouts

Returns a collection of payouts.

Request
query Parameters
start_date
string <date-time>

ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. For example 2020-01-23 -> 2020-01-23T00:00:00Z. For this reason we recommend too use the full datetime like 2020-01-23T00:00:00Z.

end_date
string <date-time>

ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. This might lead to unwanted side effects like when the start date and end date might be the same because it would request payouts between 2020-01-23T00:00:00Z and 2020-01-23T00:00:00Z. Instead we advise to use a full date time like 2020-01-23T23:59:59Z.

currency_code
string

An optional currency code to filter the result for different currencies. If not provided the result returned in the response might include multiple results grouped by the currency. The currency should be provided by an ISO 4217 Currency Code like USD, EUR, AUD or GBP.

size
integer <int64>
Default: 20

How many elements to include in the result. If no value for size is provided, a default of 20 will be used.

offset
integer <int64>
Default: 0

The current offset. Describes "where" in a collection the current starts.

Responses
200

A collection of payouts

400

Bad request

get/payouts
Request samples
curl -i -X GET \
  'https://api.klarna.com/settlements/v1/payouts?start_date=2019-08-24T14%3A15%3A22Z&end_date=2019-08-24T14%3A15%3A22Z&currency_code=string&size=20&offset=0'
Response samples
application/json
{}

transactions

Get transactions

Returns a collection of transactions.

Request
query Parameters
payment_reference
string

The reference id of the payout

order_id
string

The Klarna assigned order id reference

size
integer <int64>
Default: 20

How many elements to include in the result. If no value for size is provided, a default of 20 will be used.

offset
integer <int64>
Default: 0

The current offset. Describes "where" in a collection the current starts.

Responses
200

A collection of payouts

400

Bad request

get/transactions
Request samples
curl -i -X GET \
  'https://api.klarna.com/settlements/v1/transactions?payment_reference=string&order_id=string&size=20&offset=0'
Response samples
application/json
{
  • "transactions": [
    ],
  • "pagination": {}
}

reports

Get CSV payout report

More information about this CSV format is available at: https://developers.klarna.com/en/gb/kco-v3/settlement-files

Request
query Parameters
payment_reference
required
string

The reference id of the payout

Responses
200

A payout

400

Bad request

404

Not found

get/reports/payout-with-transactions
Request samples
curl -i -X GET \
  'https://api.klarna.com/settlements/v1/reports/payout-with-transactions?payment_reference=string'

Get CSV summary

More information about this CSV format is available at: https://developers.klarna.com/en/gb/kco-v3/settlement-files

Request
query Parameters
start_date
required
string <date-time>

ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. For example 2020-01-23 -> 2020-01-23T00:00:00Z. For this reason we recommend too use the full datetime like 2020-01-23T00:00:00Z.

end_date
required
string <date-time>

ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. This might lead to unwanted side effects like when the start date and end date might be the same because it would request payouts between 2020-01-23T00:00:00Z and 2020-01-23T00:00:00Z. Instead we advise to use a full date time like 2020-01-23T23:59:59Z.

Responses
200

A summary of payouts

400

Bad request

get/reports/payouts-summary-with-transactions
Request samples
curl -i -X GET \
  'https://api.klarna.com/settlements/v1/reports/payouts-summary-with-transactions?start_date=2019-08-24T14%3A15%3A22Z&end_date=2019-08-24T14%3A15%3A22Z'

Get PDF payout summary report

A single settlement summed up in pdf format

Request
query Parameters
payment_reference
required
string

The reference id of the payout

Responses
200

A payout

400

Bad request

404

Not found

get/reports/payout
Request samples
curl -i -X GET \
  'https://api.klarna.com/settlements/v1/reports/payout?payment_reference=string'

Get PDF summary

Returns a summary for all payouts between the given dates

Request
query Parameters
start_date
required
string <date-time>

ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. For example 2020-01-23 -> 2020-01-23T00:00:00Z. For this reason we recommend too use the full datetime like 2020-01-23T00:00:00Z.

end_date
required
string <date-time>

ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. This might lead to unwanted side effects like when the start date and end date might be the same because it would request payouts between 2020-01-23T00:00:00Z and 2020-01-23T00:00:00Z. Instead we advise to use a full date time like 2020-01-23T23:59:59Z.

Responses
200

A summary of payouts

400

Bad request

get/reports/payouts-summary
Request samples
curl -i -X GET \
  'https://api.klarna.com/settlements/v1/reports/payouts-summary?start_date=2019-08-24T14%3A15%3A22Z&end_date=2019-08-24T14%3A15%3A22Z'