Settlement report Nuvei mapping
This integration is in beta
movement report.
This report is ingested on a daily basis and allows for full end to end reconciliation between your bank account and Nuvei’s payables.
The report contains transaction level settlement information including fees, chargebacks and refunds.
Nuvei reports on all movements of funds, also settlements that have occurred externally from the Nuvei platform.
Since we’re ingesting settlement data that pertain to movements of funds in the Nuvei platform we are filtering out line items where the settlement amount : 0.
We will ingest all journal types from the movement report which by Nuvei standards are notated by the movement type and movement details.
In our report we concatenate these two columns in the raw_journal_type column.
Transactions with our journal_type: settled will be taken from the Nuvei raw_journal_type: sale-sale.
In the Nuvei movement report the fees are deducted from the processing amount in the processing currency.
In our report however we provide the fees in the settlement currency. Therefore we have modified the fees in our report as fee * conversion rate.
Nuvei’s movement report needs to be scheduled via their dashboard for us to be
able to ingest. Please follow their Back Office Operations - Reports
guidelines on how to set up a new schedule for the Movement Report. Make sure
to set the delivery type to SFTP. For us to be able to ingest the report
please set the following naming convention:
settlement-report-YYYY-MM-DD.csv.| Settlement report | Nuvei field? | Nuvei report |
|---|---|---|
payment_service_transaction_reconciliation_id | Yes | Client Unique ID |
transaction_id | No | - |
payment_service_transaction_id | Yes | Transaction ID (for settlement only) |
payment_service_id | No | - |
payment_service_definition_id | No | - |
payment_service_display_name | No | - |
journal_type | Yes | Check journal type mapping table below |
raw_journal_type | Yes | Movement Type | Movement Details |
payment_service_transaction_created_at | Yes | Always null |
posted_at | Yes | Movement Date |
processing_amount_plain | Yes | End User Amount |
processing_currency | Yes | End User Currency |
exchange_rate | Yes | (Amount / End User Amount) * Conversion Rate (only for refund and settlement) |
currency | Yes | Settlement Currency |
gross_credit_plain | Yes | ABS(Amount) * Conversion Rate if Settlement Amount > 0 else 0 |
net_credit_plain | Yes | ABS(Settlement Amount) if Settlement Amount > 0 else 0 |
gross_debit_plain | Yes | ABS(Amount) * Conversion Rate if Settlement Amount < 0 else 0 |
net_debit_plain | Yes | ABS(Settlement Amount) if Settlement Amount < 0 else 0 |
fee_markup_plain | Yes | ABS(Plus Commission) * Conversion Rate |
fee_interchange_plain | Yes | ABS(Interchange Fee) * Conversion Rate |
fee_scheme_plain | Yes | ABS(Scheme Fee) * Conversion Rate |
fee_total_plain | Yes | ABS(Amount - Net Amount) * Conversion Rate |
method | Yes | Standardized value of raw_method |
raw_method | Yes | Payment Method |
scheme | Yes | Standardized value of raw_scheme |
raw_scheme | Yes | null if Card Type IS NULL else Payment Method |
batch | Yes | Batch ID |
report_id | No | - |
raw_report_ids | No | - |
ingested_at | No | - |
description | Yes | Always null |
transaction_external_identifier | No | - |
transaction_metadata | No | - |
report_payment_service_id | No | - |
report_payment_service_definition_id | No | - |
report_payment_service_display_name | No | - |
payment_service_transaction_created_atis set tonullsince, unfortunately, no creation date of the transaction is given, only theposted_atdate is available. It’s therefore not possible to see from our report on which date the original transaction took place on the Nuvei platform.ABS()means absolute value transformation is applied to the original value
| Nuvei raw journal type | Journal type |
|---|---|
Cancelled CB | Recalled Chargeback | chargeback_reversal |
Chargeback | Chargeback Regular | chargeback |
Credits | Credit | refund |
Sales | Sale | settlement |
| any other value | other |
Fields marked as not a Nuvei field are populated from our internal data
and not from the ingested payment service report.