Get Promotion By Amount
Action: POST
Endpoint: /api/CoreCredit/Transactions/GetPromotionBYAmount
Use this API to retrieve the available or applicable promotional credit plans, with details such as credit plan name and type, based on the transaction amount and by using the merchant ID, account number, and transaction amount.
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 |
|
MerchantID integer Conditional |
Unique number of merchant account. Valid Values:0-9 Format:XXXXX Example:12345 |
|
AccountNumber string Mandatory |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 16 |
|
TransactionAmount decimal Mandatory |
Amount of Transaction Valid Values:0-9 Format:XXX.XX Example:200.00 |
|
MerchantNumber integer Conditional |
Merchant Number which is assgined to a Merchant. Valid Values: 0-9 Format: XXXXXX Example: 11642 |
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,
"MerchantID": 25636,
"MerchantNumber": null,
"AccountNumber": "9000000900001737",
"TransactionAmount": 3400.0
}
Response fields details
| Fields | Description |
|---|---|
|
ListCPM array |
List of Credit Plan Masters. |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"ListCPM": [
{
"CreditPlanMaster": 6153,
"CreditPlanMasterDescription": "ABC_Installment",
"CreditPlanType": "1"
}
]
}
}