Get Institution Parameters
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetInstitutionParameters
Use this API to obtain parameters and attributes configured for an institution entity created in the system.
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 |
InstitutionID integer Mandatory |
Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard. |
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, "InstitutionID": 1332 }
Response fields details
Fields | Description |
---|---|
InstitutionAssociations array |
List of Institution Associations |
InstitutionReports array |
List of All InstitutionReports |
InstitutionData
|
IntitutionData |
Sample response body
{ "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "InstitutionAssociations": [ { "NetworkType": "MC", "ProcessorID": "220203" } ], "InstitutionReports": [ { "ReportName": "", "ScheduleType": "BUSINESSDATE", "ScheduleTime": null, "DeliveryMechanism": "Online", "DeliveryFrequency": "Daily", "FTPAddress": null, "FTPLogin": null, "FtpPassword": null, "EmailAddress": null }, { "ReportName": "", "ScheduleType": "BUSINESSDATE", "ScheduleTime": null, "DeliveryMechanism": "Hardcopy", "DeliveryFrequency": "Monthly 31", "FTPAddress": null, "FTPLogin": null, "FtpPassword": null, "EmailAddress": null } ], "InstitutionData": { "InstitutionName": "abc", "InstitutionParentName": "Template Record", "DestinationAlignment": 1, "DestinationRTAlignment": 1, "OriginationAlignment": 1, "TINAlignment": 1, "CompanyNameAlignment": 0, "CompanyIdAlignment": 1, "ECCAlignment": 0, "CEDAlignment": 0, "ACHCutoffTimeforPaymentScheduling": null, "ACHCutoffTimeforInstantPayments": null, "NoOfTxnInACHFile": null, "BankVerificationMethod": "1", "CompanyID": "F460187030", "EntryClassCode": null, "CompanyEntryDescription": null, "INSTEmail": null, "BillingMethod": 0, "InstitutionAddressLine1": "655 Castro Street #7", "InstitutionAddressLine2": "", "INSTCity": "Mountain View", "Country": "US", "StateProvince": "CA", "postalcode": "94041", "TollFreeNumber": null, "SystemOperatorMail": null, "CustSvcPhoneNmbr": "1-855-552-5375", "CollectionPhoneNmbr": null, "FaxNumber": null, "CreditFileEmailAddr": null, "destination": "FEDERAL RESERVE BANK", "DestinationRoutingAndTransit": "691000134", "origination": "FIRST BANK & TRUST", "OriginationRoutingAndTransit": "91408446 ", "Prenote": 1, "delayDes": 0, "MultipleFileIdentifier": null, "TaxIdentificationNumber": "091408446 ", "ImmediateDestinationName": null, "SecondaryCurrencyDestination": null, "SecondaryCurrencyOrigination": null, "SecondaryDestinationRoutingAndTransit": null, "SecondaryOriginationRoutingAndTransit": null, "SecondaryCurrDestinationName": null, "SecondaryCurrOriginationName": null, "PaymentDescription": "Payment", "ACHProcessing": 0, "ACHformat": "Without Offset Record", "ACHCompanyAccountNumber": null, "ACHCompanyAccountDescription": null, "VCFIssuerIdentificationNumber": null, "VCFProcessorIdentificationNumber": null, "CollectionInterface": 0, "GenerateStatement": 0, "SeparateEmbossingFile": 0, "TemporaryCardCreation": 0, "LoyaltyActive": 0, "ArchivingFrequency": null, "HoldStatement": 0, "APIIdempotencylevel": "Institution", "CardSequenceNumberPosition1Track1": 1, "CardSequenceNumberPosition2Track1": 6, "CVNStartingPositionTrack1": 11, "PINOffsetStartingPositionTrack1": 2, "CardSequenceNumberPosition1": 1, "CardSequenceNumberPosition2": 6, "CVNStartingPosition": 11, "PINOffsetStartingPosition": 2, "SysOrgID": null, "SysOrgIDDescription": null, "BillingCycleFrequency": null, "GenerateCBRFileatProductLevel": null, "ProcessOfacChecks": 1, "ProcessOfacCosignerCheck": 1, "OFACCheckMethod": 1, "LastBulkOFACCheckDate": null, "FileUploadFrequency": 12, "ThresholdIndividual": 1, "ThresholdEntity": 1, "LegalEntity": null, "DBAName": 0, "Surname": 0, "Firstname": 0, "Address1": 0, "OFACCity": 0, "OFACState": 0, "OFACPostalCode": 0, "OFACCountry": 0, "PlaceOfBirth": 0, "DateOfBirth": 0, "IDNumber": 0, "IDCountry": 0, "OFACNotificationEmail": null, "OFACSMS": null, "OFACStatus": 1010, "OfacRecheckStatus": 1011, "MaxNumberofResults": 30, "ExtendedKeysOnOff": 1, "ComparisonType": 1, "SearchRange": 0, "MatchingThreshold": 80, "SearchType": "0", "ISTWatchItmToQryFirstName": 1, "ISTWatchItmToQryLastName": 1, "ISTWatchItmToQryMidName": 1, "ISTWatchItmToQryAddress": 1, "ISTWatchItmToQryCity": 1, "ISTWatchItmToQryState": 1, "ISTWatchItmToQryCountry": 1, "BillingCycleMethod": 0, "DaysinBillingCycle": 10, "SetBillingCycleTo": 0, "ProcessOnSun": 0, "ProcessOnMon": 1, "ProcessOnTues": 1, "ProcessOnWed": 1, "ProcessOnThur": 1, "ProcessOnFri": 1, "ProcessOnSat": 0, "Holiday1": "01/16/2017 00:00:00", "Holiday2": "02/20/2017 00:00:00", "Holiday3": "05/29/2017 00:00:00", "Holiday4": "07/04/2017 00:00:00", "Holiday5": "09/04/2017 00:00:00", "Holiday6": "10/09/2017 00:00:00", "Holiday7": "11/11/2017 00:00:00", "Holiday8": "11/23/2017 00:00:00", "Holiday9": null, "Holiday10": null, "Holiday11": null, "Holiday12": null, "Holiday13": null, "Holiday14": null, "Holiday15": null, "Holiday16": null, "Holiday17": null, "Holiday18": null, "Holiday19": null, "Holiday20": null, "Holiday21": null, "Holiday22": null, "Holiday23": null, "Holiday24": null, "DayLightSaving": 1, "ProcessingDayEndTime": "07/24/2020 23:59:57", "CurrentProcessingDayEnd": "01/17/2017 23:59:57", "NewProcessingDayEnd": "01/17/2017 23:59:57", "CBLastAppCheck": 0, "CBAppPurge": 0, "MemberCode": null, "SubscriberPassword": null, "CountryCode": 1, "LanguageIndicator": "1", "BureauMarket": null, "BureauSubmarket": null, "IndustryCode": null, "PrdtCode": null, "ProcessingRequest": null, "AddonProductCode": null, "ProductType": "P", "EnableCBR": 1, "ReporterName": "Final, Inc", "ReporterAddress": "PO Box 543000 Omaha, NE 68154", "ReporterTelephone": "8555525375", "CBRIDNumber": "2647210", "ProgramIdInnovis": "", "ProgramIdEquifax": "", "ProgramIdExperian": "DBORX", "ProgramIdTransUnion": "", "CBRReportBy": 0, "DDActiveOrg": 1, "DDFrequency": 0, "DDDaysBeforeCycle": null, "DDMaxNSFAttempts": 3, "DirectDebitResponse": 0, "DDOrigBank": null, "DDCompanyName": null, "RTDestinationNo": null, "RTOrignationNo": null, "CompanyEntryDD": null, "DDPaymentTranCode": null, "DDDirectPayTranCode": null, "DDRevTranCode": null, "DDNSFRevTranCode": null, "CSRPaymentTrnCode": null, "CSRSSPaymentTrnCode": null, "CSRMiniPayment": 0.0, "CSRSSMiniPayment": 0.0, "CSRMaxPayment": 30000.0, "SelfServiceMaxPayment": 30000.0, "DCActiveOrg": 1, "DCPurchaseTranCode": null, "DCRevTranCode": null, "DCReturnTrahnCode": null, "LockboxNo": null, "LockboxABANo": null, "LockboxOriginABA": null, "LockboxAccntNo": null, "InboundRate": null, "TransferRate": null, "ProcessOFACCheckOnCosigner": null, "GenerateCheckNumberInCheckFile": "0", "CheckBeginNumber": 1111111111.0, "CheckIncrementedBy": 1, "LastUsedCheckNumber": 1111111111.0, "AdditionalOFACListToScan": null } } }