Payouts Reconciliation Report
Last updated: Nov 4th, 10:59am
This report provides a detailed view of the activity on your platform and helps with reconciliation of end-to-end money flow and transactions.
Download a sample report
To review what's available in this report, download a sample in CSV format. This sample may vary from your actual report, depending on your settings.
Know before you begin
- Ensure you are an approved partner to use this report.
- This report is generated and placed on SFTP by 9:00 AM daily in the leading time zone of the reporting window.
- This report includes alternative payment methods (APMs). See the list of supported APMs.
- The actual amounts in this report are multiplied by 100 to represent the amounts as cents. For instance, a $10 entry shows up as 1000 on the report.
- Read the report data by column header name instead of column index to maintain backward compatibility.
Report file name
The file name of the Payouts Reconciliation Report for a single account follows this naming convention:
PYT.yyyymmdd.ReportIdentifier.ReportingWindow.SequenceNumber.MajorVersion.MinorVersion.Format
Field | Information |
---|---|
PYT |
An abbreviation for Payouts Reconciliation report. |
yyyymmdd |
The date for the data in the report. It represents the latest, or ending date, of the data. |
ReportIdentifier |
This is the unique value to identify the report, such as the BN code or organization name. |
ReportingWindow |
The window of time when the report was generated. |
SequenceNumber |
The sequence number of the report file. The sequence number begins with
0 and continues until all parts of the report are recorded
in files. The sequence number is always present in the report filename
even if there is only one file.
|
MajorVersion |
The major version of the report. |
MinorVersion |
The minor version of the report. |
format |
The report format is CSV (comma-separated values). |
Report format
Each row of the report consists of a two-letter row type, followed by the details specific to that row type. The following table lists the valid row types and the sections that describe the data for that row type.
Code | Description |
---|---|
FH | File header |
SH | Section header |
CH | Column header |
SB | Section body |
SF | Section footer |
FF | File footer |
File header data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
The column type (FH ). |
2 | Report Generation Date | Date-time |
The date and time when the report file was generated, in the following
format: YYYY/MM/DDHH:MM:SS offset , where
offset is the five-character signed offset from GMT, such
as +0800 .
|
3 | Reporting Window |
One of the following varchar single characters:
A , H , R , X .
|
The window of time when the report was generated, as follows:
|
4 | Report Period Start Date | Date-time |
The beginning date and time of transactions to include in the report, in
the following format: YYYY/MM/DDHH:MM:SS offset , where
offset is the five-character signed offset from GMT, such
as +0800 .
|
5 | Report Period End Date | Date-time |
The final date and time of transactions to include in the report, in the
following format: YYYY/MM/DDHH:MM:SS offset , where
offset is the five-character signed offset from GMT, such
as +0800 .
|
6 | Partner Account Number | Varchar |
The partner's PayPal encrypted account number. |
7 | ReportIdentifier | Varchar |
This unique value identifies the report, such as the BN code or organization name. |
Section header data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
SH |
Section body data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
The column type (CH ). |
2 | TRANSACTION_TYPE | Varchar |
One of the following types of transaction:
|
3 | TRANSACTION_SUBTYPE | Varchar |
One of the following subtypes of transaction:
|
4 | SELLER_ACCOUNT_ID | Varchar |
The seller's encrypted PayPal account number. |
5 | PAYPAL_REFERENCE_ID | String |
The original PayPal transaction ID this event is related to. |
6 | PAYPAL_TRANSACTION _ID |
Varchar |
The PayPal transaction ID. |
7 | INVOICE_ID | Varchar |
The invoice ID of the transaction. |
8 | CUSTOM_FIELD | Varchar |
A field for custom data. |
9 | TRANSACTION_DATE | Date-time |
The date and time the transaction was initiated, in the following
format:
YYYY/MM/DD HH:MM:SS offset . YYYY is the
four-digit year.MM is two-digit month of the year.DD
is the two-digit day of the month. HH is the hour in
24-hour notation. MM is minutes. SS is
seconds. offset is the five-character signed offset from
GMT, such as +0800 .
|
10 | INTEGRATION_IDENTIFIER | Varchar |
The partner's button source code. |
11 | PAYMENT_INSTRUMENT _TYPE |
Varchar |
A high-level classification of the type of financial instrument that was
used to fund a payment, such as the following:
|
12 | PAYMENT_INSTRUMENT_ SUBTYPE |
Varchar |
One of the following detailed classifications of the financial
instrument used to fund a payment:
For example:
|
13 | CHECKOUT_CHANNEL | Varchar |
Used to distinguish online and offline payments.
|
14 | DELAYED_ DISBURSEMENT |
One-character flag |
The following codes indicate the disbursement type:
|
15 | TRANSACTION_AMOUNT | Money |
The amount of the transaction. |
16 | TRANSACTION_CURRENCY | Three-character currency code | The currency of the transaction. |
17 | TRANSACTION_DEBIT_ CREDIT_CODE |
Varchar |
The following codes indicate whether the money was credited or debited:
|
18 | PENDING_DISBURSEMENT_ AMOUNT |
Money |
The amount yet to be disbursed. |
19 | PENDING_DISBURSEMENT_ AMOUNT_CURRENCY |
Three-character currency code | The currency of the amount yet to be disbursed. |
20 | SELLER_AMOUNT | Money |
The amount of funds transferred to or from a customer. Funds moving out of the seller account have a dash (-) prefix. |
21 | SELLER_AMOUNT _CURRENCY |
Three-character currency code | The currency of the seller amount. |
22 | PARTNER_FEE | Money |
Partner fees associated with the transaction. Funds moving
out of the partner fee account have a dash (- )
prefix.
|
23 | PARTNER_FEE_CURRENCY | Three-character currency code | The currency of the partner fee. |
24 | PARTNER_FEE_ ACCOUNT_ID |
Varchar |
The partner fee encrypted account number in PayPal. |
25 | PP_FEES | Money |
Any PayPal fees associated with the transaction. Funds moving
out of the PayPal fee account have a dash (- )
prefix.
|
26 | PP_FEES_CURRENCY | Three-character currency code | The currency of the PayPal fee. |
27 | PP_FEES_PERCENTAGE | varchar |
The percentage of the transaction amount charged as fee. Total PayPal
fees include PP_FEES_PERCENTAGE and
PP_FEES_FIXED_AMOUNT .
|
28 | PP_FEES_FIXED_AMOUNT | Money |
The fixed PayPal fee amount component of PP_FEES . |
29 | PP_FEES_XB _PERCENTAGE |
varchar |
The percentage of the transaction amount charged as cross-border fees.
Total cross-border fees include PP_FEES_XB_PERCENTAGE and
PP_FEES_XB_FIXED_AMOUNT .
|
30 | PP_FEES_XB _FIXED_AMOUNT |
Money |
The fixed cross-border fee amount component of
PP_FEES_XB_TOTAL_AMOUNT .
|
31 | PP_FEES_XB_ TOTAL_AMOUNT |
Money |
Total cross-border fee amount associated with the transaction. Total
cross-border fees include PP_FEES_XB_PERCENTAGE and
PP_FEES_XB_FIXED_AMOUNT .
|
32 | CHARGEBACK_FEE | Money |
The chargeback fee associated with the transaction. A dash
(- ) prefix indicates the chargeback fee is reversed.
|
33 | CHARGEBACK_FEE_ CURRENCY |
Three-character currency code | The currency of the CHARGEBACK_FEE . |
34 | HOLD_AMOUNT | Money |
The amount put on hold or released from hold. A dash (- )
prefix indicates the funds that were put on hold are being released.
|
35 | HOLD_AMOUNT_ CURRENCY |
Three-character currency code | The currency of the HOLD_AMOUNT . |
36 | RECOUP_AMOUNT | Money |
The amount recouped from the recoup account. Funds moving out of the
recoup account have a dash (- ) prefix.
|
37 | RECOUP_AMOUNT _CURRENCY |
Three-character currency code | The currency of the RECOUP_AMOUNT . |
38 | RECOUP_ACCOUNT_ID | Varchar |
The encrypted PayPal account number of the recoup account. |
39 | PAYABLE_AMOUNT | Money |
The amount moving in and out of the partner's payable general ledger
account. Funds moving out of the payable account have a dash
(- ) prefix.
|
40 | PAYABLE_AMOUNT _CURRENCY |
Three-character currency code | The currency of the PAYABLE_AMOUNT . |
41 | PAYABLE_ACCOUNT_ID | Varchar |
The encrypted PayPal account number of the partner's payable general ledger. |
42 | EXTERNAL_TRANSFER _AMOUNT |
Money |
The amount credited to or debited from an external entity, such as a
bank. Funds debited from an external entity have a dash (- )
prefix.
|
43 | EXTERNAL_TRANSFER_ AMOUNT_CURRENCY |
Three-character currency code | The currency of the EXTERNAL_TRANSFER_AMOUNT . |
44 | COUNTERPARTY_ACCOUNT _ID |
Varchar |
The encrypted PayPal account number of the counter party involved in a transaction. |
45 | SETTLEMENT_REFERENCE _ID |
Varchar |
The bank reference ID for the bank transfer transaction. |
46 | STORE_ID | Varchar |
ID of the store where point of sale happened. |
47 | TRANSACTION_STATUS | Varchar |
The current status of the PAYMENT transaction. This status
can be one of the following:
|
48 | DECLINE_CODE | Varchar |
This code indicates the reason of decline, when available. For credit card transactions, the code is a processor decline code. For bank transactions, the code is a bank decline code. For more information, see processor decline codes. |
49 | PAYOUT_REFERENCE_ID | Varchar |
Indicates transaction ID of the counterparty for a payout transaction. |
50 | BASE_FX_RATE | Number |
This is the base rate for FX Optimizer enabled currency conversion at the time of transaction. |
51 | TOTAL_FX_MARKUP | Number |
This total markup includes the markup charged by the partner and PayPal as part of FX Optimizer enabled currency conversion. |
52 | NET_FX_RATE | Number |
This is the net rate for FX Optimizer enabled currency conversion at the time of transaction includes Base & total markup. |
53 | REQUESTED_FX_ID | Varchar |
This is rate requested by the user at the time of the transaction for FX Optimizer enabled currency conversion. |
54 | APPLIED_FX_ID | Varchar |
This is the rate that is applied at the time of currency conversion.
This rate can be the same as REQUESTED_FX_ID if
REQUESTED_FX_ID has not expired at the time of transaction.
If REQUESTED_FX_ID has expired, a new rate is applied at
the time of transaction.
|
55 | PAYOUT_ITEM_ID | Varchar |
The ID of the payout item. |
56 | MEMO | Varchar |
Custom information sent by user while calling Api to place transaction. |
57 | PAYOUT_AMOUNT | Money |
Total payout amount expected to be disbursed to the Users Payout instrument. |
58 | PAYOUT_SETTLEMENT_ CURRENCY |
Three-character currency code | Payout amount currency that is expected to be disbursed to the Users Payout instrument. |
59 | PAYOUT_ID | Varchar |
Unique identifier used to tie all transactions that contributed to a particular Payout. This can also be used to link all Payout life cycle events. |
60 | SETTLEMENT_SOFT _DESCRIPTOR |
Varchar |
Unique identifier sent as part of Settlement to Bank transaction that can be used along with SETTLEMENT_REFERENCE_ID to trace the deposit in their Bank statement. |
61 | SETTLEMENT_ INSTRUMENT_TYPE |
Varchar |
The type of external entity where the external transfer amount was
credited to or debited from, such as BANK , for bank
transactions.
|
62 | SETTLEMENT_ INSTRUMENT_SUB_TYPE |
Varchar |
The sub-type of external entity where external transfer amount was credited to or debited from. |
63 | WITHDRAWAL_TYPE | Varchar |
Withdrawal type to differentiate on-demand vs automated withdrawals. ‘Merchant Initiated’ will be shown for on-demand payouts/withdrawals. |
Section footer data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
The column type (SF ). |
File footer data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
The column type (FF ). |