Unified Settlement Report
The Unified Settlement Report is a comma separated file format (CSV). that maps multiple settlement reports from external processors (e.g. PayPal, Concardis, SEPA, ...) into one unified format for all payment methods and processors. This simplifies the reconciliation processes for merchants as they only have to handle one file format.
There will be separate Unified Settlement Report files on a processor level to ensure that merchants can directly start the reconciliation process, rather than waiting a full day until all settlement files from the various processors are collected and can be reported within one file.
The files will be generated on a daily base in case the processor offers a daily settlement reporting.
We distinguish between alphanumeric (AN) and numeric (N) parameters within the Unified Settlement Report.
|AN - Currency||ISO 4217 - A3 currency code||EUR|
|AN - Rest||Alphanumeric values comming from the Payengine will follow the format restrictions defined by the Payengine API. Alphanumeric values received from the processors will just be forwarded as they are.|
|N - Amounts||Amount parameters will use the . as a decimal separator and can include as much decimal places as supported by the currency and provided by the processor. There is no separate credit/debit sign, negative settlement amounts will include a -||-10.25N|
|N - Dates||Date parameter will follow the format DDMMYYYY||15012019|
Even if there is a predefined Unified Settlement Report format the content of the file may differ based on the payment method or processor.
This means that not all transaction types will be supported for all methods/processors but also that not all parameters will always be populated.
Specific instructions and mappings can be found in the corresponding subsections for the methods/processors including some samples.
Settlement Details Record
Field 1 - 8
|Field No||Field Name||Description||Type||Sample|
|1||Record Type||The record type, hardcoded to 'sett_dtl' for settlement details||AN||sett_dtl|
|2||Merchant Id||The Payengine merchantId||AN||Merchant-000cf2c9-66fe-4730-ac9e|
|3||Source File Id||Payengine identifier of source settlement file||AN||jgrwsntrjt|
|4||Payment Method||The payment method, e.g. card, paypal, sepa||AN||paypal|
|5||Payment Brand||The payment brand, e.g. visa, mastercard||AN||paypal|
|6||Order Id||The Payengine orderId||AN||auap9iftmn|
|7||Transaction Id||The Payengine transactionId||AN||transaction_jgrwsntrjt|
|8||Merchant Reference||The Payengine merchantOrderId provided by the merchant||AN||1234567890|
Field Name: Type Type: AN Sample: settlement
|Type (Field Name: type)||Description|
|settlement||successfully settled captures and debits|
|reject||technically rejected capture, debit or refund request by the acquirer, rejects do not have any impact on the payout|
|refund||successfully settled refunds|
|dispute||disputed settlements, can have positive or negative impact on balance depending if they are hold or released|
|chargeback||chargeback information in case of fraudulant transactions|
|chargeback_reversal||a reversal of a chargeback|
|adjustment||adjustments on the merchant account|
|fee||separate fees that cannot be associated directly to any other transaction type|
|vat||separate VAT or tax that cannot be associated directly to any other transaction type|
Field 10 - 31
|10||Transaction Date||Original transaction date of the capture/debit transaction, format DDMMYYYY||N||20082018|
|11||Transaction Currency||Original transaction currency of the capture/debit transaction (ISO 4217)||AN||GBP|
|12||Transaction Amount||Original transaction amount of the capture/debit transaction, including sign, decimal places will be split by ., e.g. 15.99||N||180.00|
|13||Settlement Date||Date when funds are settled to the merchant account, format DDMMYYYY. For methods where an acquirer is involved the settlement date doesn't necessarily has to be the actual payment date||N||23082018|
|14||Settlement Currency||Currency of the settlement (ISO 4217)||AN||EUR|
|15||Settlement Gross Amount||Gross amount in settlement currency||N||200.00|
|16||Settlement Net Amount||Net amount in settlement currency||N||198.12|
|17||Settlement Fx Rate||Exchange rate in case transaction and settlement currency differ||N||0.9|
|18||Commission||The commission fee that was withheld by the acquirer/processor. Cards: If the acquirer provides the transaction information at interchange level we the fee details will be available in the separate fields for: Aqcuirer Service Fee, Scheme Fees, Interchange||N||-1.88|