Category links

API Links

Raise Dispute

This process refers to marking a transaction as disputed within the CoreCard system. A transaction can be marked as disputed with a full or partial transaction amount based on the merits of a dispute. CoreCard also may be used to initiate the chargeback using API. When a chargeback is initiated, the card processor should provide a reason code as per the guidelines, such that the card network and the merchant bank clearly understand why they receive a chargeback request.

Raise Transaction Dispute

Action: POST

Endpoint: /api/CoreCredit/Dispute/RaiseTransactionDispute

POST /api/CoreCredit/Dispute/RaiseTransactionDispute

Use this API to raise transaction disputes on the account. A dispute can be either full or partial. To raise a dispute transaction amount, what dispute action needs to be initiated such as 'Initiate Chargeback' or 'Initiate Dispute' and what reason through which Dispute resolution needs to be taken place such as 'Duplicate Processing' are the three mandatory fields to be provided in API request. This API response with Case ID and Transaction ID can be used for tracking the request of a raised dispute with the Institution.

Request fields detail
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

AccountNumber

string

Conditional

Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037

Allowable Values:

19

TransactionID

int64

Mandatory

Transaction Number for transaction being posted. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 23654789

DisputeAction

integer

Mandatory

Action on Dispute Transaction. Valid Values: Please refer section 'Dispute Actions' of appendix sheet. Example: 0 - Initiate Dispute, 9 - Initiate Chargeback

DisputeTxnAmount

decimal

Mandatory

Disputed Transaction Amount. Valid Values: 0-9 Format: XX.XX Example: 10.00

DisputeReason

integer

Mandatory

Reason through which Dispute resolution needs to take place. Valid Values: 0-9 Example: 7 - Duplicate Processing

MemoReason

string

Optional

Reason of Memo Text. Valid Values: 0-9, A-Z Example: Disputed Transaction

MemoText

string

Optional

Text of the Memo. Valid Values: 0-9, A-Z Example: Disputed Transaction Posted

AdminNumber

int64

Conditional

Admin number. Valid Values: 0-9 Example: 12345

CaseID

string

Conditional

ID which is generated against the Dispute request. Valid Values: 0-9 Example:9856198 Condition: This is a required tag When DisputeAction=9.

DocumentIndicator

boolean

Optional

Indicator to confirm if customer have provided document proofs or not Valid Values: true/false

ChargebackMemo

string

Optional

Note which is to be sent to Association Valid Values: 0-9,A-Z Example:Documents verified.

ApplicantType

integer

Optional

Valid Values: Applicant/Co-Applicant/Cosigner Default Value: Applicant Selects the type of Applicants. Valid Values: 1, 2, 3 Format: x Example: 1= "Applicant", 2 ="Co-Applicant", 3= "Cosigner"

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

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

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

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

Allowable Values:

19

AdminNumber

int64

Conditional

Admin number. Valid Values: 0-9 Example: 12345

TransactionID

int64

Mandatory

Transaction Number for transaction being posted. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 23654789

CaseID

string

Conditional

ID which is generated against the Dispute request. Valid Values: 0-9 Example:9856198 Condition: This is a required tag When DisputeAction=9.

DisputeAction

integer

Mandatory

Action on Dispute Transaction. Valid Values: Please refer appendix section 'Dispute Actions'. Example: 0 - Initiate Dispute, 9 - Initiate Chargeback

DisputeTxnAmount

decimal

Mandatory

Disputed Transaction Amount. Valid Values: 0-9 Format: XX.XX Example: 10.00

DisputeReason

integer

Mandatory

Reason through which Dispute resolution needs to take place. Valid Values: Please refer appendix section 'Dispute Reason'. Example: 7 - Duplicate Processing

MemoReason

string

Optional

Reason of Memo Text. Valid Values: 0-9, A-Z Example: Disputed Transaction

MemoText

string

Optional

Text of the Memo. Valid Values: 0-9, A-Z Example: Disputed Transaction Posted

DocumentIndicator

boolean

Optional

Indicator to confirm if customer have provided document proofs or not Valid Values: true/false

ChargebackMemo

string

Optional

Note which is to be sent to Association Valid Values: 0-9,A-Z Example:Documents verified.

ApplicantType

integer

Optional

Valid Values: Applicant/Co-Applicant/Cosigner Default Value: Applicant Selects the type of Applicants. Valid Values: 1, 2, 3 Format: x Example: 1 = Applicant, 2 = Co-Applicant, 3 = Cosigner

FraudTypeCode

string

Optional

Defines the Fraud Type Code prescribed for SAFE Reporting to Mastercard in the SAFE Reporting Guide. Valid Values:Refer Appendix Example: 06

Allowable Values:

5

SubFraudTypeCode

string

Optional

Defines the Sub Fraud Type Code prescribed for SAFE Reporting to Mastercard in the SAFE Reporting Guide Valid Values:Refer Appendix Example: K

Allowable Values:

5

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": "1000000700017062",
  "AdminNumber": null,
  "TransactionID": 123456789,
  "CaseID": null,
  "DisputeAction": 0,
  "DisputeTxnAmount": 10.0,
  "DisputeReason": 7,
  "MemoReason": "disputed txn",
  "MemoText": "disputed txn",
  "DocumentIndicator": null,
  "ChargebackMemo": null,
  "ApplicantType": 1,
  "FraudTypeCode": null,
  "SubFraudTypeCode": null
}
Response fields detail
Fields Description

CaseID

int64

ID which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198

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

DisputeTranID

int64

Disputed Transaction ID. Valid Values: 0-9 Format: XXXXXXX Example:9856198

Sample response body

{
  "application/json": {
    "Message": "Dispute initiated successfully",
    "Status": true,
    "ErrorCode": "ERR01015",
    "ResponseData": {
      "CaseID": 10740,
      "DisputeTranID": "45257942"
    }
  }
}