Get Dispute Case History
Action: POST
Endpoint: /api/CoreCredit/Dispute/GetDisputeCaseHistory
Use this API to get the entire case history of the disputed transaction raised on any account. To get the history of the raised dispute transaction, the user needs to provide either Transaction ID or Case ID. This API results out the UserID through which the dispute was raised, the amount for which dispute needs to be resolved, the decision of chargeback accepted or not, the reason of the dispute, the Case ID which is linked to the request, the current stage of the dispute is, dispute date and transaction amount of the original transaction.
Request fields details
| Fields | Description |
|---|---|
|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 ---- es: means Spanish Allowable Values: 10 |
|
ExternalIP string |
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 |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 |
|
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 |
|
TransactionID int64 Conditional |
Description - ID of transaction which is marked disputed. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 23654789 Condition: Either of TransactionID or CaseID is mandatory. |
|
CaseID int64 Conditional |
Description - Case ID assigned to a Dispute Case. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 23654789 Condition: Either of TransactionID or CaseID is mandatory. |
|
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 |
|
TransactionID int64 Conditional |
ID of transaction which is marked disputed. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 23654789 Condition: Either of TransactionID or CaseID is mandatory. |
|
CaseID int64 Conditional |
Case ID assigned to a Dispute Case. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 23654789 Condition: Either of TransactionID or CaseID is mandatory. |
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,
"TransactionID": 74105205,
"CaseID": null
}
Response fields details
| Fields | Description |
|---|---|
|
DisputeTransactionList array |
Description: Array to provide Dispute life cycle details |
|
DisputeTransactionList array |
Description: Array to provide Dispute life cycle details |
Sample response body
{
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"DisputeTransactionList": [
{
"CaseID": 9856198,
"DisputeStage": "0",
"DisputeAction": "Initiate Chargeback",
"DisputeReason": "1",
"OriginalTxnAmount": 150.5,
"DisputeAmount": 20.0,
"DisputeResolveAmount": 10.23,
"DisputeDate": "12/20/2019 00:00:00",
"DisputeTransactionID": 20935062,
"UserID": "DisputeAdminOne",
"Memo": "This is a test note.",
"ChargebackErrorCode": "0",
"ChargebackErrorMessage": null,
"RebillAmount": null,
"ChargebackAccepted": null,
"NetworkConvertedDispAmt": null,
"IssuerCaseId": null,
"PreArbCaseStatus": null
}
]
}
}