Standard Data Fields

Modified on Wed, 03 Jan 2024 at 10:45 AM

Standard Fields

The fields below are used for CSV Imports and Data Mappings

Name

Type

Description

UniqueID (required)

String

A unique identifier for each account. Sometimes called the Reference Number or account number. This should never change.

AllowConsumerToAccess

Bool

Allows the consumer to view the account information. If this is set to true a user sees their account information. When set to false, some of their information will show up as “unavailable” and they will not be able to make payment. This can be used to disable access to a single account without removing it.

PrimaryAccountName (required)

String

Complete name of primary account holder

PrimaryFirstName (required)

String

First name of the primary account holder

PrimaryLastName (required)

String

Last name of the primary account holder

Address

String

Address of account holder

City

String

City of account holder

State

String

State of account holder

Zip

String

Zip code of account holder

String

The email address for the account holder

SSN

String

Social security number (or the last 4 of the SSN)

DOB

Date

Date of birth

AssignedBalance

Decimal

The beginning balance when the account was assigned

AssignedDate

Date

The date the account was assigned

CurrentBalance

Decimal

The current balance on the account

CanMakePayment

Bool

Set to True if consumers can access the payment portal and make payments online thru Quick Pay and registered account access. False, if they cannot access the portal By default, they will be prevented from making a payment thru Quick Pay or registered account, if the balance is zero. However, you can prevent payments for other reasons (i.e. Complaint, Settlement, already scheduled payments).

AcceptCheckingPayment

Bool

True if single ACH Payments are allowed. False otherwise.

AcceptCreditCardPayment

Bool

True if credit cards will be accepted for this account, false otherwise.

AcceptDebitCardPayment

Bool

True if debit cards will be accepted for this account, false otherwise. (bin detection component required)

AcceptRecurringCheckingPayment

Bool

True if recurring checking account (ACH) payments are allowed

AcceptRecurringCreditCard

Bool

True if recurring credit card payments are allowed (must be supported by your gateway)

AcceptRecurringDebitCard

Bool

True if recurring debit card payments are allowed (must be supported by your gateway)

SettlementOffered

Bool

True if a settlement was offered on this account, false otherwise

SettlementAmount

Decimal

The amount of the settlement that was offered on this account.

MaxSettlementPayments

integer

The maximum number of payments allowed for a settlement on this account.

MaxSettlementDate

Date

The last date a payment can be schedule to complete a settlement arrangement.

MinimumSinglePayment

Decimal

When specified, this will be the minimum amount that a user can make for a single payment. Minimums do not apply to settlements.

MinimumRecurringPayment

Decimal

When specified, this will be the minimum amount that a user can make for a recurring payment. For example, if you want all consumers to pay off balances in 12 months max, you could set the minimum recurring payment to 1/12th of the current balance. Minimums do not apply to settlements.

ClientID

String

A unique client ID used to identify the client in the integrated system

InternalStatus

String

The status of the account. This is an internal status and will NOT be shown to the user.

StatusOfAccount

String

The status of the account that can be displayed to the user. If not specified this will not be shown. This is visible to the user. Do NOT use internal statuses.

OriginalAccountNumber

String

The account number that was originally assigned to the account.

OriginalCreditor

String

The name of the original creditor

ClientName

String

The name of the client.

CollectorNameShort

String

The name of the collector assigned to this account. This is a shorter name used if you want to abbreviate or use a desk.

CollectorNameLong

String

The name of the collector assigned to this account.

CollectorPhone

String

The phone number to reach the collector.

CustomAccountFields

Other

PaymentAmt1-
PaymentAmt100

Decimal

Amount of the payment (see payment fields)

PaymentDate1-
PaymentntDate100

Date

Date of the payment (see payment fields)

PaymentDesc1-

PaymentDesc100

String

Description of the payment (max 50 characters) (see payment fields)

PostDateAmt1-

PostDateAmt100

Decimal

Amount of the postdate (see postdate fields)

PostDateDate1-

PostDateDate100

Date

Date of the postdate (see postdate fields)

PostDateDesc1-

PostDateDesc100

String

Description of the postdate (max 50 characters) (see postdate fields)

SettlementACHAllowed

Bool

Allow ACH for Settlements. Only applicable when there is a settlement offer. This field may be null. This field is unlike standard boolean fields as it will not default to false if left null. Instead, it will use the system default setting.

SettlementCreditCardAllowed

Bool

Allow Credit Cards for Settlements. Only applicable when there is a settlement offer. This field may be null. This field is unlike standard boolean fields as it will not default to false if left null. Instead, it will use the system default setting.

SettlementDebitCardAllowed

Bool

Allow Debit Cards for Settlements. Only applicable when there is a settlement offer. This field may be null. This field is unlike standard boolean fields as it will not default to false if left null. Instead, it will use the system default setting.

*CellPhone

This field can be used for texting features.

NOTE: this field is formatted as a custom field and has the asterisk prefix. It is essentially a "reserved" custom field that is treated as a regular field. There are internal/backwards compatibility reasons why this field is named differently.

Accepted formats are:

9999999999
or
999-999-9999

PacketLink

Used to link account together. If multiple accounts should be linked together so that a single user can see multiple accounts, set this value to the same value for each of the accounts. Linking must also be enabled in your system. For example if account 111, 222, and 333 are all the same person and you want them to show up together, you can create a unique PacketLink and assign it to all of them. One strategy is to just use one the the existing account numbers as the field. The link field is never show to the user so you can use anything you want. Here is one example:

*Unique ID*	*PacketLink*
111	111
222	111
333	111

Using this approach you are using one of the account numbers to link it to the others. So if the user creates their account and their info matches account 222, it will see that 222 has a PacketLink value of 111 which will the cause it to add all other accounts with the PacketLink of 111.