Transaction Reports
Transaction reports provide a record of every transaction processed on the PayNearMe platform. They deliver details about payments made, payments scheduled, and any returned payments that should be un-posted in your system.
Daily Payments Report
The Daily Payments report provides a detailed record of all transactions processed on the PayNearMe platform since the last Daily Payments report was generated. The Daily Payments report’s primary purpose is to provide the data with which you can validate that all transactions for the day have been recorded and accounted for. Use this report to post payments to your consumer account records.
Each record contains:
- Customer Identification: Includes the customer number, name, email, and phone.
- Transaction Details: The unique PayNearMe Payment Identifier, along with the precise date and time of the transaction. The Unique PayNearMe Payment Identifier is the value the client should use to tie a given payment to any potential reversal of that payment at some point in the future, as this value will also be included with each record of the Returned Payments report.
- Fee Breakdown: Financial details, including the total amount paid, any consumer or embedded fees, and the amount that should be posted to the consumer’s loan account.
- Payment Type/Channel: Specifies the origin of the payment, whether it was scheduled vs immediate and the payment method (ACH, debit, cash, PayPal, etc.).
Filename and Extension
- Naming convention: PNM_Daily_Payments_for_MM_DD_YYYY.txt
- Delimited: Pipe
Timing
- Frequency: Daily
- Time of Day: TBD
SFTP Details
- Host: sftp://files.paynearme.com
- Username: shared separately
- Password: shared separately
- Sandbox Path: /reports/sandbox
- Production Path: /reports/production
- Port: 22
File Data Specifications
| Column | Column Headers | Description | Possible Values | Sample Value |
|---|---|---|---|---|
| 0 | CustNum | Unique Client Generated Customer/Loan ID (CustNum in MAM file) | Integer(7-10 digits) | 24973734 |
| 1 | Name | Borrower Name | VARCHAR(255) | Jane Jones |
| 2 | Email | Borrower Email | VARCHAR(255) Valid Email | [email protected] |
| 3 | Phone | Borrower Phone | Integer(10 digits) | 5555551212 |
| 4 | Retailer ZipCode | If cash payment, the ZIP Code of the Retailer location where the payment was made | Integer(5 digits) | 94115 |
| 5 | Order/Auth ID | Unique PayNearMe-generated Consumer Record ID (also referred to as the PayNearMe Order Identifier`) | Integer(13 digits) | 6900197065841 |
| 6 | Payment Date | Date the payment was made | Date(YYYY-MM-DD) | 2023-10-16 |
| 7 | Payment Time | Time the payment was made (Pacific Time) | DateTime(HH:MM:SS Z) | 07:55:27 PDT |
| 8 | Total Amount | Total Payment Amount | Decimal(6,2) | 203.99 |
| 9 | Consumer Fee | Exposed fee paid by the consumer | Decimal(6,2) | 3.99 |
| 10 | Embedded Fee | Embedded Fee paid by Client | Decimal(6,2) | 1.99 |
| 11 | Net Payment | The net payment amount that should be posted to the Consumer’s Loan Account | Decimal(6,2) | 200 |
| 12 | PNM Payment Identifier | Unique Payment/Transaction ID (also referred to as the PayNearMe Transaction Identifier) | Integer(10-12 digits) | 990024173001 |
| 13 | Payment Origin | Identifies the PNM system that triggered the payment. Immediate = cf Scheduled = auto_pay Agent = pnm_now | cf auto_pay pnm_now api retailer | cf |
| 14 | Schedule Duration | The type of Schedule created. Once refers to one-time, future-dated payment. | once weekly biweekly monthly twice_monthly end_of_month paid_in_full due_date_monthly | once |
| 15 | Payment Method | The Payment Type | ach apple_pay cash cash_app credit debit gpay paypal venmo | debit |
| 16 | Branded Payment Method | Branded Payment Type | debit gpay apple_pay ach paypal venmo 7_eleven_cash cvs_cash walmart_cash walgreens_cash dollar_general_cash caseys_cash | paypal |
| 17 | Payment Channel | Indicates the source of the transaction | consumer consumer_recurring consumer_ivr agent agent_recurring agent_waived api | consumer |
| 18 | Schedule Type | If the transaction was scheduled, this indicates whether it was a single, future-dated payment or part of a recurring autopay schedule | scheduled_one_time scheduled_recurring | scheduled_one_time |
| 19 | Agent Name | Name of the Agent who took the Consumer’s payment | VARCHAR(255) | Jane Jones |
| 20 | Agent Email | Email of the Agent who took the Consumer’s payment | VARCHAR(255) Valid Email | [email protected] |
Daily Scheduled Payments Report
The Scheduled Payments report provides a daily bulk reporting of all payment schedules that consumers have created or canceled on our platform since the previous Scheduled Payments report was generated.
Each record contains:
- Customer Information: Includes the customer's account number, name, email, and phone.
- Schedule Details: The current status of the autopay (whether it's Active, Complete or User Suspended/Canceled), its frequency, the upcoming payment date, the amount to be paid, and the payment source. Additionally, the tender type (such as ACH or debit) and the origin of the schedule (e.g., consumer) are included.
Filename and Extension
- Naming convention: PNM_AutoPay_Schedules_for_MM_DD_YYYY.txt
- Delimited: Pipe
Timing
- Frequency: Daily
- Time of Day: TBD
SFTP Details
- Host: sftp://files.paynearme.com
- Username: shared separately
- Password: shared separately
- Sandbox Path: /reports/sandbox
- Production Path: /reports/production
- Port: 22
File Data Specifications
| Column | Column Header | Description | Possible Values | Sample Value |
|---|---|---|---|---|
| 0 | CustNum | Unique Customer Account Number | Integer(7-10 digits) | 9237423 |
| 1 | Customer Name | Borrower Name | VARCHAR(255) | Jane Jones |
| 2 | Autopay Status | Status of the Autopay | active user_suspended pending disabled complete | Active |
| 3 | Autopay Frequency | Frequency of the Autopay | once weekly biweekly monthly twice_monthly end_of_month paid_in_full due_date_monthly | Once |
| 4 | Autopay Next Payment Date | The next payment date for Autopay | Date(YYYY-MM-DD) | 2023-10-20 |
| 5 | Autopay Payment Amount | Amount of the Autopay | Decimal(6,2) | 100 |
| 6 | Autopay Payment Source | Source of the Autopay Payment | VARCHAR(255) | Debit Card 9998 |
| 7 | Tender Type | Payment Tender Type | ach apple_pay credit debit gpay paypal venmo | ach |
| 8 | Origin | Source of AutoPay schedule import = data import merchant = agent | consumer import merchant api | consumer |
| 9 | Autopay Agent Name | Name of the Agent who set up the Autopay | VARCHAR(255) | John Smith |
| 10 | Autopay Agent Email | Email of the Agent who set up the Autopay | VARCHAR(255) Valid Email | [email protected] |
| 11 | Autopay Contact | Contact number associated with the Autopay | Integer(10 digits) | 5555551212 |
| 12 | Autopay Duration Type | Type of duration set for the Autopay | once paid_in_full indefinite number_of_recurrences end_date | once |
| 13 | Autopay Start Date | Starting date of the Autopay | Date(YYYY-MM-DD) | 2023-10-20 |
| 14 | Autopay End Date | Ending date of the Autopay (only recurring). For one-time future dated payments will be blank | Date(YYYY-MM-DD) | 2023-10-20 |
| 15 | Autopay Completed | Number of completed payments in the Autopay | Integer(1-3 digits) | 0 |
| 16 | Autopay Planned | Number of planned payments in the Autopay (only recurring). For one-time future dated payments will be blank | Integer(1-3 digits) | 1 |
| 17 | Created Date | Date the Autopay was created | Date(YYYY-MM-DD) | 2023-10-10 |
| 18 | Canceled Date | Date the Autopay was canceled (if applicable) | Date(YYYY-MM-DD) | 2023-10-10 |
| 19 | Schedule ID | Unique Schedule Identifier | Integer(15 digits) | 971193797205701 |
| 20 | Brand Name | The Brand that is associated with the consumer record and payment | VARCHAR(255) | Brand1 |
Daily AutoPay Results Report
The Daily AutoPay Results report provides the detailed outcomes of all scheduled payments processed for that day. This report solely focuses on payments pre-scheduled for the date the report is generated on and does not include immediate, unscheduled one-time payments. The successful payments will also be included in the Daily Payments report as that file includes ALL successful payments.
Each record contains:
- Customer Identification: Includes the customer number
- Payment Outcome: Denotes payment results, such as "paid", "unpaid", "unusable", etc.
- Transaction Details: The unique PayNearMe Payment Identifier, along with the precise date and time of the transaction. The Unique PayNearMe Payment Identifier is the value you should use to tie a given payment to any potential reversal of that payment at some point in the future, as this value will also be included with each record of the Returned Payments Report.
- Fee Breakdown: Financial details, including the total amount paid, any consumer or embedded fees, and the amount that should be posted to the Consumer’s loan account.
- Payment Type: ACH, debit, credit, Apple Pay, Google Pay
Filename and Extension
- Naming convention: PNM_AutoPay_Results_for_MM_DD_YYYY.txt
- Delimited: Pipe
Timing
- Frequency: Daily
- Time of Day: TBD
SFTP Details
- Host: sftp://files.paynearme.com
- Username: shared separately
- Password: shared separately
- Sandbox Path: /reports/sandbox
- Production Path: /reports/production
- Port: 22
File Data Specifications
| Column | Column Header | Description | Possible Values | Sample Value |
|---|---|---|---|---|
| 0 | CustNum | Unique Customer/Loan ID (CustNum in MAM file) | Integer(7-10 digits) | 24973734 |
| 1 | Schedule ID | Unique Schedule Identifier | Integer(15 digits) | 971193797205701 |
| 2 | Processing Start | The Date and Time the payment was processed | DateTime(YYYY-MM-DD HH:MM:SS Z) | 2020-05-14 07:00:00 PT |
| 3 | Processing State | The outcome of the attempted transaction | paid unpaid unusable unpayable inactive | paid |
| 4 | Payment Decline Reason | The reason the payment was declined (if declined) | VARCHAR(255) | There are insufficient funds on this card to complete this payment (1051) |
| 5 | Next Scheduled Payment Date | The next payment date for Autopay | Date(YYYY-MM-DD) | 2023-10-20 |
| 6 | Schedule Duration | The type of Schedule created. Once refers to a one-time future-dated payment. | once paid_in_full indefinite number_of_recurrences end_date | once |
| 7 | PNM Payment Identifier | Unique Payment/Transaction ID (also referred to as pnm_payment_identifier) | Integer(10-12 digits) | 990024173001 |
| 8 | Payment Date | Date the payment was originally made | Date(YYYY-MM-DD) | 2023-09-23 |
| 9 | Total Payment Amount | Total Payment Amount | 203.99 | |
| 10 | Consumer Fee | Exposed fee paid by the consumer | Decimal(6,2) | 3.99 |
| 11 | Net Customer Payment Amount | The net payment amount that should be posted to the Consumer’s Loan Account | Decimal(6,2) | 200 |
Daily Returned Payments Report
The Returned Payments report contains records of payments that have subsequently been Returned (ACH), Reversed (ACH), Charged-back (Debit/Credit), Canceled, or Refunded. Its primary objective is to trigger the un-posting of payments in your system. This is crucial because either the funds from the original payment will be debited from your bank account, or in instances like canceled transactions where funds haven't settled, the payment will just be nullified. Be aware that the data in this report is simply batched duplicate records of the Reversal notifications you'll receive through the Reverse Callback. This report's primary purpose is to provide data you can use to validate that all reversals for the day have been recorded and accounted for.
Each record contains:
- Transaction Details: The unique PayNearMe Payment Identifier, along with the precise date and time of the original transaction. The Unique PayNearMe Payment Identifier is the value you should use to tie a transaction in this report to the original payment. Along with the amount associated with the returned transaction.
- Return Details: Specifies the type of return (ACH, Debit, Credit), the specific return code (R01-R35), and the current status of the return (Open, Completed, Returned).
Filename and Extension
- Naming convention: PNM_Returned_Payments_for_MM_DD_YYYY.txt
- Delimited: Pipe
Timing
- Frequency: Daily
- Time of Day: TBD
SFTP Details:
- Host: sftp://files.paynearme.com
- Username: shared separately
- Password: shared separately
- Sandbox Path: /reports/sandbox
- Production Path: /reports/production
- Port: 22
File Data Specifications
| Column | Column Header | Description | Possible Values | Sample Value |
|---|---|---|---|---|
| 0 | CustNum | Unique Customer Account Number | Integer(7-10 digits) | 9237423 |
| 1 | Payment Date | Date the payment was originally made | Date(YYYY-MM-DD) | 2023-09-23 |
| 2 | Payment Time | Time the payment was originally made (Pacific Time) | DateTime(HH:MM:SS Z) | 13:53:08 PDT |
| 3 | PNM Payment Identifier | Unique Payment/Transaction ID (also referred to as PNM Transaction Identifier) | Integer(10-12 digits) | 990024173001 |
| 4 | Payment Amount | Amount associated with the returned transaction. Should match amount of initial payment unless partial refunds are enabled | Decimal(6,2) | 125.99 |
| 5 | Return Type | Original Generic Payment Type | ACH Debit Credit | ACH |
| 6 | Return Date | Date when the reversal action took place | Date(YYYY-MM-DD) | 2023-10-16 |
| 7 | Return Code | Specific return code indicating the reason for return | Canceled Chargeback Refunded R01-R35 | Returned |
| 8 | Return Status | Current status of the return | Open Completed Returned | Returned |
| 9 | Brand Name | The Brand that is associated with the consumer record and payment | VARCHAR(255) | Brand1 |
| 10 | Agent Name | The Name of the Agent that refunded or canceled the payment | VARCHAR(255) | Jane Jones |
| 11 | Agent Email | The Email Address of the Agent that refunded or canceled the payment | VARCHAR(255) Valid Email | [email protected] |