Settlement report Adyen mapping

This integration is currently in beta and the exact mapping of fields might still change.

Configuration

Before enabling settlement reporting for an Adyen connector please follow the below steps. Some fields in the settlement report are not in the default Adyen settlement details report and need to be configured via the Adyen portal. The following fields need to be added: Booking date, Booking Date TimeZone and metadata. To add the columns to the Adyen report follow the documentation here. Please follow the below column configuration.

Company Account
Merchant Account
Psp Reference
Merchant Reference
Payment Method
Creation Date
TimeZone
Type
Modification Reference
Gross Currency
Gross Debit (GC)
Gross Credit (GC)
Exchange Rate
Net Currency
Net Debit (NC)
Net Credit (NC)
Commission (NC)
Markup (NC)
Scheme Fees (NC)
Interchange (NC)
Payment Method Variant
Modification Merchant Reference
Batch Number
Reserved4
Reserved5
Reserved6
Reserved7
Reserved8
Reserved9
Reserved10
Booking Date
Booking Date TimeZone
Metadata

It’s important to set up the columns in order and these are the minimum columns needed. If more columns are desired, these should be placed after the last column mentioned here.

Once that is set up, a report user needs to be created. The report user is created via the Adyen developers dashboard, please follow the documentation here. The report user follows a naming convention like report_123456@Company.Gr4vyInc. Please fill out the whole name, not just the report_123456 part, and provide the basic auth password in the dashboard. It is important to use the Basic Auth key pair when configuring the report user in the dashboard, and not the API key. This needs to be filled out in the settlement tab in the connector configuration page.

Enabling the report available webhook

Report ingestion is triggered by Adyen’s REPORT_AVAILABLE webhook: each time Adyen creates a report, it notifies Gr4vy, which then fetches and ingests the corresponding settlement details report. Enable this webhook in the Adyen Customer Area:

In the Gr4vy dashboard, go to Connections, select your Adyen connection, open the Synchronization tab and copy the webhook URL. This is the same endpoint used for your Adyen transaction webhooks.
In the Adyen Customer Area, go to Developers -> Webhooks.
Select Create new webhook, or edit the existing endpoint that already points to Gr4vy.
In the Server configuration -> URL field, paste the Gr4vy webhook URL. Ensure that the method selected is JSON.
Under Events, toggle the REPORT_AVAILABLE event on.
Select Save configuration to save your changes.

Fields mapping

Below is the mapping of Adyen’s settlement report to the consolidated settlement report. This data is pulled from the Adyen settlement_detail_report report.

Settlement report	Adyen field?	Adyen report
`payment_service_transaction_reconciliation_id`	Yes	`Merchant Reference` or `Metadata[orchestrator_tx_sid]`
`transaction_id`	No	-
`payment_service_transaction_id`	Yes	`Psp Reference`
`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	`Type`
`payment_service_transaction_created_at`	Yes	`Creation Date` if `Settled` `Type` with `Time Zone` UTC offset applied
`posted_at`	Yes	`Booking Date`, with `Booking Date Time Zone` UTC offset applied
`processing_amount_plain`	Yes	`Gross Credit (GC)` if `Settled` `Type`, `Gross Debit (GC)` if `Refunded` or `SettledReversed` `Type`
`processing_currency`	Yes	`Gross Currency`
`exchange_rate`	Yes	`Exchange Rate`
`currency`	Yes	`Net Currency`
`gross_credit_plain`	Yes	`Gross Credit (GC) * Exchange Rate` or `Net Credit (NC)` for non-customer facing journal types
`net_credit_plain`	Yes	`Net Credit (NC)`
`gross_debit_plain`	Yes	`Gross Debit (GC) * Exchange Rate` or `Net Debit (NC)` for non-customer facing journal types
`net_debit_plain`	Yes	`Net Debit (NC)`
`fee_markup_plain`	Yes	`Markup (NC)`
`fee_interchange_plain`	Yes	`Interchange (NC)`
`fee_scheme_plain`	Yes	`Scheme Fees (NC)`
`fee_total_plain`	Yes	`Commission (NC)` or `Gross Credit (GC) * Exchange Rate - Net Credit (NC)` if `Settled` `Type` or `Net Debit (NC) - Gross Debit (GC) * Exchange Rate` if `Refunded` or `SettledReversed` `Type`
`method`	Yes	Calculated from `Payment Method` or `Payment Method Variant`
`raw_method`	Yes	`Payment Method` or `Payment Method Variant` depending on which was used to calculate `method`
`scheme`	Yes	Calculated from `Payment Method` or `Payment Method Variant`
`raw_scheme`	Yes	`Payment Method` or `Payment Method Variant` depending on which was used to calculate `scheme`
`batch`	Yes	`Batch Number`
`report_id`	No	-
`raw_report_ids`	No	-
`ingested_at`	No	-
`description`	Yes	Contains raw `Time Zone` and `Booking Date Time Zone` values
`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_modification_reference`	Yes	`Modification Reference`
`payment_service_refund_reconciliation_id`	Yes	`Modification Merchant Reference` if `Refunded` `Type`
`refund_external_identifier`	No	-

Notes

payment_service_transaction_created_at and posted_at have been converted to UTC using Time Zone and Booking Date Time Zone respectively, which are time zone abbreviations. As these time zone abbreviations can be ambiguous, the applied UTC offset to these timestamp columns may not be accurate. Please refer to the description for the raw values used.
Non-customer facing journal types may have columns defaulting to 0 or empty strings.

Journal type mapping

Adyen raw journal type	Journal type
`Chargeback`	`chargeback`
`ChargebackReversed`	`chargeback_reversal`
`Refunded`	`refund`
`RefundedInstallment`	`refund`
`SecondChargeback`	`chargeback`
`Settled`	`settlement`
`SettledInstallment`	`settlement`
`SettledReversed`	`settlement_reversal`
any other value	`other`

Fields marked as not being an Adyen field are populated from internal data and not from the imported payment service report.

Overview

Integrations

Insights

Monitoring & Alerting

Flow

Roles & Permissions

Reports

Settlement reports

SSO

Settlement report Adyen mapping

Configuration

Enabling the report available webhook

Fields mapping

Notes

Journal type mapping

​Configuration

​Enabling the report available webhook

​Fields mapping

​Notes

​Journal type mapping

Configuration

Enabling the report available webhook

Fields mapping

Notes

Journal type mapping