Partner merchant settlement report

Docs

Last updated: Apr 22nd, 7:53pm

This report provides a detailed view of all merchant activities on your platform, including all bank settlements for managed path merchants during the reporting window. It also includes any transactions that contribute to the merchant's bank settlement amount, which may be outside the reporting window. Use this report to reconcile merchant bank settlements.

Know before you begin

You must be an approved partner to use this report.
This report is for managed accounts only. Contact your account manager to get your account enabled 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.
The actual amounts in this report are multiplied by 100 to represent the amounts as cents. For instance, a $10 entry appears as 1000 on the report.
To maintain backward compatibility, read the report data by column header name instead of column index.

Section 1: Report file name

The file name of the Partner Merchant Settlement Report for a single account follows this naming convention:

1PSR.yyyymm.ReportIdentifier.ReportingWindow.SequenceNumber.MajorVersion.MinorVersion.Format

    
            Field
            Information
        
            PSR
            An abbreviation for Partner Merchant Settlement Report.
        
            yyyymmdd
            The date for the data in the report. It represents the latest, or ending date, of the data.
        
            ReportIdentifier
            This unique value identifies the report, such as the BN code or organization name.
        
            ReportingWindow
            The window of time in which 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).

Field	Information
`PSR`	An abbreviation for Partner Merchant Settlement Report.
`yyyymmdd`	The date for the data in the report. It represents the latest, or ending date, of the data.
`ReportIdentifier`	This unique value identifies the report, such as the BN code or organization name.
`ReportingWindow`	The window of time in which 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).

Section 2: 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 at which the report file was generated, in the following format: `YYYY/MM/DDHH:MM:SS offset`, where `YYYY` is the four-digit year, `MM` is the two-digit month, `HH` is the hour in 24-hour notation, `MM` is minutes, `SS` is seconds, and `offset` is the five-character signed offset from GMT, such as `+0800`.
3	Reporting Time Zone	`Varchar`, single character, one of: `A`, `H`, `R`, `X`.	The window of time in which the report was generated, as follows: `A:` America/New York to America/Los Angeles. `H:` America/Los Angeles to Asia/Hong Kong. `R:` Asia/Hong Kong to Europe/London. `X:` Europe/London to America/New York.
4	Report Period Start Date	`Date-time`	The beginning date and time for which to include transactions in the report, in the following format: `YYYY/MM/DDHH:MM:SS offset`, where `offset` is the five-character signed offset from GMT. For example, `+0800`.
5	Report Period End Date	`Date-time`	The final date and time for which to include transactions in the report, in the following format: `YYYY/MM/DDHH:MM:SS offset`, where `offset` is the five-character signed offset from GMT. For example, `+0800`.

Section header data

1 Column Type Literal SH

Section body data

1	Column Type	`Literal`	The column type (`CH`).
2	TRANSACTION_TYPE	`Varchar`	The type of transaction. Transaction type is one of: `ACH_REVERSAL:` This type applies to reversal of a deposit from PayPal balance to a bank account. `ADD_MONEY:` This type applies to negative payout transactions where funds are debited from the merchant’s bank account. `CHARGEBACK:` This type applies to chargeback fees and chargeback fee reversal transactions. `CORRECTION:` Adjustments due to account corrections. `DISBURSEMENT:` Funds disbursed to merchants for a Delayed Payment. `DISPUTE:` Money movement resulting from a dispute filed by your buyer or you. `FAILED_DISBURSEMENT:` Failure of an automated transaction that was initiated by PayPal to disburse the money from your balance to your linked bank account. `HOLD_RELEASE:` Reversals of holds in your account. `HOLD:` Holds placed on the amount of a sales transaction or on all the funds in your account. `PAYMENT:` Forward money movement between a buyer and a seller for an order. `PAYOUT_REFUND:` Refund against a past payout transaction. `PAYOUT_REVERSAL:` Reversal of a Payout transaction. `RECOUP:` This transaction type applies to recoup transactions from bank or loss accounts. `REFUND:` Refund related to a payment you received via PayPal. This refund will be referenced to the original payment in your PayPal account. `REVERSAL:` Reversal of funds due to a dispute or other bank action. `WITHDRAW_MONEY:` Withdrawal of money from your balance to a bank or non-banking institution account by you or auto-generated business events trigged as part of Flexible Payouts or On demand withdrawals. `WITHDRAWAL` Withdrawal of money from your balance to a bank or non-banking institution account by you or auto-generated business events.
3	TRANSACTION_SUBTYPE	`Varchar`	The value of the transaction subtype depends on the value of the `TRANSACTION_TYPE`. This can be blank in some of the use cases. One of the following subtypes of transaction: `ACCOUNT_RESERVE_RELEASE:` This subtype is applicable for any funds that are released from reserve to the Merchant account. These reserves are not tied to any individual transactions. `ACCOUNT_RESERVE:` This subtype is applicable for any funds that are reserved from the Merchant account. These reserves are not tied to any individual transactions. `BANK_DEPOSIT:` This subtype applies to negative payout transactions where transaction type is ADD_MONEY. `BANK_RETURN_RECOVERY:` Money returned due to Bank returns. `BANK_REVERSAL:` Failure of an automated transaction that was initiated by PayPal to disburse the money from your balance to your linked bank account. `BANK:` This subtype applies to withdrawal transactions. `BONUS:` This subtype applies to bonus transactions. `CREATED:` Payout is created and reserved for settlement withdrawal. `DEPOSIT:` When the transaction type is `CORRECTION`, the value `DEPOSIT` or `WITHDRAWAL` will be populated for the transaction subtype depending on whether the amount is deposited or withdrawn from the partner's financial account. `DISBURSED:` Settlement withdrawal is disbursed to the user's payout instrument, such as a bank account. `DISPUTE_HOLD_RELEASE:` Reversal of amount put on hold to manage risk when a dispute is filed against you. `DISPUTE_HOLD:` Amount put on hold to manage risk when a dispute is filed against you. `DISPUTE_REFUND:` This subtype helps merchants identify refunds which were a result of a dispute/chargeback case. `FAILED:` Reversal of a bank or settlement withdrawal failed for compliance reasons. `FEE:` This subtype applies to chargeback transactions. `FOREIGN_WITHDRAWAL:` Indicates foreign withdrawal fees, applicable for transaction type `FEES`. `FROM:` This subtype refers to the currency funds were converted from. `LOSS_ACCOUNT:` This subtype applies to recoup transactions. `MASSPAY:` This subtype applies to payment transactions. `PARTNER_FEE:` This subtype applies to fee transactions. `PAYMENT_FEE:` This subtype applies to fee transactions. `PENDING:` Settlement withdrawal is put on hold for risk or compliance reasons. `REFUND:` This subtype applies to fees refund transactions. `REVERSAL:` This subtype applies to chargeback, fees, and withdrawal transactions. `REVERSED:` Payout is suspended, and the amount reserved for payout is reversed back to the user's account. `TO:` This subtype refers to the currency funds were converted to. `TRANSACTIONAL_RESERVE_RELEASE:` This subtype is applicable for any funds that are released from Reserve hold for a specific transaction. `TRANSACTIONAL_RESERVE:` This subtype is applicable for any funds that are placed on Reserve hold for a specific transaction. `VOID:` This subtype applies to auth void transactions. `WITHDRAWAL:` When the transaction type is `CORRECTION`, the value `DEPOSIT` or `WITHDRAWAL` will be populated for the transaction subtype depending on whether the amount is deposited or withdrawn from the partner's financial account.
4	SELLER_ACCOUNT_ID	`Varchar`	The seller's PayPal encrypted account number.
5	PAYPAL_REFERENCE_ID	`String`	The original PayPal transaction ID to which this event is related.
6	PAYPAL_TRANSACTION_ID	`Varchar`	The ID for the individual transaction.
7	INVOICE_ID	`String`	Invoice ID of the transaction.
8	CUSTOM_FIELD	`Varchar`	Custom field passed by partner. Reserved exclusively for partner use.
9	TRANSACTION_DATE	`Date-time`	The date and time at which the case was filed in the following format: `YYYY/MM/DDHH:MM:SS offset`, where `offset` is the five-character signed offset from GMT, such as `+0800`.
10	SELLER_AMOUNT	`Money`	Amount of funds transferred to or from a customer. Funds moving out of the seller account have a dash (`-`) prefix.
11	SELLER_AMOUNT _CURRENCY	Three-character currency code	The currency of the seller amount.
12	EXTERNAL_TRANSFER_ AMOUNT	`Money`	The amount credited to or debited from an external entity (like Bank). Funds debited from an external entity have a dash (`-`) prefix.
13	EXTERNAL_TRANSFER_ AMOUNT_CURRENCY	Three-character currency code	The currency of the External Transfer Amount.
14	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.
15	SETTLEMENT_INSTRUMENT_ SUB_TYPE	`Varchar`	The sub type of external entity where external transfer amount was credited to or debited from.
16	SETTLEMENT_ REFERENCE_ID	`Varchar`	External reference ID for the external transfer transaction.
17	INTEGRATION_IDENTIFIER	`Varchar`	The partner's button source code.
18	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: `PAYPAL` `CREDIT_CARD` `DEBIT_CARD` `BANK` `VENMO` `Apple Pay` `Google Pay` `Network Token` Supported APMs
19	PAYMENT_INSTRUMENT_ SUBTYPE	`Varchar`	One of the following detailed classifications of the financial instrument used to fund a payment: `AMEX:` AMEX card transaction `CARTE_BANCAIRE:` CARTE_BANCAIRE card transaction `CETELEM:` CETELEM card transaction `COFIDIS:` COFIDIS card transaction `COFINOGA:` COFINOGA card transaction `CHINA_UNION_PAY:` CHINA_UNION_PAY card transaction `DELTA:` DELTA card transaction `DISCOVER:` DISCOVER card transaction `ELECTRON:` ELECTRON card transaction `ELO:` ELO card transaction `HIPER:` HIPER card transaction `HIPERCARD:` HIPERCARD card transaction `JCB:` JCB card transaction `MAESTRO:` MAESTRO card transaction `MASTER_CARD:` MASTER_CARD card transaction `SOLO:` SOLO card transaction `STAR:` STAR card transaction `SWITCH:` SWITCH card transaction `VISA:` VISA card transaction For Wallets and Network token, Payment Source Subtype would show details of card type and card brand used to fund the transaction. For example: `CREDIT_CARD-VISA` `DEBIT_CARD-MASTER_CARD`
20	CHECKOUT_CHANNEL	`Varchar`	Used to distinguish online and offline payments. `POS_PPH` A payment made using a PayPal Here device. `ONLINE_PAYMENT` A payment made on an online platform.
21	TRANSACTION_AMOUNT	`Money`	The amount of the transaction.
22	TRANSACTION_CURRENCY	Three-character currency code	The currency of the transaction.
23	PARTNER_FEE	`Money`	Partner fees associated with the transaction. Funds moving out of the partner fee account have a dash (`-`) prefix.
24	PARTNER_FEE_CURRENCY	Three-character currency code	The currency of the partner fee.
25	PARTNER_FEE_ ACCOUNT_ID	`Varchar`	The partner fee encrypted account number in PayPal.
26	PP_FEES	`Money`	Any PayPal fees associated with the transaction. Funds moving out of the PayPal fee account have a dash (`-`) prefix.
27	PP_FEES_CURRENCY	Three-character currency code	The currency of the PayPal fee.
28	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`.
29	PP_FEES_ FIXED_AMOUNT	`Money`	The fixed PayPal fee amount component of `PP_FEES`.
30	PP_FEES_XB_ FIXED_AMOUNT	`Money`	The fixed cross-border fee amount component of `PP_FEES_XB_FIXED_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_TOTAL_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	COUNTERPARTY_ ACCOUNT_ID	`Varchar`	The encrypted PayPal account number of the counter party involved in a transaction.
40	STORE_ID	`Varchar`	ID of the store where point of sale happened.
41	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.
42	PAYOUT_REFERENCE_ID	`Varchar`	Indicates transaction ID of the counterparty for a payout transaction.
43	PAYOUT_ITEM_ID	`Varchar`	The ID of the payout item.
44	MEMO	`Varchar`	Custom information sent by user while calling Api to place transaction.
45	PAYOUT_AMOUNT	`Money`	Total payout amount expected to be disbursed to the Users Payout instrument.
46	PAYOUT_SETTLEMENT _CURRENCY	Three-character currency code	Payout amount currency that is expected to be disbursed to the Users Payout instrument.
47	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.
48	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.
49	EOD_HOLD_BALANCE	`Money`	Balance is present in the holds category (holds related to disputes and reserves) at the end of the day.
50	EOD_HOLD_BALANCE _CURRENCY	Three-character currency code	Balance currency is present in the holds category (holds related to disputes and reserves) at the end of the day.
51	POST_PAYOUT_ AVAILABLE_BALANCE	`Money`	The available balance of the merchant after negative payout is initiated (Applicable only for partners with merchants who have NLM accounts and are set up for flexible payouts).
52	POST_PAYOUT_AVAILABLE_ BALANCE_CURRENCY	Three-character currency code	Available balance currency of the merchant after negative payout is initiated (Applicable only for partners with merchants who have NLM accounts and setup for flexible payouts)

Section footer data

1 Column Type Literal The column type (SF).

File footer data

1 Column Type Literal The column type (FF).