Bank Account Validation
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/BankAccountValidation
Use this API to validate a bank account by performing micro-deposits to the account. This function requires input parameters, such as card number, admin number, bank routing number, and bank account number.
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 |
CardNumber string Conditional |
Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format:XXXXXXXXX Example:123654789 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. |
AccountNumber string Conditional |
Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. Allowable Values: 19 |
BankRoute string Optional |
9 digit field used to identify bank Valid Values: 0-9 Format:XXXXXXXXX Example:365478963 Allowable Values: 9 |
BankAccountNumber string Optional |
Bank Account Number. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Allowable Values: 19 |
BankAccountNumberConfirm string Optional |
Bank Account Number re-entered to confirm. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Allowable Values: 19 |
MicroDepositAmount decimal Optional |
Amount which will be required to validate bank account. Valid Values: 0-9 Format:XXX.XX Example:0.25 |
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, "CardNumber": null, "AdminNumber": 167550, "AccountNumber": "8110000000000125", "BankRoute": null, "BankAccountNumber": "45753457557577", "BankAccountNumberConfirm": "45753457557577", "MicroDepositAmount": 0.25 }
Response fields details
Fields | Description |
---|---|
InvalidAttemps integer |
This is the value of retry attempt. Max retry attempt is 3. |
ResponseID string |
This number will ensure that API hit our internal servers. This will always be unique. It can also be null when API is returned from our external servers example – If we pass blank User Id and Password in input then this will be null. This ID can be used for tracking purpose of any request hit the core card internal servers. Allowable Values: 15 |
Sample response body
{ "Message": "Bank Account has been validated.", "Status": true, "ErrorCode": "ERR01150", "ResponseData": { "InvalidAttemps": 2, "ResponseID": "154545" } }