Funding Report Specification (Open Wallet API)
DOCS
Last updated: Aug 15th, 7:09am
Important: Open Wallet is a limited-release solution available only to select partners at this time. For more information, reach out to your PayPal account manager.
This report contains funding details of all accepted transactions in the corresponding confirmation file.
File specifications
The following specifications apply to the funding report file:
| Record length | 2000 byte fixed length. |
| File format | UTF-8 encoded. |
| Transmission day and time | Two days after the transaction before 6 AM PST. |
| File direction | In general, transmitted from partner to PayPal. |
Field specifications
The following specifications apply to the submission report fields:
| Position | Field | Type | Length; Start and end positions | Value | Required? | Description | |
|---|---|---|---|---|---|---|---|
| 1 | RECORD_TYPE | Alphanumeric, uppercase | 7 1 and 7 | FFHR001 | Yes | Corresponds to the record type and must be the first item in the record. The FFHR001 constant indicates a funding file header record. | |
| 2 | RECORD_NUMBER | Numeric, right justified, zero filled (if no value) | 8 8 and 15 | 00000001 | Yes | Contains a record sequence number to monitor the integrity and continuity of data in a file. The header record is always set to 00000001. Each subsequent record must be incremented to the RECORD_NUMBER value in the preceding record plus 1.The number of records per file must not exceed 99999999. | |
| 3 | CLIENT_ID | Alphanumeric, uppercase, left justified, character space filled (if no value) | 11 16 and 26 | -- | Yes | Unique ID assigned by PayPal to its Client | |
| 4 | PRODUCT_ID | Alphanumeric, uppercase, left justified, character space filled (if no value) | 11 27 and 37 | -- | Yes | The unique PayPal-assigned ID for a product. | |
| 5 | FILE_DIRECTION | Alphanumeric, uppercase, left justified, character space filled (if no value) | 1 38 and 38 | -- | Yes | Direction in which to send the submission file:
| |
| 6 | FUNDING_FILE_REFERENCE_NUMBER | Alphanumeric, uppercase, left justified, character space filled (if no value) | 12 39 and 50 | Unique client-system-generated funding file reference number | Yes | Contains a submitter-specified file reference number. Can be used to track this file. Value must be unique for each submitted file. A file identification and tracking cross-reference to the corresponding File Validation Report. | |
| 7 | FILE_CREATION_DATE | Numeric, CCYYMMDD | 8 51 and 58 | Date the Funding file was created (PST) | Yes | Corresponds to the date when the submitter created the file. The format is CCYYMMDD, where:
20200215 for February 15, 2020. | |
| 8 | FILE_CREATION_TIME | Numeric, HHMMSS (24-hour clock) | 6 59 and 64 | The time when the funding file was created (PST) | Yes | Corresponds to the time when the submitter created the file. The format is HHMMSS, where
143000 for 2:30 PM. | |
| 9 | FILE_VERSION_NUMBER | Alphanumeric | 8 65 and 72 | Version of the file | Yes | Version of the file | |
| 10 | FILLER | Alphanumeric | 8 73 and 2000 | Character spaces | Yes | Reserved for PayPal internal use. |
Funding file summary records
The single file summary record contains the overall amount owed by PayPal to the client, or by the client to PayPal.
| Position | Field | Type | Length; Start and end positions | Value | Required? | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | RECORD_TYPE | Alphanumeric, uppercase | 7 1 and 7 | FFSR001 | Yes | Corresponds to the record type and must be the first item in the record. The FFSR001 constant indicates a file summary record. | |||||||||||||
| 2 | RECORD_NUMBER | Numeric, right justified, zero filled (if no value) | 8 8 and 15 | 00000002 | Yes | Contains a record sequence number to monitor the integrity and continuity of data in a file. The header record is always set to 00000002. Each subsequent record must be incremented to the RECORD_NUMBER value in the preceding record plus 1.The number of records per file must not exceed 99999999. | |||||||||||||
| 3 | PRODUCT_ID | Alphanumeric, uppercase, left justified, character space filled (if no value) | 11 16 and 26 | -- | Yes | The unique PayPal-assigned ID for a product.. | |||||||||||||
| 4 | NET_PAYMENT_AMOUNT | Alphanumeric, uppercase, two decimal places implied, right justified, zero-filled, signed positive or negative 20 27 | 46 | Refer to 'NET_FILE_AMOUNT' within FILE TRAILER for calculation details | Yes | For US dollar (USD) and Canadian dollar (CAD) transactions, two decimal places are implied. An uppercase alpha code replaces the last digit in the transaction. This code indicates a debit amount. The debit codes and their numeric equivalents are:
| |||||||||||||
| 5 | NET_PAYMENT_ABSOLUTE_AMOUNT | Numeric, right justified, zero filled | 20 47 and 66 | Refer to same field within File Trailer for calculation details | -- | -- | |||||||||||||
| 6 | PAYMENT_DIRECTION | Alphanumeric, uppercase, left justified, character space filled (if no value) | 1 67 and 67 | -- | Yes | Direction in which to send the submission file:
| |||||||||||||
| 7 | PAYMENT_DATE | Numeric | 7 68 and 74 | -- | -- | Contains the Payment Date scheduled in the client system. The date that funds are actually available to the payee’s depository institution may differ from the date reported in this field. The format is: YYYYDDD | |||||||||||||
| 8 | BANK_ROUTING_NUMBER | Numeric | 12 75 and 86 | -- | -- | Contains the ABA Bank Number to which the AMOUNT is transferred through the ACH banking system. | |||||||||||||
| 9 | BANK_ACCOUNT_NUMBER | Numeric | 18 87 and 104 | -- | -- | Contains the payee’s Direct Deposit Account Number to which the AMOUNT will be transferred through the ACH banking system | |||||||||||||
| 10 | TYPE_OF_BANK_ACCOUNT | Alphanumeric | 5 105 and 109 | -- | -- | Checking/Savings/Any other type of account | |||||||||||||
| 11 | FILLER | Alphanumeric | 1891 110 and 2000 | Character spaces | Yes | Reserved for PayPal internal use. |
Funding batch header
There can be multiple batch headers within the same file. They are sorted by wallet brand.
| Position | Field | Type | Length; Start and end positions | Value | Required? | Description | |
|---|---|---|---|---|---|---|---|
| 1 | RECORD_TYPE | Alphanumeric, uppercase | 7 1 and 7 | FBHR001 | Yes | Corresponds to the record type and must be the first item in the record. The constant "FBHR001" in this field indicates that this is a Batch Header Record. | 2 |
| 3 | PRODUCT_ID | Alphanumeric, uppercase, left justified, character space filled (if no value) | 11 16 and 26 | -- | Yes | The unique PayPal-assigned ID for a product. | |
| 4 | WALLET_BRAND | Numeric, right justified, zero filled (if no value) | 3 27 and 29 | 001-PayPal 002-VENMO | Yes | Wallet associated with the specific transaction | |
| 5 | FILLER | Alphanumeric | 1971 30 and 2000 | Character spaces | Yes | Reserved for PayPal internal use. |
Funding transaction primary pricing record
There is one Yes record per accepted transaction called out in the confirmation file.
| Position | Field | Type | Length; Start and end positions | Value | Required? | Description | |
|---|---|---|---|---|---|---|---|
| 1 | RECORD_TYPE | Alphanumeric, uppercase | 7 1 and 7 | FTPP001 | Yes | Corresponds to the record type and must be the first item in the record. The FTPP001 indicates a transaction primary pricing record. | |
| 2 | RECORD_NUMBER | Numeric, right justified, zero filled (if no value) | 8 8 and 15 | "00000003" | Yes | Contains a record sequence number to monitor the integrity and continuity of data in a file. The header record is always set to 00000001. Each subsequent record must be incremented to the RECORD_NUMBER value in the preceding record plus 1.The number of records per file must not exceed 99999999. | |
| 3 | REFERENCE_FINANCIAL_INSTRUMENT_ID | Numeric | 15 16 and 30 | -- | Yes | This is the field that is used to uniquely identify the P2P Pass instrument used for the transaction. It is equivalent to the FPAN in the Card world. | |
| 4 | PAYER ID | Alphanumeric | 19 31 and 49 | -- | Yes | This is the Sender's PayPal account number | |
| 5 | TRANSACTION_TYPE | Alphanumeric | 2 50 and 51 |
| Yes | Type of transaction. Depending on the product/file direction, results in a credit to PayPal or a debit from PayPal | |
| 6 | TRANSACTION_DATE | Numeric, CCYYMMDD | 8 52 and 59 | Transaction Date (PST) | Yes | Corresponds to the date when the submitter created the file. The format is CCYYMMDD, where:
20200215 for February 15, 2020. | |
| 7 | TRANSACTION_TIME | Numeric, HHMMSS (24-hour clock) | 6 60 and 65 | Transaction Time (PST) | Yes | Corresponds to the time when the submitter created the file. The format is HHMMSS, where
143000 for 2:30 PM. | |
| 8 | ISSUER_ORIGINATION_ID | Alphanumeric | 15 66 and 80 | In P2P Pass Discussions this was referred to as the Amex Origination ID. | Conditional | This ID is unique. This ID is always generated by the issuer for every transaction from the issuer. PayPal includes this ID in the API call it makes to the issuer as part of executing that transaction from the issuer. | |
| 9 | REFERENCE_KEY | Alphanumeric | 20 81 and 100 | RRN | Yes | A PayPal-generated ID that is sent to Amex for every original transaction API call. | |
| 10 | REFUND_REFERENCE_KEY | Alphanumeric | 20 101 and 120 | Refund/Reversal RRN | Conditional | A PayPal-generated ID that is sent to Amex for all reverse money movement API calls associated with the above original transaction. | |
| 11 | APPROVAL_ID | Alphanumeric, left justified, character space filled | 12 121 and 132 | Unique ID received from client when the authorization/reserve funds request is approved in real time | Yes | Should contain the same value the issuer transmitted in the original authorization response message. This value must be unique. In cases where an approval code is inapplicable, such as credit transactions, fill this field with character space. | |
| 12 | REFUND_APPROVAL_ID | Alphanumeric, left justified, character space filled | 12 133 and 144 | -- | Conditional | This field should contain the same value the issuer transmitted in the original authorization response message. This value must be unique. In cases where an approval code does not apply, such as credit transactions, fill this field with character space. | |
| 13 | CONVERSION_RATE | Alphanumeric | 6 145 and 150 | -- | No | -- | |
| 14 | SEQUENCE NUMBER | Numeric, zero filled if no value | 6 151 and 156 | -- | No | -- | |
| 15 | CLEARING NUMBER | Numeric, zero filled if no value | 6 157 and 162 | -- | No | -- | |
| 16 | SETTLEMENT_ID | Alphanumeric | 20 163 and 182 | -- | No | -- | |
| 17 | REFUND_SETTLEMENT_ID | Alphanumeric | 20 183 and 202 | -- | No | -- | |
| 18 | INSTRUMENT_EXPIRY_DATE | Numeric | 4 203 and 206 | -- | No | -- | |
| 19 | MERCHANT_ID | Alphanumeric | 2 207 and 218 | -- | No | -- | |
| 20 | TXN_AMOUNT | Numeric, right justified, zero filled (if no value) | 12 219 and 230 | Transaction amount in the currency designated by the currency code field | Yes | Contains the total transaction amount. in the currency designated by the currency code. Note: Zero-value transactions are not accepted | |
| 21 | TXN_CURRENCY_CODE | Alphanumeric, uppercase | 3 231 and 233 | Currency Code of the transaction | Yes | Contains the code of the currency used to execute the original transaction and corresponds to the currency used for the AMOUNT field. The Currency code format supports both ISO alpha and numeric values. For example, the ISO alpha code for U.S. Dollars is USD, and the numeric code is 840 . | |
| 22 | FEE1_CODE | Alphanumeric | 2 234 and 235 | -- | -- | -- | |
| 23 | FEE1_DESCRIPTION | Alphanumeric | 30 236 and 265 | -- | -- | Depending on the product this could be an Interchange Fee, Assessment Fee, Processing Fee, Other Fee, or some variation of the above | |
| 24 | FEE1_VARIABLE_COMPONENT | Alphanumeric | 9 266 and 274 | Fees applied to the transaction can have 2 parts. A Percentage part and Flat Fee (per transaction) part. The variable component refers to the percentage part of the fee. | Yes | Contains the variable used to calculate the overall Fee1, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". For a debit (a negative rate), the first position is a minus sign. For example, a negative .003 (0.3%) appears as 0 123456789 -00000300 For a credit (a positive rate), the first position is a plus sign. For example, a positive .003 (.3%) appears as 0 123456789 +00000300 If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 25 | FEE1_FIXED_COMPONENT | Alphanumeric | 9 275 and 283 | Fees applied to the transaction can have 2 parts. A Percentage part and Flat Fee (per transaction) part. The Fixed component refers to the per transaction flat fee. | Yes | Contains the fixed component of Fee1 used to calculate the overall Fee1, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 26 | TXN_AMT_FEE1_VARIABLE_COMPONENT | Alphanumeric | 15 284 and 298 | (TXN_AMOUNT) * (FEE1_VARIABLE_COMPONENT) | -- | Contains the variable used to calculate the overall Fee1, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". For a debit (a negative rate), the first position is a minus sign. For example, a negative .003 (0.3%) appears as 0 123456789 -00000300 For a credit (a positive rate), the first position is a plus sign. For example, a positive .003 (.3%) appears as 0 123456789 +00000300 If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 27 | TXN_AMT_FEE1_FIXED_COMPONENT | Alphanumeric | 15 299 and 313 | Should be the same value as the FEE1_FIXED_COMPONENT. The per transaction flat fee. | -- | Contains the fixed component of Fee1 used to calculate the overall Fee1, client charges for services. This value may be a debit or credit amount. The format is a 1-digit "sign", followed by a 14-digit "amount." If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 28 | TXN_AMT_FEE1 | Alphanumeric | 15 314 and 328 | (TXN_AMT_FEE1_VARIABLE_COMPONENT) + (TXN_AMT_FEE1_FIXED_COMPONENT) | -- | FEE1 for the transaction charged by the client | |
| 29 | FEE2_CODE | Alphanumeric | 2 329 and 330 | -- | -- | -- | |
| 30 | FEE2_DESCRIPTION | Alphanumeric | 30 331 and 360 | -- | -- | Depending on the product this could be an Interchange Fee, Assessment Fee, Processing Fee, Other Fee, or some variation of the above | |
| 31 | FEE2_VARIABLE_COMPONENT | Alphanumeric | 9 361 and 369 | Fees applied to the transaction can have 2 parts. A Percentage part and Flat Fee (per transaction) part. The variable component refers to the percentage part of the fee. | Yes | Contains the variable used to calculate the overall Fee2, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". For a debit (a negative rate), the first position is a minus sign. For example, a negative .003 (0.3%) appears as 0 123456789 -00000300 For a credit (a positive rate), the first position is a plus sign. For example, a positive .003 (.3%) appears as 0 123456789 +00000300 If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 32 | FEE2_FIXED_COMPONENT | Alphanumeric | 9 370 and 378 | Fees applied to the transaction can have 2 parts. A Percentage part and Flat Fee (per transaction) part. The Fixed component refers to the per transaction flat fee. | Yes | Contains the fixed component of Fee2 used to calculate the overall Fee2, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 33 | TXN_AMT_FEE2_VARIABLE_COMPONENT | Alphanumeric | 15 379 and 393 | (TXN_AMOUNT) * (FEE2_VARIABLE_COMPONENT) | -- | Contains the variable used to calculate the overall Fee2, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". For a debit (a negative rate), the first position is a minus sign. For example, a negative .003 (0.3%) appears as 0 123456789 -00000300 For a credit (a positive rate), the first position is a plus sign. For example, a positive .003 (.3%) appears as 0 123456789 +00000300 If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 34 | TXN_AMT_FEE2_FIXED_COMPONENT | Alphanumeric | 15 394 and 408 | This should be the same value as the FEE2_FIXED_COMPONENT. The per transaction flat fee. | -- | Contains the fixed component of Fee1 used to calculate the overall Fee2, client charges for services. This value may be a debit or credit amount. The format is a 1-digit "sign", followed by a 14-digit "amount." If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 35 | TXN_AMT_FEE2 | Alphanumeric | 15 409 and 423 | (TXN_AMT_FEE2_VARIABLE_COMPONENT)+ (TXN_AMT_FEE2_FIXED_COMPONENT) | -- | FEE2 for the transaction charged by the client | |
| 36 | FEE3_CODE | Alphanumeric | 2 424 and 425 | -- | -- | Depending on the product this could be an Interchange Fee, Assessment Fee, Processing Fee, Other Fee, or some variation of the above. | |
| 37 | FEE3_DESCRIPTION | Alphanumeric | 30 426 and 455 | -- | -- | Description of the fee | |
| 38 | FEE3_VARIABLE_COMPONENT | Alphanumeric | 9 456 and 464 | Fees applied to the transaction can have two parts. A Percentage part and Flat Fee (per transaction) part. The variable component refers to the percentage part of the fee. | Yes | Contains the variable used to calculate the overall Fee3, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". For a debit (a negative rate), the first position is a minus sign. For example, a negative .003 (0.3%) appears as 0 123456789 -00000300 For a credit (a positive rate), the first position is a plus sign. For example, a positive .003 (.3%) appears as 0 123456789 +00000300 If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 39 | FEE3_FIXED_COMPONENT | Alphanumeric | 9 465 and 473 | Fees applied to the transaction can have 2 parts. A Percentage part and Flat Fee (per transaction) part. The Fixed component refers to the per transaction flat fee. | Yes | Contains the fixed component of Fee1 used to calculate the overall Fee3, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 40 | TXN_AMT_FEE3_VARIABLE_COMPONENT | Alphanumeric | 15 474 and 488 | (TXN_AMOUNT) * (FEE3_VARIABLE_COMPONENT) | -- | Contains the variable used to calculate the overall Fee3, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". For a debit (a negative rate), the first position is a minus sign. For example, a negative .003 (0.3%) appears as 0 123456789 -00000300 For a credit (a positive rate), the first position is a plus sign. For example, a positive .003 (.3%) appears as 0 123456789 +00000300 If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 41 | TXN_AMT_FEE3_FIXED_COMPONENT | Alphanumeric | 15 489 and 503 | This should be the same value as the FEE3_FIXED_COMPONENT. The per transaction flat fee. | -- | Contains the fixed component of Fee1 used to calculate the overall Fee3, client charges for services. This value may be a debit or credit amount. The format is a 1-digit "sign", followed by a 14-digit "amount." If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 42 | TXN_AMT_FEE3 | Alphanumeric | 15 504 and 518 | (TXN_AMT_FEE3_VARIABLE_COMPONENT) + (TXN_AMT_FEE3_FIXED_COMPONENT) | -- | FEE3 for the transaction charged by the client. | |
| 43 | FEE4_CODE | Alphanumeric | 2 519 and 520 | -- | -- | -- | |
| 44 | FEE4_DESCRIPTION | Alphanumeric | 30 521 and 550 | -- | -- | Depending on the product this could be an Interchange Fee, Assessment Fee, Processing Fee, Other Fee, or some variation of the above. | |
| 45 | FEE4_VARIABLE_COMPONENT | Alphanumeric | 9 551 and 559 | Fees applied to the transaction can have 2 parts. A Percentage part and Flat Fee (per transaction) part. The variable component refers to the percentage part of the fee. | Yes | Contains the variable used to calculate the overall Fee4, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". For a debit (a negative rate), the first position is a minus sign. For example, a negative .003 (0.3%) appears as 0 123456789 -00000300 For a credit (a positive rate), the first position is a plus sign. For example, a positive .003 (.3%) appears as 0 123456789 +00000300 If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 46 | FEE4_FIXED_COMPONENT | Alphanumeric | 9 560 and 568 | Fees applied to the transaction can have 2 parts. A Percentage part and Flat Fee (per transaction) part. The Fixed component refers to the per transaction flat fee. | Yes | Contains the fixed component of Fee1 used to calculate the overall Fee4, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". If unused, position 1 in Contains a character space and the remaining positions are zero filled. | |
| 47 | TXN_AMT_FEE4_VARIABLE_COMPONENT | Alphanumeric | 15 569 | 583 | (TXN_AMOUNT) * (FEE4_VARIABLE_COMPONENT) | -- | Contains the variable used to calculate the overall Fee4, client charges for services. This value may be a debit or credit rate. The format is a 1-digit "sign", followed by an 8-digit "rate". For a debit (a negative rate), the first position is a minus sign. For example, a negative .003 (0.3%) appears as 0 123456789 -00000300 For a credit (a positive rate), the first position is a plus sign. For example, a positive .003 (.3%) appears as 0 123456789 +00000300 If unused, position 1 in Contains a character space and the remaining positions are zero filled. |
| 48 | TXN_AMT_FEE4_FIXED_COMPONENT | Alphanumeric | 15 584 | 598 | This should be the same value as the FEE4_FIXED_COMPONENT. The per transaction flat fee. | -- | Contains the fixed component of Fee1 used to calculate the overall Fee4, client charges for services. This value may be a debit or credit amount. The format is a 1-digit "sign", followed by a 14-digit "amount." If unused, position 1 in Contains a character space and the remaining positions are zero filled. |
| 49 | TXN_AMT_FEE4 | Alphanumeric | 15 599 and 613 | (TXN_AMT_FEE4_VARIABLE_COMPONENT)+ (TXN_AMT_FEE4_FIXED_COMPONENT) | -- | FEE4 for the transaction charged by the client | |
| 50 | FILLER | Alphanumeric | 1387 614 and 2000 | Character spaces | No | Reserved for PayPal internal use. |
Funding transaction associated pricing record
A No record.
| Position | Field | Type | Length; Start and end positions | Value | Required? | Description | |
|---|---|---|---|---|---|---|---|
| 1 | RECORD_TYPE | Alphanumeric, uppercase | 7 1 and 7 | FTAP001 | No | Corresponds to the record type and must be the first item in the record. The constant "FTAP001" in this field indicates that this is a Detail Associated Record. | |
| 2 | RECORD_NUMBER | Numeric, right justified, zero filled (if no value) | 8 8 and 15 | No | Contains a record sequence number to monitor the integrity and continuity of data in a file. The header record is always set to 00000001. Each subsequent record must be incremented to the RECORD_NUMBER value in the preceding record plus 1.The number of records per file must not exceed 99999999. | ||
| 3 | FILLER | Alphanumeric | 1985 16 and 2000 | Character spaces | No | Reserved for PayPal internal use. |
Funding batch trailer
There can be multiple batch trailers within the same file. They correspond to the number of batch headers. They are sorted by product and wallet brand.
| Position | Field | Type | Length; Start and end positions | Value | Required? | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | RECORD_TYPE | Alphanumeric, uppercase | 7 1 and 7 | FBTR001 | Yes | Corresponds to the record type and must be the first item in the record. The constant "FBTR001" in this field indicates that this is a Batch Trailer Record. | |||||||||||||
| 2 | RECORD_NUMBER | Numeric, right justified, zero filled (if no value) | 7 8 | 14 | -- | Yes | Contains a record sequence number to monitor the integrity and continuity of data in a file. The header record is always set to 00000001. Each subsequent record must be incremented to the RECORD_NUMBER value in the preceding record plus 1.The number of records per file must not exceed 99999999. | ||||||||||||
| 3 | PRODUCT_ID | Alphanumeric, uppercase, left justified, character space filled | 11 15 | 25 | -- | Yes | The unique PayPal-assigned ID for a product. | ||||||||||||
| 4 | WALLET_BRAND | Numeric, right justified, zero filled | 3 26 | 28 | 001-PayPal 002-VENMO | Yes | Wallet associated with the specific transaction | ||||||||||||
| 5 | TOTAL_NUMBER_OF_BATCH_TRANSACTIONS | Numeric, right justified, zero filled | 8 29 | 36 | -- | Yes | Total number of 'Detail Primary Records' (DPR001) in this batch | ||||||||||||
| 6 | TOTAL_NUMBER_OF_BATCH_CREDIT_TRANSACTIONS | Numeric, right justified, zero filled | 8 37 | 44 | -- | Yes | -- | ||||||||||||
| 7 | TOTAL_BATCH_CREDIT_TXN_AMOUNT | Numeric, right justified, zero filled | 20 45 | 64 | -- | Yes | -- | ||||||||||||
| 8 | TOTAL_NUMBER_OF_BATCH_DEBIT_TRANSACTIONS | Numeric, right justified, zero filled | 8 65 | 72 | -- | Yes | -- | ||||||||||||
| 9 | TOTAL_BATCH_DEBIT_TXN_AMOUNT | Numeric, right justified, zero filled | 20 73 | 92 | -- | Yes | -- | ||||||||||||
| 10 | NET_BATCH_TXN_AMOUNT | Alphanumeric, uppercase, two decimal places implied, right justified, zero-filled, signed positive or negative 20 93 | 112 | Total transaction amount for this batch before any of the client fees are applied TOTAL_BATCH_CREDIT_TXN_AMOUNT - TOTAL_BATCH_DEBIT_TXN_AMOUNT | Yes | For US dollar (USD) and Canadian dollar (CAD) transactions, two decimal places are implied. An uppercase alpha code replaces the last digit in the transaction. This code indicates a debit amount. The debit codes and their numeric equivalents are:
| |||||||||||||
| 11 | NET_BATCH_TXN_AMT_FEE1 | Alphanumeric, uppercase, two decimal places implied, right justified, zero-filled, signed positive or negative 20 113 | 132 | Sum of all the individual TXN_AMT_FEE1 | Yes | For US dollar (USD) and Canadian dollar (CAD) transactions, two decimal places are implied. An uppercase alpha code replaces the last digit in the transaction. This code indicates a debit amount. The debit codes and their numeric equivalents are:
| |||||||||||||
| 12 | NET_BATCH_TXN_AMT_FEE2 | Alphanumeric, uppercase, two decimal places implied, right justified, zero-filled, signed positive or negative 20 133 | 152 | Sum of all the individual TXN_AMT_FEE2 | Yes | For US dollar (USD) and Canadian dollar (CAD) transactions, two decimal places are implied. An uppercase alpha code replaces the last digit in the transaction. This code indicates a debit amount. The debit codes and their numeric equivalents are:
| |||||||||||||
| 13 | NET_BATCH_TXN_AMT_FEE3 | Alphanumeric, uppercase, two decimal places implied, right justified, zero-filled, signed positive or negative 20 153 | 172 | Sum of all the individual TXN_AMT_FEE3 | Yes | For US dollar (USD) and Canadian dollar (CAD) transactions, two decimal places are implied. An uppercase alpha code replaces the last digit in the transaction. This code indicates a debit amount. The debit codes and their numeric equivalents are:
| |||||||||||||
| 14 | NET_BATCH_TXN_AMT_FEE4 | Alphanumeric, uppercase, two decimal places implied, right justified, zero-filled, signed positive or negative 20 173 | 192 | Sum of all the individual TXN_AMT_FEE4 | Yes | For US dollar (USD) and Canadian dollar (CAD) transactions, two decimal places are implied. An uppercase alpha code replaces the last digit in the transaction. This code indicates a debit amount. The debit codes and their numeric equivalents are:
| |||||||||||||
| 15 | NET_BATCH_AMT | Alphanumeric, uppercase, two decimal places implied, right justified, zero-filled, signed positive or negative 20 193 | 212 | This is the amount owed to PayPal for this product within this wallet brand after all the fees have been deducted. NET_BATCH_TXN_AMOUNT- (NET_BATCH_TXN_AMT_FEE1 + NET_BATCH_TXN_AMT_FEE2 + NET_BATCH_TXN_AMT_FEE +NET_BATCH_TXN_AMT_FEE4) | Yes | For US dollar (USD) and Canadian dollar (CAD) transactions, two decimal places are implied. An uppercase alpha code replaces the last digit in the transaction. This code indicates a debit amount. The debit codes and their numeric equivalents are:
| |||||||||||||
| 16 | FILLER | 178Alphanumeric | 8 213 | 2000 | Character spaces | Yes | Reserved for PayPal internal use. |
Funding file trailer
There is only one file trailer in the full site. It corresponds to the file header.
| Position | Field | Type | Length; Start and end positions | Value | Required? | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | RECORD_TYPE | Alphanumeric, uppercase | 7 1 and 7 | FFTR001 | Yes | Corresponds to the record type and must be the first item in the record. The constant "FFTR001" in this field indicates that this is a File Trailer Record. | |||||||||||||
| 2 | RECORD_NUMBER | Numeric, right justified, zero filled | 8 8 and 15 | 00000001 | Yes | Contains a record sequence number to monitor the integrity and continuity of data in a file. The header record is always set to 00000001. Each subsequent record must be incremented to the RECORD_NUMBER value in the preceding record plus 1.The number of records per file must not exceed 99999999. | |||||||||||||
| 3 | CLIENT_ID | Alphanumeric, uppercase, left justified, character space filled (if no value) | 11 16 and 26 | -- | Yes | Unique ID assigned by PayPal to its client | |||||||||||||
| 4 | PRODUCT_ID | Alphanumeric, uppercase, left justified, character space filled (if no value) | 11 27 | 37 | -- | Yes | The unique PayPal-assigned ID for a product. | ||||||||||||
| 5 | FILE_DIRECTION | Alphanumeric, uppercase, left justified, character space filled (if no value) | 1 38 | 38 | -- | Yes | Direction in which to send the submission file:
| ||||||||||||
| 6 | FUNDING_FILE_REFERENCE_NUMBER | Alphanumeric, uppercase, left justified, character space filled (if no value) | 12 39 | 50 | Unique client-system-generated funding file reference number | Yes | Contains a submitter-specified file reference number. Can be used to track this file. Value must be unique for each submitted file. A file identification and tracking cross-reference to the corresponding File Validation Report. | ||||||||||||
| 7 | FILE_CREATION_DATE | Numeric, CCYYMMDD | 8 51 | 58 | Date the Funding file was created (PST) | Yes | Corresponds to the date when the submitter created the file. The format is CCYYMMDD, where:
20200215 for February 15, 2020. | ||||||||||||
| 8 | FILE_CREATION_TIME | Numeric, HHMMSS (24-hour clock) | 6 59 | 64 | The time when the funding file was created (PST) | Yes | Corresponds to the time when the submitter created the file. The format is HHMMSS, where
143000 for 2:30 PM. | ||||||||||||
| 9 | FILE_VERSION_NUMBER | Alphanumeric | 8 65 | 72 | Version of the File | Yes | Version of the File | ||||||||||||
| 10 | TOTAL_NUMBER_OF_BATCHES | Numeric, right justified, zero filled | 8 73 | 80 | Echoed back from Submission File | Yes | |||||||||||||
| 11 | TOTAL_NUMBER_OF_FILE_TXNS | Numeric, right justified, zero filled | 8 81 | 88 | Yes | -- | |||||||||||||
| 12 | TOTAL_NUMBER_OF_FILE_CREDIT_TXNS | Numeric, right justified, zero filled | 8 89 | 96 | Yes | -- | |||||||||||||
| 13 | TOTAL_FILE_CREDIT_AMOUNT | Numeric, right justified, zero filled | 20 97 | 116 | Yes | -- | |||||||||||||
| 14 | TOTAL_NUMBER_OF_FILE_DEBIT_TXNS | Numeric, right justified, zero filled | 8 117 | 124 | Yes | -- | |||||||||||||
| 15 | TOTAL_FILE_DEBIT_AMOUNT | Numeric, right justified, zero filled | 20 125 | 144 | Yes | -- | |||||||||||||
| 16 | NET_FILE_AMOUNT | Alphanumeric, uppercase, two decimal places implied, right justified, zero-filled, signed positive or negative 20 145 | 164 | Sum of all the 'NET_BATCH_AMT' | Yes | For US dollar (USD) and Canadian dollar (CAD) transactions, two decimal places are implied. An uppercase alpha code replaces the last digit in the transaction. This code indicates a debit amount. The debit codes and their numeric equivalents are:
| |||||||||||||
| 17 | NET_FILE_ABSOLUTE_AMOUNT | Numeric, right justified, zero filled | 20 165 | 184 | NET_FILE_AMOUNT removing the sign | NET_ACCEPTED_FILE_AMOUNT removing the sign | |||||||||||||
| 18 | PAYMENT_DIRECTION | Alphanumeric, uppercase, left justified, character space filled (if no value) | 1 185 | 185 | -- | Yes | -- | ||||||||||||
| 18 | PAYMENT_DIRECTION | Alphanumeric, uppercase, left justified, character space filled (if no value) | 1 185 | 185 | -- | Yes | Direction in which the 'NET_ACCEPTED_FILE_ABSOLUTE_AMOUNT' is to be paid 1= PayPal to Client 2 = Client to PayPal | ||||||||||||
| 19 | FILLER | 18Alphanumeric | 15 186 | 2000 | Character spaces | Yes | Reserved for PayPal internal use. |