Settlement report PayPal mapping
This integration is in beta
The Gr4vy settlement report for PayPal makes use of the PayPal settlement report.
This report is created every 24 hours.
Journal types are specified by the transaction event code (T-code) in PayPal in combination with
the movement of the funds, either being DR (debit) or CR (credit).
For example, the T-code T1201 with the movement DR is mapped to chargeback, while the same T-code with the movement CR is mapped to chargeback_reversal.
To configure settlement reporting, a PayPal SFTP needs to be set up on the PayPal side. Please follow the guidance on how to enable the SFTP. After the SFTP is enabled, the credentials of the SFTP need to be filled out in the PayPal connector configuration in our dashboard. To set up these credentials, please go to the “Connections” tab, select your PayPal connector and navigate to the “Settlement” tab. Here you can enable settlement reporting, after which you will be prompted to fill out your SFTP username and password.
Below is the mapping of PayPal’s settlement report to Gr4vy’s. This data is pulled from the PayPal Settlement Report.
| Gr4vy settlement report | Gr4vy field? | PayPal report |
|---|---|---|
payment_service_transaction_reconciliation_id | No | Custom Field |
transaction_id | Yes | - |
payment_service_transaction_id | No | Always null |
payment_service_id | Yes | - |
payment_service_definition_id | Yes | - |
payment_service_display_name | Yes | - |
journal_type | No | Check journal type mapping table below |
raw_journal_type | No | Transaction Event Code | Transaction Debit or Credit |
payment_service_transaction_created_at | No | Always null |
posted_at | No | Transaction Completion Date |
processing_amount_plain | No | Gross Transaction Amount (only for refund and settlement) |
processing_currency | No | Gross Transaction Currency (only for refund and settlement) |
exchange_rate | No | Always 1, unless settled in a different currency. In that case, it is calculated using Gross Transaction Amount presented in the two currencies |
currency | No | Gross Transaction Currency |
gross_credit_plain | No | Gross Transaction Amount * exchange_rate (only when Transaction Debit or Credit = 'CR') |
net_credit_plain | No | (Gross Transaction Amount - Fee Amount) * exchange_rate (only when Transaction Debit or Credit = 'CR') |
gross_debit_plain | No | Gross Transaction Amount * exchange_rate (only when Transaction Debit or Credit = 'DR') |
net_debit_plain | No | (Gross Transaction Amount + Fee Amount) * exchange_rate (only when Transaction Debit or Credit = 'DR') |
fee_markup_plain | No | Always null |
fee_interchange_plain | No | Always null |
fee_scheme_plain | No | Always null |
fee_total_plain | No | Fee Amount * exchange_rate |
method | No | Always 'paypal' |
raw_method | No | Always null |
scheme | No | Always null |
raw_scheme | No | Always null |
batch | No | Always null |
report_id | Yes | - |
raw_report_ids | Yes | - |
ingested_at | Yes | - |
description | No | Always null |
transaction_external_identifier | Yes | - |
transaction_metadata | Yes | - |
Notes:
- Transactions with different
currencyandprocessing_currencyvalues are presented as multiple rows in the PayPal report. They are merged into a single row in the Gr4vy settlement report, with applied currency conversion derived fromT0200records. Their respectiveraw_journal_typevalues will be appended to a singleraw_journal_typevalue in the merged row. - Non-customer facing journal types may have columns defaulting to
0or empty strings.
Journal type mapping:
| PayPal raw journal type | Gr4vy journal type |
|---|---|
T0000 | CR | settlement |
T0000 | DR | refund |
T0001 | CR | settlement |
T0001 | DR | refund |
T0002 | CR | settlement |
T0002 | DR | refund |
T0003 | CR | settlement |
T0003 | DR | refund |
T0004 | CR | settlement |
T0004 | DR | refund |
T0005 | CR | settlement |
T0005 | DR | refund |
T0006 | CR | settlement |
T0006 | DR | refund |
T0007 | CR | settlement |
T0007 | DR | refund |
T0008 | CR | settlement |
T0008 | DR | refund |
T0009 | CR | settlement |
T0009 | DR | refund |
T0010 | CR | settlement |
T0010 | DR | refund |
T0011 | CR | settlement |
T0011 | DR | refund |
T0012 | CR | settlement |
T0012 | DR | refund |
T0013 | CR | settlement |
T0013 | DR | refund |
T0014 | CR | settlement |
T0014 | DR | refund |
T0015 | CR | settlement |
T0015 | DR | refund |
T0016 | CR | settlement |
T0016 | DR | refund |
T0017 | CR | settlement |
T0017 | DR | refund |
T0018 | CR | settlement |
T0018 | DR | refund |
T0019 | CR | settlement |
T0019 | DR | refund |
T0020 | CR | settlement |
T0020 | DR | refund |
T0021 | CR | settlement |
T0021 | DR | refund |
T0022 | CR | settlement |
T0022 | DR | refund |
T1107 | CR | settlement |
T1107 | DR | refund |
T1112 | CR | settlement |
T1112 | DR | refund |
T1113 | CR | settlement |
T1113 | DR | refund |
T1115 | CR | settlement |
T1115 | DR | refund |
T1117 | CR | settlement |
T1117 | DR | refund |
T1201 | CR | chargeback_reversal |
T1201 | DR | chargeback |
T1202 | CR | chargeback_reversal |
T1202 | DR | chargeback |
T1600 | CR | settlement |
T1600 | DR | refund |
T1602 | CR | settlement |
T1603 | DR | refund |
T1800 | CR | settlement |
T1800 | DR | refund |
T2201 | CR | settlement |
T2201 | DR | refund |
| any other value | other |
Fields marked as Gr4vy field are populated from our internal data and not from the ingested payment service report.