Debit Card Management
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/DebitCardManagement
To make payments on credit card purchases, an external bank account debit card number may be mapped in the system. A debit card may be added or deleted and tokens may be generated against the provided card. A payment schedule may also be initiated.
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 |
Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 |
AdminNumber int64 Conditional |
Admin number. Valid Values: 0-9 Example: 12345 |
RequestType integer Optional |
Request Type (0 = Add Debit Card, 1 = Delete Debit Card, 2 = Generate Debit Card Token using Debit Card Information) Valid Values: 0, 1, 2 |
Token string Conditional |
A hash value getting generated based on Request Type Required If Request Type = 0(Add Debit Card, 1 = Delete Debit Card) Valid Values: 0-1, A-Z |
DebitCardNumber string Conditional |
16 Digit Card Number mentioned in debit card Required If Request Type = 0 (Add Debit Card) |
ExpirationDate string Conditional |
Expiration Date mentioned on Debit card Required If Request Type = 0 (Add Debit Card) Format: MM/YYYY Example: 02/2020 |
CardCVV string Conditional |
CVV Number of the card |
MethodName string Conditional |
Method Name uniquely identifies Debit Card information in Core card system. Whenever user adds any Debit card information, this API returns Method Name against successful addition of bank account. Required if request type = 1 (delete request) |
ApplicantType string Optional |
Selects the type of Applicants. Valid Values: 1, 2, 3 Format: x Example: 1= 'Applicant', 2 ='Co-Applicant', 3= 'Cosigner', |
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, "AccountNumber": "9000000500000048", "AdminNumber": 12345, "RequestType": 0, "Token": "12346", "DebitCardNumber": "4256368978459696", "ExpirationDate": "02/2022", "CardCVV": "069", "MethodName": "1", "ApplicantType": "1" }
Response fields details
Fields | Description |
---|---|
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. |
MethodName string |
This will be returned when new Debit Card will be added. |
Sample response body
{ "Message": "Debit Card Management Added", "Status": true, "ErrorCode": "ERR01132", "ResponseData": { "ResponseID": "56894601", "MethodName": "3243" } }