Bulk File Uploads: Consumer/Loan Data Files
Inbound MAM File (from Client to PayNearMe)
The purpose of this file is for the client to provide PayNearMe with consumer/loan data and to trigger the results file which will return the PayNearMe Smart Link for each record. The Smart Link is a unique URL assigned to each consumer record/loan, which routes consumers directly to the PayNearMe Consumer Portal and allows them to make or schedule payments. With the consumer contact data, PayNearMe will provide consumer communications including payment and schedule notifications. PayNearMe will also use various consumer data-related flags to control loan payability, allowed payment types, and customized business rule logic.
For each client, PayNearMe creates a template for the client's Master Account Management (MAM) file to ensure all consumer and order data is properly ingested, parsed, and recorded into the platform. Since every client has unique business, consumer, and data requirements, this file can be customized and tailored for your specific use case and business vertical.
Filename and Extension
- Naming convention: PNM_consumer_export_MMDDYYYY.txt
- Format: CSV
- Delimited: Comma or Pipe
Timing
- Frequency: Daily
- Time of Day: TBD
SFTP Details
- Host: sftp://files.paynearme.com
- Username: shared separately
- Password: shared separately
- Sandbox Path: /orders/sandbox/dropbox
- Production Path: /orders/prod/dropbox
- Port: 22
File Data Specifications
The following table displays the file format for your MAM file. Use this as a starter template when planning the information you'd like to include for your integration.
| Row | Column Header | Description | Sample Value | Possible Values |
|---|---|---|---|---|
| 0 | account_number | A unique ID that identifies the order or the consumer. | Integer(7-10 digits) | 123456789 |
| 1 | first_name | The consumer's first name. | VARCHAR(255) | Peppa |
| 2 | last_name | The consumer's last name. | VARCHAR(255) | Pigg |
| 3 | addr1 | The first line of the consumer's billing address. | VARCHAR(255) | 3 Astley Street |
| 4 | addr2 | If necessary, the second line of the consumer's billing address. | VARCHAR(255) | APT 2 |
| 5 | city | The city of the consumer's billing address. | VARCHAR(255) | Peppatown |
| 6 | state | The state of the consumer's billing address. | VARCHAR(2) | CA |
| 7 | postal_code | The ZIP code of the consumer's billing address. | Integer(5 digits) | 94115 |
| 8 | mobile_phone | The consumer's mobile phone number. | Integer(10 digits) | 5555551212 |
| 9 | email | The consumer's email address. | Integer(10 digits) | [email protected] |
| 10 | past_due_amount | The past due amount owed by the consumer | Decimal(6,2) | 100.50 |
| 11 | past_due_date | The date when the account became past due. | Date(YYYY-MM-DD) | 2024-06-05 |
| 12 | current_payment_amount | The current amount owed by the consumer. | Decimal(6,2) | 100.50 |
| 13 | payment_due_date | The date when the current payment is due. | Date(YYYY-MM-DD) | 2024-07-05 |
| 14 | total_account_balance | The total remaining balance on the account. | Decimal(6,2) | 1500.50 |
The fields listed above are not a comprehensive listing of all the fields that you can include in your MAM file; rather they are merely a listing of generic data that you may want to include. Furthermore, the column header names can be customized to your format and naming conventions. Your PayNearMe Implementation Specialist will map your unique MAM file to the PayNearMe platform so that the consumer experience is seamless and personalized.
Below is an example MAM file specification that was created for an auto lending client.
Column | Column Header | Description | Possible Values | Sample Value |
|---|---|---|---|---|
0 |
| Unique Client Generated Customer/Loan ID | Integer(7-10 digits) |
|
1 |
| Regular Payment Amount | Decimal(6,2) |
|
2 |
| Payoff date | Date(YYYY-MM-DD) |
|
3 |
| Late Fee amount | Decimal(6,2) |
|
4 |
| Payoff amount | Decimal(6,2) |
|
5 |
| Past due amount | Decimal(6,2) |
|
6 |
| Total current amount due | Decimal(6,2) |
|
7 |
| Current due date. If the loan is current, | Date(YYYY-MM-DD) |
|
8 |
| Previous due date. If populated, this loan is past due. If the loan is current, it will not be populated. | Date(YYYY-MM-DD) |
|
9 |
| Due date from two periods ago. If populated, indicates the loan has missed two due dates. If loan is current, it will not be populated. | Date(YYYY-MM-DD) |
|
10 |
| Due date from three periods ago. If populated, indicates the loan has missed three due dates. If loan is current, it will not be populated. | Date(YYYY-MM-DD) |
|
11 |
| Days Past Due | Integer(1-4 digits) |
|
12 |
| Borrower Last Name | VARCHAR(255) |
|
13 |
| Borrower First Name | VARCHAR(255) |
|
14 |
| Borrower Middle Name | VARCHAR(255) |
|
15 |
| Maximum days in the future a payment can be posted. | Date(YYYY-MM-DD) |
|
16 |
| Minimum Transaction Amount | Decimal(6,2) |
|
17 |
| Borrower Street Address | VARCHAR(255) |
|
18 |
| Borrower Street Address Extended | VARCHAR(255) |
|
19 |
| Borrower City | VARCHAR(255) |
|
20 |
| Borrower State | VARCHAR(2) |
|
21 |
| Borrower Zip | Integer(5 or 9 digits) |
|
22 |
| Borrower Email | VARCHAR(255) Valid Email | |
23 |
| Borrower Mobile Phone | Integer(10 digits) |
|
24 |
| Second parameter for maximum days in the future a payment can be posted. May be used in business rule. | Date(YYYY-MM-DD) |
|
25 |
| Represents different portfolio segments. Drives customer to different site configurations. | Integer(2 digits) |
|
26 |
| Indicates vehicle has been repossessed and sold. |
|
|
27 |
| Current Loan Payoff Amount | Decimal(6,2) |
|
28 |
| Vehicle Identification Number | VARCHAR(255) |
|
29 |
| State where the Loan originated | VARCHAR(2) |
|
30 |
| Allowed Payment Types (comma separated list. If all allowed, can provide complete list or just ‘any’ |
|
|
31 |
| Description of the Vehicle | VARCHAR(255) |
|
32 |
| Flag representing whether a consumer is eligible for setting up recurring payments |
|
|
33 |
| Brand Name associated with the Loan | VARCHAR(255) |
|
34 |
| Specifies Direct Loan or Indirect Loan |
|
|
35 |
| Determines whether a loan is payable or not. A |
|
|
36 |
| Determines whether we charge fees to the consumer or not. |
|
|
37 |
| Consumer’s Year of Birth | Integer(4 digits) |
|
38 |
| Consumer’s Preferred Language |
|
|
39 |
| User Defined Field 1 | VARCHAR(255) | |
40 |
| User Defined Field 2 | VARCHAR(255) | |
41 |
| User Defined Field 3 | VARCHAR(255) |
Outbound MAM File (From PayNearMe to Client)
This file serves as a response from the PayNearMe system to the client after processing the provided Consumer/Loan data. It contains the validated inbound data for each consumer record that was ingested, along with the generated Smart Link for each record. For details regarding the purpose of the Smart Link, please refer back to the Inbound MAM file description.
Filename and Extension
Naming ConventionsThe XX referenced at the end of filename is a random integer between 0 and 99, so you’ll receive a value that is either one or two digits in that space.
- Naming convention: PNM_consumer_export_MMDDYYYY_YYYYMMDD_HHMMSS_XX.txt
- Format: CSV
- Delimited: Comma or Pipe
Timing
- Frequency: Daily
- Time of Day: Delivered immediately after the Inbound MAM file has completed processing.
SFTP Details
- Host: sftp://files.paynearme.com
- Username: shared separately
- Password: shared separately
- Sandbox Path: /orders/sandbox/results
- Production Path: /orders/prod/results
- Port: 22
File Data Specifications
Column | Column Header | Description | Possible Values | Sample Value |
|---|---|---|---|---|
0 |
| Unique Client-Generated Customer/Loan ID | Integer(7-10 digits) |
|
1 |
| Borrower Zip | Integer(5 digits) |
|
2 |
| Borrower Email | VARCHAR(255) Valid Email | |
3 |
| Borrower Mobile Phone | Integer(10 digits) |
|
4 |
| Unique SmartLink URL Sandbox: Prod: | VARCHAR(24) |
|
5 |
| Indicates the current status of the record after being processed. |
|
|
6 |
| Contains validation or processing errors associated with the record that cause the record to be skipped | VARCHAR(255) |
|
7 |
| Contains data validation errors associated with the record that caused the | VARCHAR(255) |
|
Like the inbound MAM file, this file can also be customized to include data relevant to your records and business processes. Your PayNearMe Implementation Specialist can help build and format a return file that can be seamlessly incorporated into your account processing procedures.
File Not Processed (Fails Entirely)
The file will not be processed if the first record has too few columns. Naturally, this implies that if the entire file has too few columns, it will also fail.
status|errors
error|"Template index (Date: 9) > number of columns (7) ""validation"""Errors (Record Skipped)
- Duplicate Record in file -
cannot change order created in same file - Too many columns -
row X too many columns (truncated to match header columns: 10 row columns: 13) - Too few columns (apart from first row) -
row X too few columns (padded to match header columns: 10 row columns: 7) - Missing Customer Number -
order key cannot be null - Bad encoding in Customer Number -
unable to parse order_key
Warnings (Record Stored, Invalid Data Ignored)
- Invalid Phone Number -
site_customer_phone must be ten digits - Invalid Email -
site_customer_email isn’t correct format - Invalid 2-Character State -
site_customer_fixed_state isn’t correct format - Invalid Postal Code -
site_customer_postal_code isn't correct format
Updated about 1 month ago
