Search Bank Account
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/SearchBankAccount
Use this API to locate bank accounts within the system and mapped to an account. The API fetches bank account details such as type of account (i.e., savings or checking), name of the bank, routing number, bank account creation date, and if a loyalty redemption or credit balance refund is allowed.
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 |
AccountNumber string Conditional |
Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of CardNumber/AccountNumber/AdminNumber is required. Allowable Values: 19 |
CardNumber string Conditional |
Card Number of account holder Valid Values:0-9 Format:XXXXXXXXXXXX Example:123654789654 Condition:At least one of CardNumber/AccountNumber/AdminNumber is required. Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber is required. |
ApplicantType string Optional |
Selects the type of Applicants. Valid Values:Valid Values: 1, 2, 3, 4 Example: 1= "Applicant", 2 ="Co-Applicant", 3= "Cosigner", 4 = Secondary Card Condition:Applicant Type is optional field. Allowable Values: 50 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AccountNumber": "8110000000000125", "CardNumber": null, "AdminNumber": 167550, "ApplicantType": null }
Response fields details
Fields | Description |
---|---|
BankAccountsList array |
BankAccountsList |
Sample response body
{ "Message": "Bank account details retrieved successfully.", "Status": true, "ErrorCode": "ERR01071", "ResponseData": { "BankAccountsList": [ { "BankAccountType": "Saving", "BankName": "JPMorgan Chase", "BankRoutingNumber": "4843546546", "MethodStatus": "3", "MethodName": "4039", "CreditBalanceRefund": "No", "BAMLast4Digit": "2741", "BankAccountCreationDate": "02/15/2020 00:00:00", "LoyaltyRedemptions": "1", "AccountUniversalUniqueID": null, "ApplicantType": null, "SuccessfulPaymentCounter": null, "UserIdCreated": "User", "UserIdDeleted": "User", "BankAccountDeletionDate": "02/02/2020 00:00:00" } ] } }