Accounts
Overview
An account represents a financial relationship that can be associated with either a business or a person. Accounts are central to transaction processing, balance tracking, and product lifecycle management across our infrastructure.
This section includes the required fields for account records. Each account is uniquely identified and includes attributes that support financial operations, compliance, and reporting.
Account data includes:
- Unique identifiers for the account, business, and optionally a person
- Account category and product type (e.g., deposit or commercial card)
- Open and close dates for lifecycle tracking
- Account status and current balance
- Balance sign to indicate debit or credit position
- Platform information for third-party resellers (if applicable)
These fields ensure that each account is accurately recorded, categorized, and maintained, enabling seamless integration with related entities such as Business, Person, and Card.
Field Definitions
FIELDS | REQUIRED | DESCRIPTION | CHARACTER LENGTH | EXAMPLE |
|---|---|---|---|---|
ACCOUNT NUMBER | Y | The account number that is tied to the account. | 20 | CUST123456 |
ACCOUNT CATEGORY | Y | Please enter a hardcoded value: 'D' for Deposit. | 1 | D |
BUSINESS ID | Y | Unique ID identifying a business. | 20 | BUS123456 |
PERSON ID | N | Unique ID identifying a PERSON. | 20 | PER551015 |
PRODUCT TYPE | Y | The type of product associated with the account. This is hardcoded value, which we will provide to you. | 40 | End User Deposit Account |
ACCOUNT OPEN DATE | Y | Account Open Date | Date(YYYYMMDD) | 20230101 |
ACCOUNT CLOSED DATE | N | Account Closed Date. | Date(YYYYMMDD) | 20230101 |
ACCOUNT STATUS | Y | Acceptable values are: | 25 | Open |
ACCOUNT BALANCE | Y | Account balance | Decimal(10, 2) | 1500.75 |
ACCOUNT BALANCE SIGN | Y | Indicates whether the settled balance is a negative (-) or positive (+). | 1 | |
PLATFORM | N | In most cases you will not need this field. The field is required if there is another third-party company that is reselling your product, otherwise leave it blank. | 40 | PayAFriend |
Updated 7 days ago