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.

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

ColumnColumn HeadersDescriptionPossible ValuesSample Value
0CustNumUnique Client Generated Customer/Loan ID (CustNum in MAM file)Integer(7-10 digits)24973734
1NameBorrower NameVARCHAR(255)Jane Jones
2EmailBorrower EmailVARCHAR(255)
Valid Email
[email protected]
3PhoneBorrower PhoneInteger(10 digits)5555551212
4Retailer ZipCodeIf cash payment, the ZIP Code of the Retailer location where the payment was madeInteger(5 digits)94115
5Order/Auth IDUnique PayNearMe-generated Consumer Record ID (also referred to as the PayNearMe Order Identifier`)Integer(13 digits)6900197065841
6Payment DateDate the payment was madeDate(YYYY-MM-DD)2023-10-16
7Payment TimeTime the payment was made (Pacific Time)DateTime(HH:MM:SS Z)07:55:27 PDT
8Total AmountTotal Payment AmountDecimal(6,2)203.99
9Consumer FeeExposed fee paid by the consumerDecimal(6,2)3.99
10Embedded FeeEmbedded Fee paid by ClientDecimal(6,2)1.99
11Net PaymentThe net payment amount that should be posted to the Consumer’s Loan AccountDecimal(6,2)200
12PNM Payment IdentifierUnique Payment/Transaction ID (also referred to as the PayNearMe Transaction Identifier)Integer(10-12 digits)990024173001
13Payment OriginIdentifies the PNM system that triggered the payment.
Immediate = cf
Scheduled = auto_pay
Agent = pnm_now
cf
auto_pay
pnm_now
api
retailer
cf
14Schedule DurationThe 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
15Payment MethodThe Payment Typeach
apple_pay
cash
cash_app
credit
debit
gpay
paypal
pin4
venmo
debit
16Branded Payment MethodBranded Payment Typedebit
gpay
apple_pay
ach
paypal
venmo
7_eleven_cash
cvs_cash
walmart_cash
walgreens_cash
dollar_general_cash
caseys_cash
paypal
17Payment ChannelIndicates the source of the transactionconsumer
consumer_recurring
consumer_ivr
agent
agent_recurring
agent_waived
api
consumer
18Schedule TypeIf the transaction was scheduled, this indicates whether it was a single, future-dated payment or part of a recurring autopay schedulescheduled_one_time
scheduled_recurring
scheduled_one_time
19Agent NameName of the Agent who took the Consumer’s paymentVARCHAR(255)Jane Jones
20Agent EmailEmail of the Agent who took the Consumer’s payment VARCHAR(255)
Valid Email
[email protected]
21Payer TypePayer Type collected from a dropdown on the ‘Make Payment’ screen in Consumer Portal.borrower
coborrower
thirdparty
borrower
22Payer NamePayer Name collected from field on the ‘Make Payment’ screen in Consumer Portal.VARCHAR(255)Jane Jones
23Brand NameThe Brand that is associated with the consumer record and paymentVARCHAR(255)Brand1
24Loan Origination StateThe State the Loan originated inVARCHAR(2)CA
25Direct IndicatorSpecifies Direct Loan or Indirect LoanD
I
D
26SmartLink SourceA Client generated value used to identify the source of a given Smart Link that is sent to or rendered to a ConsumerVARCHAR(32)web

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

ColumnColumn HeaderDescriptionPossible ValuesSample Value
0CustNumUnique Customer Account NumberInteger(7-10 digits)9237423
1Customer NameBorrower NameVARCHAR(255)Jane Jones
2Autopay StatusStatus of the Autopayactive
user_suspended
pending disabled
complete
Active
3Autopay FrequencyFrequency of the Autopayonce
weekly
biweekly
monthly
twice_monthly
end_of_month
paid_in_full
due_date_monthly
Once
4Autopay Next Payment DateThe next payment date for AutopayDate(YYYY-MM-DD)2023-10-20
5Autopay Payment AmountAmount of the AutopayDecimal(6,2)100
6Autopay Payment SourceSource of the Autopay PaymentVARCHAR(255)Debit Card 9998
7Tender TypePayment Tender Typeach
apple_pay
credit
debit
gpay
paypal
venmo
ach
8OriginSource of AutoPay schedule
import = data import
merchant = agent
consumer
import
merchant
api
consumer
9Autopay Agent NameName of the Agent who set up the AutopayVARCHAR(255)John Smith
10Autopay Agent EmailEmail of the Agent who set up the AutopayVARCHAR(255)
Valid Email
[email protected]
11Autopay ContactContact number associated with the AutopayInteger(10 digits)5555551212
12Autopay Duration TypeType of duration set for the Autopayonce
paid_in_full
indefinite
number_of_recurrences end_date
once
13Autopay Start DateStarting date of the AutopayDate(YYYY-MM-DD)2023-10-20
14Autopay End DateEnding date of the Autopay (only recurring). For one-time future dated payments will be blankDate(YYYY-MM-DD)2023-10-20
15Autopay CompletedNumber of completed payments in the AutopayInteger(1-3 digits)0
16Autopay PlannedNumber of planned payments in the Autopay (only recurring). For one-time future dated payments will be blankInteger(1-3 digits)1
17Created DateDate the Autopay was createdDate(YYYY-MM-DD)2023-10-10
18Canceled DateDate the Autopay was canceled (if applicable)Date(YYYY-MM-DD)2023-10-10
19Schedule IDUnique Schedule IdentifierInteger(15 digits)971193797205701
20Brand NameThe Brand that is associated with the consumer record and paymentVARCHAR(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

ColumnColumn HeaderDescriptionPossible ValuesSample Value
0CustNumUnique Customer/Loan ID (CustNum in MAM file)Integer(7-10 digits)24973734
1Schedule IDUnique Schedule IdentifierInteger(15 digits)971193797205701
2Processing StartThe Date and Time the payment was processedDateTime(YYYY-MM-DD HH:MM:SS Z)2020-05-14 07:00:00 PT
3Processing StateThe outcome of the attempted transactionpaid
unpaid
unusable
unpayable
inactive
paid
4Payment Decline ReasonThe reason the payment was declined (if declined)VARCHAR(255)There are insufficient funds on this card to complete this payment (1051)
5Next Scheduled Payment DateThe next payment date for AutopayDate(YYYY-MM-DD)2023-10-20
6Schedule DurationThe type of Schedule created. Once refers to a one-time future-dated payment.once
paid_in_full
indefinite
number_of_recurrences end_date
once
7PNM Payment IdentifierUnique Payment/Transaction ID (also referred to as pnm_payment_identifier)Integer(10-12 digits)990024173001
8Payment DateDate the payment was originally madeDate(YYYY-MM-DD)2023-09-23
9Total Payment AmountTotal Payment Amount203.99
10Consumer FeeExposed fee paid by the consumerDecimal(6,2)3.99
11Net Customer Payment AmountThe net payment amount that should be posted to the Consumer’s Loan AccountDecimal(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

ColumnColumn HeaderDescriptionPossible ValuesSample Value
0CustNumUnique Customer Account NumberInteger(7-10 digits)9237423
1Payment DateDate the payment was originally madeDate(YYYY-MM-DD)2023-09-23
2Payment TimeTime the payment was originally made (Pacific Time)DateTime(HH:MM:SS Z)13:53:08 PDT
3PNM Payment IdentifierUnique Payment/Transaction ID (also referred to as PNM Transaction Identifier)Integer(10-12 digits)990024173001
4Payment AmountAmount associated with the returned transaction. Should match amount of initial payment unless partial refunds are enabledDecimal(6,2)125.99
5Return TypeOriginal Generic Payment TypeACH
Debit
Credit
ACH
6Return DateDate when the reversal action took placeDate(YYYY-MM-DD)2023-10-16
7Return CodeSpecific return code indicating the reason for returnCanceled
Chargeback
Refunded
R01-R35
Returned
8Return StatusCurrent status of the returnOpen
Completed
Returned
Returned
9Brand NameThe Brand that is associated with the consumer record and paymentVARCHAR(255)Brand1
10Agent NameThe Name of the Agent that refunded or canceled the paymentVARCHAR(255)Jane Jones
11Agent EmailThe Email Address of the Agent that refunded or canceled the paymentVARCHAR(255)
Valid Email
[email protected]