Dispute Resolution
Action: POST
Endpoint: /api/CoreCredit/Dispute/DisputeResolution
Use this API to perform dispute resolutions (i.e., in favor of the cardholder, in favor of the merchant, rebill, write-off), dispute reversals, dispute re-openings, and dispute resolution reversals. Additionally, dispute resolution appropriate reasons may be selected and memos may be created for the same.
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 Optional |
Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Allowable Values: 19 |
TransactionID int64 Optional |
Transaction Number for transaction being posted. Valid Values: 0-9 Example: 23654789 |
DisputeAction integer Mandatory |
Action on Dispute Transaction. Valid Values: Please refer appendix section 'Dispute Actions'. Example: 0 - Initiate Dispute |
DisputeReason string Mandatory |
Reason through which Dispute resolution needs to take place. Valid Values: Please refer appendix section 'Dispute Reason'. Example: 7 - Duplicate Processing |
DisputeResolveAmount decimal Mandatory |
Amount for which Dispute need to resolve. Valid Values: 0-9 Format: XX.XX Example: 10.50 |
MemoReason string Optional |
Reason of Memo Text. Valid Values: 0-9, A-Z Example: Disputed Transaction Allowable Values: 50 |
MemoText string Optional |
Text of the Memo. Valid Values:0-9, a-z, special characters Format: XXXXXXXXXXXXXX Example: New Transaction posted. Allowable Values: 1800 |
CaseID int64 Optional |
Case which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198 |
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": "8110000000000026", "TransactionID": 123372036854843936, "DisputeAction": 3, "DisputeReason": "7", "DisputeResolveAmount": 53.21, "MemoReason": null, "MemoText": "some comments", "CaseID": null }
Response fields details
Fields | Description |
---|---|
DisputeAmount decimal |
The amount for which the Dispute is raised on the Transaction. Valid Values:0-9 Format: XXX.XX Example: 20.00 |
DisputeTranID int64 |
Disputed Transaction ID. Valid Values: 0-9 Format: XXXXXXX Example:9856198 |
CaseID int64 |
ID which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198 |
FraudTypeCode string |
Defines the Fraud Type Code prescribed for SAFE Reporting to Mastercard in the SAFE Reporting Guide. Valid Values:Refer Appendix section Fraud Type Code Example: 06 Allowable Values: 5 |
SubFraudTypeCode string |
Defines the Sub Fraud Type Code prescribed for SAFE Reporting to Mastercard in the SAFE Reporting Guide Valid Values:Refer Appendix section Sub Fraud Type Code Example: K Allowable Values: 5 |
Sample response body
{ "Message": "Dispute Resolved Successfully", "Status": true, "ErrorCode": "ERR01016", "ResponseData": { "DisputeAmount": 53.21, "DisputeTranID": "12337203685486", "CaseID": 123456, "FraudTypeCode": null, "SubFraudTypeCode": null } }