Get User Field Details
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetUserFieldDetails
Use this API to get the list of all user fields which are defined on the product. These fields are dynamic and can be added as a custom field on the product. On providing input as account number oraccount ID this API details out the list of user fields defined on a product with the custom name of user field and its type such as currency, date, text etc.
Request fields details
| Fields | Description |
|---|---|
|
Source string Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
|
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
|
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
|
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
|
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
|
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
|
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
|
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
|
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
|
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
|
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
|
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
|
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid values:0-9 Example:12345 |
|
AccountNumber string Conditional |
Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
Sample request body
{
"Source": "WEB",
"IPAddress": "10.120.0.1",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"AccountID": 45436,
"AccountNumber": null
}
Response fields details
| Fields | Description |
|---|---|
|
UserFieldsList array |
List of all the dynamic user fields which are defined on the product |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"UserFieldsList": [
{
"TitleUF1": "Block Code2",
"StatusUF1": 0,
"TypeUF1": 2,
"TextUF1": "W",
"DateUF1": null,
"CurrencyUF1": 0.0,
"TitleUF2": null,
"StatusUF2": null,
"TypeUF2": null,
"TextUF2": null,
"DateUF2": null,
"CurrencyUF2": null,
"TitleUF3": null,
"StatusUF3": null,
"TypeUF3": null,
"TextUF3": null,
"DateUF3": null,
"CurrencyUF3": null,
"TitleUF4": null,
"StatusUF4": null,
"TypeUF4": null,
"TextUF4": null,
"DateUF4": null,
"CurrencyUF4": null,
"TitleUF5": null,
"StatusUF5": null,
"TypeUF5": null,
"TextUF5": null,
"DateUF5": null,
"CurrencyUF5": null,
"TitleUF6": null,
"StatusUF6": null,
"TypeUF6": null,
"TextUF6": null,
"DateUF6": null,
"CurrencyUF6": null,
"TitleUF7": null,
"StatusUF7": null,
"TypeUF7": null,
"TextUF7": null,
"DateUF7": null,
"CurrencyUF7": null,
"TitleUF8": null,
"StatusUF8": null,
"TypeUF8": null,
"TextUF8": null,
"DateUF8": null,
"CurrencyUF8": null,
"TitleUF9": null,
"StatusUF9": null,
"TypeUF9": null,
"TextUF9": null,
"DateUF9": null,
"CurrencyUF9": null,
"TitleUF10": null,
"StatusUF10": null,
"TypeUF10": null,
"TextUF10": null,
"DateUF10": null,
"CurrencyUF10": null,
"TitleUF11": null,
"StatusUF11": null,
"TypeUF11": null,
"TextUF11": null,
"DateUF11": null,
"CurrencyUF11": null,
"TitleUF12": null,
"StatusUF12": null,
"TypeUF12": null,
"TextUF12": null,
"DateUF12": null,
"CurrencyUF12": null,
"TitleUF13": null,
"StatusUF13": null,
"TypeUF13": null,
"TextUF13": null,
"DateUF13": null,
"CurrencyUF13": null,
"TitleUF14": null,
"StatusUF14": null,
"TypeUF14": null,
"TextUF14": null,
"DateUF14": null,
"CurrencyUF14": null,
"TitleUF15": null,
"StatusUF15": null,
"TypeUF15": null,
"TextUF15": null,
"DateUF15": null,
"CurrencyUF15": null,
"TitleUF16": null,
"StatusUF16": null,
"TypeUF16": null,
"TextUF16": null,
"DateUF16": null,
"CurrencyUF16": null,
"TitleUF17": null,
"StatusUF17": null,
"TypeUF17": null,
"TextUF17": null,
"DateUF17": null,
"CurrencyUF17": null,
"TitleUF18": null,
"StatusUF18": null,
"TypeUF18": null,
"TextUF18": null,
"DateUF18": null,
"CurrencyUF18": null,
"TitleUF19": null,
"StatusUF19": null,
"TypeUF19": null,
"TextUF19": null,
"DateUF19": null,
"CurrencyUF19": null,
"TitleUF20": null,
"StatusUF20": null,
"TypeUF20": null,
"TextUF20": null,
"DateUF20": null,
"CurrencyUF20": null,
"TitleUF21": null,
"StatusUF21": null,
"TypeUF21": null,
"DDValueUF21": null,
"BooleanUF21": null,
"TitleUF22": null,
"StatusUF22": null,
"TypeUF22": null,
"DDValueUF22": null,
"BooleanUF22": null,
"TitleUF23": null,
"StatusUF23": null,
"TypeUF23": null,
"DDValueUF23": null,
"BooleanUF23": null,
"TitleUF24": null,
"StatusUF24": null,
"TypeUF24": null,
"DDValueUF24": null,
"BooleanUF24": null,
"TitleUF25": null,
"StatusUF25": null,
"TypeUF25": null,
"DDValueUF25": null,
"BooleanUF25": null
}
],
"CardLevelUserFieldsList": [
{
"AdminNumber": 129443,
"CardNumberLast4Digit": "4853",
"TitleCardUF1": "Field_AAA",
"StatusCardUF1": 0,
"TypeCardUF1": 2,
"TextCardUF1": "abcd",
"DateCardUF1": null,
"CurrencyCardUF1": null,
"TitleCardUF2": null,
"StatusCardUF2": null,
"TypeCardUF2": null,
"TextCardUF2": null,
"DateCardUF2": null,
"CurrencyCardUF2": null,
"TitleCardUF3": null,
"StatusCardUF3": null,
"TypeCardUF3": null,
"TextCardUF3": null,
"DateCardUF3": null,
"CurrencyCardUF3": null,
"TitleCardUF4": null,
"StatusCardUF4": null,
"TypeCardUF4": null,
"TextCardUF4": null,
"DateCardUF4": null,
"CurrencyCardUF4": null,
"TitleCardUF5": null,
"StatusCardUF5": null,
"TypeCardUF5": null,
"TextCardUF5": null,
"DateCardUF5": null,
"CurrencyCardUF5": null,
"TitleCardUF6": null,
"StatusCardUF6": null,
"TypeCardUF6": null,
"DDValueCardUF6": null,
"BooleanCardUF6": null,
"TitleCardUF7": null,
"StatusCardUF7": null,
"TypeCardUF7": null,
"DDValueCardUF7": null,
"BooleanCardUF7": null,
"TitleCardUF8": null,
"StatusCardUF8": null,
"TypeCardUF8": null,
"DDValueCardUF8": null,
"BooleanCardUF8": null,
"TitleCardUF9": null,
"StatusCardUF9": null,
"TypeCardUF9": null,
"DDValueCardUF9": null,
"BooleanCardUF9": null,
"TitleCardUF10": null,
"StatusCardUF10": null,
"TypeCardUF10": null,
"DDValueCardUF10": null,
"BooleanCardUF10": null
}
],
"UserFieldDropdownValueList": null
}
}