The Report configurator in the Kustom Portal lets you choose which information your CSV reports include. Each store has its own configuration, and you can create separate configurations depending on how you receive your reports: downloaded from the Kustom Portal, via API or via SFTP.
You can also apply the configuration to Transaction reports, so that your settlement reports and transaction reports share the same columns.
Which reports can be configured?
Only reports in CSV format are configurable.
Settlement reports always follow the configuration. Transaction reports follow it when Use for transaction report is enabled.
Configuration changes apply to reports generated after you save.
Configurations can be updated at any time.
How to configure your reports
The Report configurator 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 the gearwheel ⚙️ in the top right corner to open the Report configurator.
Choose the store and the Channel. Channel API applies to reports downloaded in the Kustom Portal and reports sent via API. Channel FTP applies to reports sent via SFTP.
Under Report preferences and Report layout, select the settings you want. Each setting is explained further down in this article.
Under Edit columns, open the Settlement summary and Transaction list dropdowns and select the fields you want to include. You need to choose at least one field in each section. You can also change the names of the fields.
Click Save to apply your changes.
Apply one configuration to all your stores
If you select All stores or several stores, the configurator shows the default configuration. When you click Save, the configuration is applied to every selected store.
Use this if reports from your stores look different or if some stores are missing fields. Each store keeps its own configuration until you save a shared one.
An explanation of settings
Report preferences and layout
Report preferences and layout
These settings control the format of your whole report file. The table below explains each setting in the Report configurator:
SETTING | DESCRIPTION |
Use for transaction report | When enabled, this configuration is applied to transaction reports in addition to settlement reports. |
Use negative signs | When enabled, amounts for debit-type transactions (such as fees and returns) are displayed with a negative sign instead of as positive values. |
Include consumer VAT | When enabled, consumer VAT fields (tax_rate_1-4 and tax_amount_1-4) are included in the report output. |
Exclude zero amount transactions | When enabled, transactions with an amount of zero are left out of the report. |
Delimiter | The character used to separate fields in the CSV file. Default: Comma (,). |
Quotation character | The character used to wrap field values in the CSV file. |
Date format | The format used for all date fields in the report. |
Amount format | The format used for numeric amount values. Default: 12,345.67 (comma as thousands separator, period as decimal separator). |
Show column headings | When enabled, the report includes a row with the name of each column. |
Include settlement summary section | When enabled, the report starts with the settlement summary rows, followed by the transaction list. |
Settlement summary fields
Settlement summary fields
The summary section of a settlement report shows the totals for one payout. The table below explains each settlement summary field you can include in the report:
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 dispute 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. |
payout_date | Indicates when Kustom initiated the payout, Central European Time. |
merchant_id | Unique Merchant Identification Number. Example: "K123456" or M100000 |
merchant_settlement_type | Settlement type: |
Transaction List
Transaction List
The transaction list of a settlement report shows one row per transaction included in the payout. The table below explains each transaction list field, its data type and what it contains:
Field | Type | Description |
type | String | Type of this event: |
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. Times are shown in UTC. |
sale_date | ISO 8601 | Date of the order creation. 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. |
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. |
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. |
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. |
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. |
payment_provider | String | The payment provider that processed and settled the transaction, for example KUSTOM or RESURS. Useful when your payouts come from more than one provider and you need to reconcile them separately. Shown as "Payment provider" in the configurator. |
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
Detailed type
The detailed_type field gives a more specific reason for each transaction in the settlement report. The table below lists each transaction type, its possible detailed types and what they mean:
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 |