ViewDDA
Action: POST
Endpoint: /api/ViewDDA
API Version 1.3
Request fields details
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CardNumber string Conditional |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number is required. Allowable Values: 16 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required. Allowable Values: 19 |
Sample request body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CardNumber": "", "ProxyNumber": "1316728" }
Response fields details
Fields | Description |
---|---|
Message string |
Returns Error Message in case of Error. |
Status boolean |
Returns result of API processing. If any error is found then value will be 'false' else 'true'. |
ErrorCode string |
Returns Error Code in case of Error. |
ResponseData
|
This is group of below data elements. |
DDANumber string |
DDA (Direct Deposit Account) which can be used in ACH transactions. Valid values : 0-9 Example:1234567890 Allowable Values: 19 |
RoutingNumber string |
Bank Routing Number Valid Values:0-9 Example:0110000015 Allowable Values: 10 |
FirstName string |
Cardholder First Name Valid Values: A-Z, a-z Example: Andrew |
LastName string |
Cardholder Last Name Valid values:A-Z, a-z Example: Hudson |
City string |
Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross |
ZipCode string |
Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093 |
Country string |
Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values |
NameofInstitution string |
Name of Financial Institution Valid Values:A-Z,a-z Example:FEDERAL RESERVE BANK |
AddressLine1 string |
Address Line 1 of the Cardholder Valid values are A-Z, a-z, 0-9 Example: 15 Penang Street Point |
AddressLine2 string |
Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way |
Sample response body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "DDANumber": "846953659", "RoutingNumber": "1316728", "FirstName": "mark", "LastName": "smith", "City": "Houston", "ZipCode": "45645", "Country": "US", "NameofInstitution": "xyz", "AddressLine1": "gateway", "AddressLine2": "" } }