Skip to main content

Configure settlement reports

This article explains how settlement reports are configured.

Updated over 2 weeks ago

The Configure button in the Kustom Portal lets you customize settlement reports by adding or removing specific information. Different configurations can be created for stores and based the preferred delivery method: download from Kustom portal, API or SFTP.


Which Settlement reports can be configured in the Kustom Portal?

  • Only Settlement Reports in .csv format are configurable.

  • Configuration changes apply to both existing and future Settlement Reports.

  • Configurations can be updated at any time.

Please note: the FTP option used to configure the settlement report (also referred to as SFTP), is only available for merchants that have been migrated from Klarna to Kustom. If your Merchant ID (MID, Store ID) begins with an M, it was NOT part of the migration and therefore cannot use FTP. This is a known limitation, and we are actively working on a solution.


How to configure settlement reports

The configuration options for your settlement reports can be found in the Kustom Portal under the Settlements tab.

  • Open the Kustom portal and sign in.

  • Navigate to Settlements from the menu on the left.

  • Click Configure ⚙️ on the far right.

  • Choose the MID (Merchant-ID) and Channel:

    • To edit the Summary and Transaction sections, open their respective dropdown menus.

    • Channel API updates configurations for reports downloaded in the portal and sent via API.

    • Channel FTP updates configurations for reports sent via SFTP.

  • Check the boxes for the details you want to include and uncheck those you wish to remove.

  • You can also change the names of the fields

  • Click Save Config to apply your changes.


Fields descriptions for the Configurator

Settlement summary fields

FIELD

DESCRIPTION

total_sale_amount

Total of all “sale” events. These are all captured orders that have been shipped to the customers.

total_fee_amount

Total of all “fee” events. These are service fees charged by Kustom for sale transactions. and disputes fees.

total_fee_correction_amount

Total of refunded fees that were credited back to you.

total_tax_amount

Total tax (VAT, GST) amount on Kustom fees and dispute fees. Reflects the total of all vat_amount values per transactions.

total_return_amount

Total of all “return” events. These are refund transaction, registered by the merchant and indicating that the goods/services have been returned by the customer.

total_reversal_amount

Total value of open disputes.

total_credit_amount

Total sum of all transactions credited back to you.

total_charge_amount

Total sum of miscellaneous charges.

total_holdback_amount

The amount is used as a (rolling) reserve to cover future refunds or charges.

total_release_amount

Total amount of previously held funds that have now been released to you

opening_debt_balance

Your negative balance with Kustom from previous settlement(s), if your returns, fees, and other charges exceeded your sales. This amount equals the closing_debt_balance of your last settlement unless Kustom has invoiced you separately for the amount.

total_deposit_amount

Increase of your debt balance with Kustom if your returns, fees, and other charges exceed your sales within this settlement period.

total_repay_amount

Assuming you have an opening_debt_balance with Kustom because your previous settlement was negative, this amount states the reduction of your debt balance, to be seen in a lower closing_debt_balance. The amount is deducted from your current settlement.

closing_debt_balance

Your debt balance after the settlement. This amount will be the opening debt balance of your next settlement and helps you understand which amounts will be deducted from your next settlements. The amount is calculated as: opening_debt_balance - total_repay_amount + total_deposit_amount

total_fee_refund_amount

Total sum of fees credited back to you because you were incorrectly charged or won a dispute.

total_settlement_amount

Total amount of this payout (sales + release - fees - tax - returns - holdback - reversals - repay = total_settlement_amount)

payment_reference

Unique identifier of this payout, which is stated in the transfer note in your bank statement

settlement_currency

Settlement Currency. We settle you like for like in your transacting currency.
Example EUR, SEK, GBP

payout_date

Indicates when Kustom initiated the payout, Central European Time.

merchant_id

Unique Merchant Identification NumberExample:"K123456" or M100000

merchant_settlement_type

Settlement type:
NET
Kustom service fees are deducted from the payout.
GROSS
Kustom service fees are invoiced separately.

Transaction List

Field

Type

Description

type

String

Type of this event:
SALE
(+) captured order that has been shipped to the customer.
FEE
(-) Service fee charged by Kustom for the related sale transaction. You may have multiple fee transactions applied to one sale transaction, eg. fixed fees and percentage fees.
RETURN
(-) refund transaction, registered by the merchant and indicating that the goods/services have been returned by the customer.
REVERSAL
(-) refund transaction, registered by Kustom for Open dispute. This contains fraudulent cases seen as merchant loss eg. due to missing tracking data.
REVERSAL_MERCHANT_PROTECTION
(+) net-amount of the order value (without tax), credited by Kustom to the merchant due to Kustom’s merchant protection eg. in case of fraud. The amount is reducing the total_reversal_amount.
CORRECTION
(+/-) Certain corrections that are booked against specific orders according to a mutual agreement between the merchant and Kustom.
HOLDBACK
(-) The amount is used as a rolling reserve, which covers for future refunds or other security reasons.
RELEASE
(+) The amount reduces the rolling reserve (the opposite of a holdback). The credit that Kustom had set apart for a merchant, gets released and paid back to the merchant.
CREDIT
(+) Miscellaneous credit towards you, which is described in the field detailed_type.
CHARGE
(-) Miscellaneous charge towards you, which is described in the field detailed_type.
FEE_REFUND
(+) Credit entries in the settlement report where Kustom has identified that the fee was incorrectly charged.

capture_date

ISO 8601

Date when the event was registered in Kustom’s system. In case of a SALE transaction it refers to the moment when you shipped the goods to the customer and captured/activated the order.
Example:2024-10-10T07:45:00Z

Times are shown in UTC.

sale_date

ISO 8601

Date of the order creation.
Example:2024-10-10T07:45:00Z

Times are shown in UTC.

order_id

UUID

Unique identifier of the order. All related transactions in the life-span of an order are associated with this ID. eg. fees or refunds. It is therefore the recommended identifier for reconciling the report lines with your system.
Example: c504a9bb-1948-46d5

capture_id

String

Each capture on an order is assigned a unique identifier, referred to as the capture_ID. In instances of partial shipments, an order may undergo multiple captures, each of which is reflected as a separate sale transaction with its own unique capture_id.

It's important to note that for certain transaction types such as RETURNS and REVERSALS, where captures do not exist, the API will return empty strings for the capture_id field.
Example:8e93b66-6ab1-4d3d-b60d-1cc4e24f4a99

merchant_reference1

String

Your internal reference to the order, that has been submitted during order creation.

merchant_reference2

String

Your internal reference to the order, that has been submitted during order creation.

amount

Decimal

Amount of the related transaction.
Example:100.00

posting_currency

ISO 4217

Currency in which the order has been placed.

refund_id

String

Unique identifier for Return and Reversal transactions. In case of partial returns, each return transaction is associated with a unique refund_ID.

Example:8e93b66-6ab1-4d3d-b60d-1cc4e24f4a99

purchase_country

ISO 3166-alpha-2

Purchase country, as provided by the merchant.

tax_rate

Decimal

VAT (Value added tax in Europe) or GST (goods and services tax in Australia) rate on Kustom fees.

tax_amount

Decimal

VAT (Value added tax in Europe) or GST (goods and services tax in Australia) amount on Kustom fees.

shipping_country

ISO 3166-alpha-2

As provided by you.

initial_payment_method_type

String

Payment method the consumer chose during checkout.

merchant_capture_reference

String

Your internal reference to the capture, that has been submitted during capturing an order via API.

merchant_refund_reference

String

Your internal reference to the refund, that has been submitted during refunding an order via API.

detailed_type

String

Detailed description of the transaction type. See section “Detailed type” for further information.

tax_rate_1-4

String

Consumer VAT (value added tax) rates on your products/services. The rate needs to be submitted by you for every order-line when capturing or refunding an order, because an order can consist of items with different VAT rates

tax_amount_1-4

Decimal

Consumer VAT (value added tax) amounts on your products/services. The amount needs to be submitted by you for every order-line when capturing or refunding an order, because an order can consist of items with different VAT rates.

Detailed type

Transaction type

Detailed type

Description

CHARGE

TRANSFER_FROM_

LEGACY_INTEGRATION

Transfer of debt from the Klarna portal. This is used to settle negative balance instead of issuing an invoice.

CORRECTION

CREDITED_CORRECTION

Manual corrections

CREDIT

CORRECTION_DISPUTE

Credit entries in the settlement report where Kustom has identified that the customer refund was incorrectly charged.

FEE

PURCHASE_FEE_FIXED

Fixed Fee on captured order

FEE

PURCHASE_FEE_

PERCENTAGE

Percentage Fee on captured order

FEE

DISPUTE_FEE

Dispute fee on an Open dispute

FEE_REFUND

DISPUTE_FEE_REFUND

Fee refund when a dispute was won by the merchant.

HOLDBACK/RELEASE

ROLLING_RESERVE

Security measure that works well for both you as a merchant and Kustom since we do not hold funds or delay payment of funds, but rather hold only a portion of it as collateral, which will automatically be released after the time agreed upon.

HOLDBACK/RELEASE

UNDER_REVIEW

Security measure that will allow Kustom to place a hold on payouts either in part of full while we review the financial holding of a merchant and the underlying transactions

RETURN

PURCHASE_RETURN

Refund, registered by the merchant and indicating that the goods/services have been returned by the customer.

REVERSAL

COMMISSION_RETURN

Return of commission

REVERSAL

REVERSAL

The value of an open dispute.

SALE

PURCHASE

Captured order

Did this answer your question?