Customer Upload
Uploading Accounts
You can create new customers and accounts, and you can update existing customers and accounts via Account Upload. We strongly advise you to aggregate multiple accounts by customer. This provides your customers with concise communications and consolidated payment options drastically improving your collections performance.
:::tip To get started, download a sample file with the following customers.
John has one account
Olivia has two accounts :::
:::info Filename convention: YYYY-MM-DD-hh-mm-ss.csv :::
AccountRef *
String, unique constraint
Unique value representing the account in your system. Use the same reference for updating existing accounts.
StatementOfWorkID *
String
The Statement of Work to assign this account to. Once assigned, this value cannot be changed.
DueDate *
String date formatted as YYYY-MM-DD
Date when the account was due for payment. This is used for allocating payments to the account with the oldest due date.
ChargeOffDate
String date formatted as YYYY-MM-DD
Date when the account was charged off
DateOfLastPaymentReceived ⚠️
String date formatted as YYYY-MM-DD
Date when the last payment received from customer was processed. Can be blank if not applied. ⚠️ This date must be before referral time
Balance ⚠️
Integer representing a monetary value in cents, e.g. 100 means $1.00
The amount to collect for this account. ⚠️ This value must be greater than zero when creating new accounts and it will be ignored when updating existing accounts. For updating this value, see Transaction Upload.
CustomerRef *
String, unique constraint, cannot contain any PII
Unique value representing the customer in your system. Use the same reference for updating existing customers.
Title
Constant, e.g. Mx
Customer's title. See all Customer Titles below. Invalid values will be ignored so the customer and account are still created successfully, provided all other validations succeed.
FirstName *
String
When the customer has a last name, their last name is required for regulatory compliance.
MiddleName
String
When the customer has a last name, their last name is required for regulatory compliance.
LastName
String
When the customer has a last name, their last name is required for regulatory compliance.
DOB
String data formatted as YYYY-MM-DD
Emails
String delimited by semicolon, e.g. [email protected]; [email protected]
For regulatory compliance, at least two of the following must be provided: date of birth, email, phone, address. Further, invalid values will be ignored so the customer and account are still created successfully, provided all other validations succeed.
Phones
String delimited by semicolon, including country code, e.g. +61444555666; +61999888777
For regulatory compliance, at least two of the following must be provided: date of birth, email, phone, address. Further, invalid values will be ignored so the customer and account are still created successfully, provided all other validations succeed.
AddressLine1
String, required when any address field is provided
For regulatory compliance, at least two of the following must be provided: date of birth, email, phone, address. Further, invalid values will be ignored so the customer and account are still created successfully, provided all other validations succeed.
AddressLine2
String, optional
For regulatory compliance, at least two of the following must be provided: date of birth, email, phone, address. Further, invalid values will be ignored so the customer and account are still created successfully, provided all other validations succeed.
City
String, required when any address field is provided
For regulatory compliance, at least two of the following must be provided: date of birth, email, phone, address. Further, invalid values will be ignored so the customer and account are still created successfully, provided all other validations succeed.
State
String, required when any address field is provided, except for the United Kingdom and New Zealand
For regulatory compliance, at least two of the following must be provided: date of birth, email, phone, address. Further, invalid values will be ignored so the customer and account are still created successfully, provided all other validations succeed.
Postcode
String, required when any address field is provided
For regulatory compliance, at least two of the following must be provided: date of birth, email, phone, address. Further, invalid values will be ignored so the customer and account are still created successfully, provided all other validations succeed.
Country
String, required when any address field is provided
For regulatory compliance, at least two of the following must be provided: date of birth, email, phone, address. Further, invalid values will be ignored so the customer and account are still created successfully, provided all other validations succeed.
Balance Breakdown
If you charge interest or fees, we recommend you to provide your customers with the following breakdown which helps avoiding disputes. The total amount should add up to the account Balance.
Download a sample file with Balance Breakdown.
BalancePrincipal
Integer representing a monetary value in cents, e.g. 100 means $1.00
The principal amount owed as of referral time. This value cannot be changed.
BalanceInterest
Integer representing a monetary value in cents, e.g. 100 means $1.00
The amount accrued in interest as of referral time. This value cannot be changed.
BalanceFees
Integer representing a monetary value in cents, e.g. 100 means $1.00
The amount accrued in fees as of referral time. This value cannot be changed.
Itemization
If you operate in a jurisdiction that requires a Notification of Assignment to be sent, the following fields are mandatory:
ItemizationDate
String date formatted as YYYY-MM-DD
The date on which the account was itemized. This value cannot be changed.
ItemizationDateBalance
Integer representing a monetary value in cents, e.g. 100 means $1.00
The balance of the account as at the time of itemization. This value cannot be changed.
ItemizationDateType
String
The type/description of the date on which the account was itemized. This can be one of the following values: charge_off_date, last_payment_date, last_statement_date, transaction_date or judgment_date. This value cannot be changed.
ItemizationCreditorName
String
The name of the creditor of the account at the time of itemization. This value cannot be changed.
FeesSinceItemization
Integer representing a monetary value in cents, e.g. 100 means $1.00
The amount accrued in fees between the itemization date and time of referral. This value cannot be changed.
InterestSinceItemization
Integer representing a monetary value in cents, e.g. 100 means $1.00
The amount accrued in interest between the itemization date and time of referral. This value cannot be changed.
PaymentsAndCreditsSinceItemization
Integer representing a monetary value in cents, e.g. 100 means $1.00
The amount accrued in payments and credits between the itemization date and time of referral. This value cannot be changed.
Product Information
This information may be used for different use cases like BNPL Merchants, Credit Card and Loan Labels. This helps your customers remember their purchase or agreement which in turn improves your collections performance.
Download a sample file with Product Information.
ProductVendor
String
Name of the product vendor such as the BNPL Merchant.
ProductName
String
Name of the product or service such as the good purchased with BNPL or a white label for the Loan or Credit Card.
ProductAmount
Integer representing a monetary value in cents, e.g. 100 means $1.00
The purchase or service amount agreed upon.
ProductAgreementDate
String date formatted as YYYY-MM-DD
Date when the purchase or service agreement has taken place.
Client Display Name
If your company operates under multiple brands or branches and each customer is familiar with a different name, you can customise the name to be displayed for each customer which helps setting up the context for collections.
Download a sample file with Client Display Name.
ClientDisplayName
String
Your brand or branch name to be used in all communications as a replacement for your company name, specifically for this customer.
Originating Creditor
If you are a Debt Buyer, we strongly recommend you to provide the following information. This helps avoiding disputes by providing your customers with context on the originating creditor and account number. , Download a sample file with Originating Creditor.
OriginatingCreditorLegalName
String
The name of the creditor in which you have purchased the account from.
OriginatingCreditorAccountRef
String
Unique value representing the account within the scope of the originating creditor.
Customer Titles
Dr
Madam
Master
Miss
Mr
Mrs
Ms
Mx
Preferred Language
This is a feature designed to provide language preferences for users within the United States. The PreferredLanguage field allows users to specify their preferred language for communication within the United States.
This feature supports two languages: English US and Spanish US.
Supported Countries The preferred language feature is available only for clients within the United States.
Language Options This feature supports two languages:
English US must be indicated as
en-USSpanish US must be indicated as
es-US
Account Creation The PreferredLanguage field can be set during the initial account upload process. You can indicate a customer's preferred language by providing one of the following values:
PreferredLanguage
String
The PreferredLanguage is an optional field, if not provided during account creation the default language will be set to English US.
Scenario-Based Behaviours
Accounts uploaded without specifying the
PreferredLanguageattribute will default to English (United States).If the
PreferredLanguageattribute is included but left empty, the system will default to English (United States).Specifying
en-USas thePreferredLanguagesets the language to English (United States).Specifying
es-USas thePreferredLanguagesets the language to Spanish (United States).If a value like
en-CAis provided, an error will be flagged during the upload with the message:locale is not supported: invalid-language.After account upload is complete, the
PreferredLanguageattribute cannot be updated.
Last updated
Was this helpful?