Get Regulation Parameters
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetRegulationParameters
Use this API service to get details of the SCRA and reservist details which are applied on a card account. Account ID is a mandatory field to provide in the request of this API which fetches out the details of the Applicant or Co-Applicant or Co-signer benefits start date, end date, and a number of cycles reservist benefit availed on the card account.
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 Optional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 |
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": 161563 }
Response fields details
Fields | Description |
---|---|
ReservistHistory array |
reservistHistory list |
Sample response body
{ "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "ReservistHistory": [ { "ApplicantType": "Applicant", "ReservistBenefitStartDate": "06/05/2020 00:00:00", "ReservistBenefitEndDate": "07/31/2020 23:59:57", "ReservistServiceEndDate": "06/30/2020 00:00:00", "ReservistBenefitEndNoticeDate": null, "ReservistBenefitUsedYTDOnCustomer": 0, "CancelFuturePaymentSchedules": 0 }, { "ApplicantType": "Cosigner", "ReservistBenefitStartDate": "07/05/2020 00:00:00", "ReservistBenefitEndDate": "09/23/2020 23:59:57", "ReservistServiceEndDate": "12/12/2020 00:00:00", "ReservistBenefitEndNoticeDate": null, "ReservistBenefitUsedYTDOnCustomer": 0, "CancelFuturePaymentSchedules": 0 } ] } }