QFD can integrate either via REST or SOAP API using real time API calls to the system of record in order to search for and retain useful account information.
Account Search:
Please note: QFD only supports looking up a list of accounts by the unique customer id.
In order for QFD to display search results, and to retain other needed account information, we will need as many of the The following data points as possible will need to be made available returned from the API response:account search API call, so that QFD can display the list of accounts on the UI, in order for the end user to confidently select the correct account to create the claim against.
Field | Required? | Comments |
|---|---|---|
Account Nickname | No | Can be used on the UI in place of the Description for easier account identification, sometimes enabled for those with online banking |
Account Number | Yes | Unique account number that would identifies a customer’s account |
Account Type | Yes - Deposit account, Credit card account, etc. | |
Account Type Code* | Yes - A unique unchanging code that denotes the type of account (Checking, Business Checking, etc.) | |
Description | Yes | |
Account Status | Yes | |
Account Status Code | No | |
Account Name | No | |
Account Nickname | No | |
Account Open Date | No | |
Account Closed Date | No | |
Balance | No | |
Statement Cycle Date | No | |
Is Account Enrolled in Auto Pay | No | |
Is Overdraft Protection Enabled | No | |
Card Number | Yes - Unless returning Card ID | |
Card ID | Yes - if API is returning Card ID, we will need a service | Indicates if the account is for deposits, credit cards, etc. Currently supported types are “Deposit” and “CreditCard”. Client data that derives the account type should not change. Ideally it is an alphanumeric or numeric code (not a text based description). |
Description | Yes | ex: Checking, Business Checking, Student Checking, etc. |
Account Lookup:
Note: This can leverage the same API call as Account Search, if the API supports being able to query based on EITHER a unique customer id OR a unique account number.
In order for QFD to retain needed account information, we will need as many of the following data points as possible to be made available from the API response:
Field | Required? | Comments |
|---|---|---|
Account Closed Date | No | Indicated the date the account was closed |
Account Number | Yes | Unique account number that would identifies a customer’s account |
Account Nickname | No | Can be used on the UI in place of the Description for easier account identification, sometimes enabled for those with online banking |
Account Open Date | No | Indicates the date the account was opened |
Account Status | Yes | This can either be a Alphanumeric or numeric code that represents status, or a string like “Active”, “Closed”, “Blocked”, etc.. Ideally this will be based on an unchanging code and not a text based description. |
Account Type | Yes | Indicates if the account is for deposits, credit cards, etc. Currently supported types are “Deposit” and “CreditCard”. Client data that derives the account type should not change. Ideally it is an alphanumeric or numeric code (not a text based description). |
Balance | No | Indicates the current balance of the account |
Card ID | Yes/No | If the API is only able to return Card ID, we will need a separate API call that supports being able to look up the full card number using the Card ID |
Card Holder Name | No |
Card Issue Date
No - if card data not provided here, we will need to know which API has it instead.
Card Expiration Date
No - if card data not provided here, we will need to know which API has it instead.
Card Status
No - if card data not provided here, we will need to know which API has it instead.
...
The full customer’s name as written on the card | ||
Card Expiration Date | No | Indicated the date the card was/will be expired |
Card Issue Date | No | Indicates the date the card was issued |
Card Number | Yes | If the transaction API cannot return full card number, see next field. |
Card Status | Yes | If card data cannot be provided in the transactions API, we will need a separate API call able to get this information as card status will be needed for block and reissue |
Is Account Enrolled in Auto Pay | No | Indicated whether or not the account is enrolled in auto pay, if needed |
Description | Yes | ex: Checking, Business Checking, Student Checking, etc. |
Is Overdraft Protection Enabled | No | Indicated whether or not the account has overdraft protection enabled, if needed |
Statement Cycle Date | No | Indicated the statement cycle date of the account |