GetEligiblityDetailsForBT
Action: POST
Endpoint: /api/CoreCredit/Transactions/GetEligiblityDetailsForBT
Purpose of this API is to get Available BT Amount, Promotion BT details and Full rate BT plans on the account.
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 Condition:At least one of AdminNumber/AccountNumber is required. Example: 7314145404 Allowable Values: 19 |
AdminNumber integer Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format: XXXXX Condition: At least one of AdminNumber/AccountNumber is required. Example: 12345 |
RequestedBTAmount decimal Optional |
Requested Balance Transfer Amount. Default value is 0.00 (Zero Dollars) Valid Values: 0-9 Example: 1000.00 |
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": null, "AdminNumber": 129468, "RequestedBTAmount": 200.0 }
Response fields details
Fields | Description |
---|---|
AvailableBTAmount decimal |
Available Balance Transfer Amount Valid Values:0-9 Format: XXX.XX Example: 1000.00 |
TransactionFeeAmount decimal |
Transaction Fee Amount ($). Valid Values: 0 - 9 Format: XX.XX Example: 10.00 |
TotalTransactionAmount decimal |
Sum of requested BT amount and Transaction Fees. Valid Values: 0-9 Format: XXX.XX Example: 500.00 |
HoldBusinessDays integer |
Hold period for BT Valid Values: 0-9 Example: 10 |
EligibleForBT string |
This flag will decide if balance transfer is allowed or not as per account status. Valid Values: 0 = Not Eligible for Balance Transfer,1 = Eligible for Balance Transfer Example: 0 |
AccountStatus string |
Status of the Account. Valid Values: A-Z, 0-9 Example: Active Allowable Values: 100 |
HoldDaysDisclosure string |
Disclosure based on hold days. Valid Values: 0-9, A-Z Example: Balance Transfers is usually processed in 2-4 business days. However, for new accounts it may take up to 16 business days. Allowable Values: 2000 |
EligiblePromoBTPlans array |
List of Eligible promotional offer on account |
FullRateBTPlans array |
List of Full rate BT Plan on account |
Sample response body
{ "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "AvailableBTAmount": null, "TransactionFeeAmount": null, "TotalTransactionAmount": null, "HoldBusinessDays": null, "EligibleForBT": null, "AccountStatus": null, "HoldDaysDisclosure": null, "EligiblePromoBTPlans": [ { "BTPromoId": 1245, "BTPromoName": "abc", "APR": "1.00%", "TransactionFees": "3.00%", "OfferCode": 1234, "PromoRateDuration": 1, "DetailedDisclosure": "abc" }, { "BTPromoId": 1245, "BTPromoName": "abc", "APR": "1.00%", "TransactionFees": "3.00%", "OfferCode": 1234, "PromoRateDuration": 1, "DetailedDisclosure": "abc" } ], "FullRateBTPlans": null } }