Data Requirements
The data that the client should expose to Personetics
The input data needs include the following fields, see below fields and their description.
- The required data type can be found in the second column.
- Each field relevant account types can be found in the fourth column.
- The indication rather each field is mandatory can be found on the fifth column.
| Attribute | Data Type | Description | Relevant Account Type | Mandatory |
|---|---|---|---|---|
| id (customer) | string | System unique constant customer ID | All | Yes, only if User-Input is in the project's scope. |
| id (account) | string | Should relate to ID field in "Account" table | All | Yes, only if User-Input is in the project's scope. |
| type (account) | ENUM (see bellow) | The account type - according to the Personetics vocabulary | All | Yes |
| id | string | System unique and constant key to identify the transaction | All | Yes |
| amount | decimal | The transaction absolute amount in the account currency | All | Yes |
| description | string | The transaction description as it is displayed to the user in the bank's digital channels. Should include details about the source/recipient of the transaction | All | Yes |
| direction | ENUM (See below) | The transaction direction according to the Personetics vocabulary: C = Credit, D = Debit | All | Yes |
| MCC | string | The universal Merchant Category Code | All | Yes Non-mandatory cases: - Open banking data - Debit card transactions |
| transactionDate | date (YYYY-MM-DD) | The transaction date as it is displayed to the user in the bank's digital channels | All | Yes |
| type | ENUM (See below) | The type of the transaction - according to the Personetics vocabulary | All | Yes Non-mandatory cases: - Open banking data |
| typeOriginal | string | The type of the transaction - according to the bank's original vocabulary | All | Yes Non-mandatory cases: - Open banking data |
| subTypeOriginal | string | The subtype of the transaction - according to the bank's original vocabulary | All | Yes Non-mandatory cases: - Open banking data |
| status | ENUM (See below) | The transaction status - according to the Personetics vocabulary | All | No |
| transferSubType | ENUM (See below) | The sub type of the transfer - according to the Personetics vocabulary | All | No |
| feeSubType | ENUM (See below) | The sub type of the fee - according to the Personetics vocabulary | All | No |
| investmentSubType | ENUM (See below) | The sub type of the investment transaction - according to the Personetics vocabulary | Investment | No |
| counterPartyName | string | The clean merchant or counterparty name, without any details unique to the specific transaction (no prefix or suffix, no date or time, no confirmation method or serial number, no amounts, no currency, or currency conversion details, etc.). This field is displayed to the user in some of Personetics' products. | All | No |
| ISOCurrencyCode | string | Transaction charge currency code (ISO code) - should be the same as the related account currency code | All | No |
| runningBalance | decimal | The balance of the account after the specific transaction was deducted | Checking, Savings, Credit | No |
| isReversal | boolean (0/1/NULL) | Indication if the transaction represents a reversal of another transaction | Checking, Savings, Credit | No |
| isReturnedItem | boolean (0/1/NULL) | Indication if the transaction represents a returned check or transfer (ex. due to nonsufficient funds) | Checking, Savings, Credit | No |
| isRefund | boolean (0/1/NULL) | Indication if the transaction represents a refund of another transaction (can be full/partial refund) | Checking, Savings, Credit | No |
| isInstallment | boolean (0/1/NULL) | Indication if the transaction is one of multiple installments | Credit | No |
| statusOriginal | string | The transaction status - according to the bank's original vocabulary | All | No |
| isPreAuthorized | boolean (0/1/NULL) | Indication if the transaction was preauthorized | Checking, Savings, Credit | No |
| isRecurring | boolean (0/1/NULL) | Indication if the transaction is a periodically recurring transaction | Checking, Savings, Credit | No |
| transactionChannel | ENUM (See below) | The channel the transaction was made through - For example: Indication if the purchase transaction was made online - according to the Personetics vocabulary | All | No |
| categoryId | string | The transaction category ID - applicable if the bank would like to use it's own internal categorization system instead of the Personetics categorization (Requires setup and additional documentation). If the bank would like to take Personetics categorization - this attribute is not relevant | All | No |
Please find ENUM fields option in the table below:
| Field | Possible value | Description |
|---|---|---|
| type (account) | Checking | Checking / Current account |
| type (account) | Savings | Savings account |
| type (account) | Credit | Credit card account |
| type (account) | Prepaid | Prepaid card account |
| type (account) | Loan | Loan account |
| type (account) | Mortgage | Mortgage account |
| type (account) | CD | Term Deposit account |
| type (account) | Investment | Investment account |
| transactionChannel | ATM | For example: cash withdrawal using ATM machine, etc |
| transactionChannel | Branch | For example: cash withdrawal using bank's clerk, etc |
| transactionChannel | Mobile | For example: check deposit using mobile phone, etc |
| transactionChannel | Online | For example: online purchase, online transfer, etc |
| transactionChannel | DigitalWallet | For example: PayPal, Apple Pay, Venmo, Google Wallet, Android Pay, Alipay, Cash App, etc |
| direction | C | Credit |
| direction | D | Debit |
| status | Pending | A transaction that has not yet been Posted/Rejected |
| status | Posted | Posted transaction |
| status | Rejected | Rejected transaction |
| status | Scheduled | Transaction scheduled for future occurrence |
| type (transaction) | Charge | Card transaction (purchase, payment for a service, etc.) |
| type (transaction) | CashOrCheck | Cash or check deposit (in case the specific type is not clear) |
| type (transaction) | Fee | Any bank or card fee |
| type (transaction) | Cash | A cash deposit or withdrawal (either in branch, ATM or any other way) |
| type (transaction) | Check | Check deposit or check posted |
| type (transaction) | OwnAccountTransfer | Transfer between a user's own accounts |
| type (transaction) | Transfer | Transfer to or from an account not owned by the user |
| type (transaction) | Other | Other Incoming / Outgoing transaction |
| type (transaction) | Interest | Charge / Deposit of interest on the account |
| type (transaction) | SecurityExecution | Buy / sale of a security (For investments accounts) |
| type (transaction) | InvestmentDeposit | A deposit due to investment activity (For investments accounts) |
| transferSubType | OverdraftProtection | Overdraft protection transaction |
| transferSubType | DigitalWalletTransfer | Incoming / Outgoing transfer using a digital wallet (such as: PayPal, Apple Pay, Venmo, Google Wallet, Android Pay, Alipay, Cash App, etc.) |
| transferSubType | TermDepositRedemption | Redemption of a Term Deposit funds to the user's checking / Savings account |
| transferSubType | BalanceTransfer | A balance transfer between credit cards |
| transferSubType | DirectDebit | Recurring Direct Debit outgoing transfer |
| transferSubType | StandingOrder | Recurring Standing Order outgoing transfer |
| transferSubType | DirectDeposit | Direct Deposit incoming transfer to the account |
| feeSubType | ATM | Fee for using an ATM |
| feeSubType | InsufficientFunds | Fee charged when the customer performs a debit transaction without sufficient balance/credit |
| feeSubType | OverdraftItemPaid | Fee charged when the bank pays an overdraft item for the customer |
| investmentSubType | Coupon | A deposit of a coupon (For investments accounts) |
| investmentSubType | Dividend | A deposit of a dividend (For investments accounts) |
| investmentSubType | BondRedemption | Redemption of a bond (For investments accounts) |
| investmentSubType | TdRedemption | Redemption of a term deposit (For investments accounts) |
Updated 6 months ago