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.

Payout summary

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
JavaScript
Node.js

Response samples

application/json

[{"summary_total_fee_correction_amount": 550,
"summary_payout_date_start": "2016-12-14T07:52:26Z",
"summary_total_release_amount": 550,
"summary_settlement_currency": "USD",
"summary_payout_date_end": "2016-12-14T07:52:26Z",
"summary_total_tax_amount": 550,
"summary_total_settlement_amount": 550,
"summary_total_holdback_amount": 550,
"summary_total_reversal_amount": 550,
"summary_total_return_amount": 550,
"summary_total_fee_amount": 500,
"summary_total_commission_amount": 550,
"summary_total_sale_amount": 500,
"summary_total_repay_amount": 550
}
]

Payout details

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
JavaScript
Node.js

Response samples

application/json

{"totals": {"commission_amount": 550,
"repay_amount": 550,
"sale_amount": 500,
"holdback_amount": 550,
"tax_amount": 550,
"settlement_amount": 550,
"fee_correction_amount": 550,
"reversal_amount": 550,
"release_amount": 550,
"return_amount": 550,
"fee_amount": 500,
"charge_amount": 500,
"credit_amount": 500,
"fee_refund_amount": 500,
"tax_refund_amount": 500,
"deposit_amount": 500,
"opening_debt_balance_amount": 500,
"closing_debt_balance_amount": 500
},
"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",
"transactions": "https://{settlements_api}/transactions?payment_reference=XISA93DJ"
}

List 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> <= 500 Default: 20 How many elements to include in the result. If no value for size is provided, a default of 20 will be used. A maximum of 500 can be set
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
JavaScript
Node.js

Response samples

application/json

{"payouts": [{"totals": {"commission_amount": 550,
"repay_amount": 550,
"sale_amount": 500,
"holdback_amount": 550,
"tax_amount": 550,
"settlement_amount": 550,
"fee_correction_amount": 550,
"reversal_amount": 550,
"release_amount": 550,
"return_amount": 550,
"fee_amount": 500,
"charge_amount": 500,
"credit_amount": 500,
"fee_refund_amount": 500,
"tax_refund_amount": 500,
"deposit_amount": 500,
"opening_debt_balance_amount": 500,
"closing_debt_balance_amount": 500
},
"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",
"transactions": "https://{settlements_api}/transactions?payment_reference=XISA93DJ"
}
],
"pagination": {"count": 10,
"total": 42,
"next": "http://example.com/collection?offset=21&size=10",
"prev": "http://example.com/collection?offset=0&size=10",
"offset": 10
}
}

Get a payouts summary (CSV)

More information about this CSV format is available at: https://docs.klarna.com/settlement-reports

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
JavaScript
Node.js

Get a payouts summary (PDF)

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
JavaScript
Node.js

List transactions in a payout

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> <= 500 Default: 20 How many elements to include in the result. If no value for size is provided, a default of 20 will be used. A maximum of 500 can be set.
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
JavaScript
Node.js

Response samples

application/json

{"transactions": [{"amount": 2000,
"capture_id": "33db6f16-9f43-43fa-a587-cc51411c98e4",
"merchant_reference1": "string",
"sale_date": "2016-12-14T07:52:26Z",
"type": "SALE",
"capture_date": "2016-12-14T07:52:26Z",
"payment_reference": "XISA93DJ",
"order_id": "ce17b4cb-147f-48b7-b8e6-dde2fa397f04",
"payout": "https://{settlements_api}/payouts/XISA93DJ",
"refund_id": "ef1baa1f-b42e-44be-b9e4-4b94510b53e5",
"short_order_id": "shortrid",
"merchant_reference2": "string",
"currency_code": "USD",
"purchase_country": "PL",
"vat_rate": 2000,
"vat_amount": 1000,
"shipping_country": "PL",
"initial_payment_method_type": "direct_debit",
"initial_number_of_installments": 3,
"initial_payment_method_monthly_downpayments": 12,
"merchant_capture_reference": "string",
"merchant_refund_reference": "string",
"detailed_type": "PURCHASE",
"tax_in_currency_of_registration_country": 1000,
"currency_code_of_registration_country": "EUR",
"klarna_comment": "Loan Amortisation 2022-12-01",
"reversal_reference": "krn:klarna:eu1:dispute:goods_not_received:263099944398666"
}
],
"pagination": {"count": 10,
"total": 42,
"next": "http://example.com/collection?offset=21&size=10",
"prev": "http://example.com/collection?offset=0&size=10",
"offset": 10
}
}

Get a payouts summary with transactions (CSV)

More information about this CSV format is available at: https://docs.klarna.com/settlement-reports

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
JavaScript
Node.js

Get a payouts summary with transactions (PDF)

Returns a summary for all payouts between the given dates

Request

query Parameters

start_date

required

string <date-time>

end_date

required

string <date-time>

Responses

200

A summary of payouts

400

Bad request

get/reports/payouts-summary

Request samples

curl
JavaScript
Node.js