Dispute
A dispute of card and transaction terms occurs when a cardholder disagrees with a transaction charged on the card account statement. Most transaction-based disputes are resolved between the cardholder and the merchant, where either the charge is identified as valid or the merchant processes a refund to the cardholder. A refund could occur in a case of merchandise having been returned by the cardholder or the merchant having charged the transaction twice.
Yet a cardholder may face situations in which the merchant does not agree to refund an invalid transaction, or the transaction was charged by fraudulent means. In such scenarios, the cardholder may lodge a dispute with the card issuer or processor, identifying the transactions with which the cardholder disagrees.
Once a dispute is lodged with the card issuer or processor, it is taken to the merchant via the card network. The merchant bank processes it as per guidelines and regulations established by the card network. A dispute may pass through multiple steps and exchanges with the merchant, and it will end with a resolution in favor of the cardholder or merchant. When a card issuer sends the dispute to the merchant, it is called chargeback. The merchant's response to the issuer chargeback is called re-presentment, or the second presentment.

Dispute OTB Release
Action: POST
Endpoint: /api/CoreCredit/Dispute/DisputeOTBRelease
Use this API to release a hold placed on the Open to Buy (OTB) credit limit amount by using the dispute case ID. When a transaction is marked as disputed for a non-fraudulent reason, an OTB amount equivalent to the disputed amount is kept on hold. In such a case, if the benefit is to be given to the cardholder, the API can release the held OTB amount. Additionally, the API can release the held OTB amount at any dispute life cycle stage before resolution.
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 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 |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
CardNumber string Conditional |
Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition: At least one account identifier is required. Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required. |
AccountUniversalUniqueID string Optional |
Unique additional Identification Number generated by system for an Account. Example:a585f533-0d33-4282-ab98-4852146e5e17 Allowable Values: 50 |
AdminUniversalUniqueID string Optional |
EmbossingAccount's Universal Unique Id. Valid Values:0-9, A-Z Format:xxxxxxx Example:123456 Allowable Values: 64 |
CaseID int64 Mandatory |
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": "8000000000000177", "CardNumber": null, "AdminNumber": null, "AccountUniversalUniqueID": null, "AdminUniversalUniqueID": null, "CaseID": 4453 }
Response fields detail
Fields | Description |
---|---|
ReleasedOpenToBuy decimal |
Amount of 'Open to Buy' which got released. Valid Values:0-9 Example: 123.50 |
Sample response body
{ "application/json": { "Message": "Dispute OTB Released Successfully", "Status": true, "ErrorCode": "ERR01174", "ResponseData": { "ReleasedOpenToBuy": 200.0 } } }
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 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 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 Mandatory |
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 Example: 23654789 |
DisputeAction integer Mandatory |
Action on Dispute Transaction. Valid Values: 0-9 Example: 0 - Initiate Chargeback |
DisputeReason string Mandatory |
Reason through which Dispute resolution needs to take place. Valid Values: 0-9 Example: 7 - Duplicate Processing |
DisputeResolveAmount decimal Optional |
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: 100 |
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" }
Response fields detail
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 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 Example: K Allowable Values: 5 |
Sample response body
{ "application/json": { "Message": "Dispute Resolved Successfully", "Status": true, "ErrorCode": "ERR01016", "ResponseData": { "DisputeAmount": 53.21, "DisputeTranID": 123372036854863811, "CaseID": 123456, "FraudTypeCode": null, "SubFraudTypeCode": null } } }
Raise Transaction Dispute
Action: POST
Endpoint: /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 |
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 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 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. Please refer appendix for valid set of values. 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 |
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 } } }
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 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 |
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 |
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 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 |
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. |
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 detail
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
{ "application/json": { "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.", "CharebackErrorCode": "0", "ChargebackErrorMessage": null, "RebillAmount": null, "ChargebackAccepted": null, "IssuerReferenceData": null, "Skey": null } ] } } }
Get Pending Dispute Transaction History
Action: POST
Endpoint: /api/CoreCredit/Dispute/GetPendingDisputeTransactionHistory
Use this API to obtain transaction details for cases in which disputes have not yet been resolved. The API retrieves details such as dispute initiated date, last updated date, transaction amount, dispute amount, dispute status, account number, transaction ID, and total number of records present in an array.
Note
This API can be used to get request with multiple filters. If the filters are used, then CoreCARD returns the transactions which are falling within applied filters. In case filters are not applied, then by default CoreCARD returns all the transactions for an account on which dispute is yet to be resolved.
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 |
InstitutionID integer Mandatory |
Description: Unique identification number for Institution Valid Values: 0-9 Format: XXXX Example: Fixed value needs to pass which is provided by Corecard. |
AccountNumber string Optional |
Description: Account number of cardholder. Valid Values: 0-9 Format: XXXXXXXXXX Example: 7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
CardNumberLast4Digit string Optional |
Description: Last 4 digits of card number Valid Values: 0 - 9 Format: XXXX Example: 1234 Allowable Values: 10 |
FromDate datetime Optional |
Description: Starting date of transaction search.Used as a criteria for Transaction Filter. Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020 |
ToDate datetime Optional |
Description: End date of transaction search.Used as a criteria for Transaction Filter Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020 |
DisputeStage string Optional |
Description: Code of the stage of Dispute case . Valid Values: 0-9 Example: 0,2 Allowable Values: 5 |
ProductID integer Optional |
Description: Product ID Valid Values: 0-9 Format: XXXX Example: 1234 |
ClientID integer Optional |
Description - Client ID of the client. Valid Values: 1422245 Format: XXXXX Example: 5558547 |
TransactionAmount decimal Optional |
Description - Amount of Transaction Valid Values: 0 - 9 Format: XXX.XX Example: 200.00 |
BatchSize integer Optional |
Description: Number of Transaction which can be view in one Batch Valid Values: 0-9 Format: XX Example: 20 |
PageIndex integer Optional |
Description: Number of page Valid Values: 0 - 9 Format: XX Example: 12 |
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 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 |
InstitutionID integer Mandatory |
Description: Unique identification number for Institution Valid Values: 0-9 Format: XXXX Example: Fixed value needs to pass which is provided by Corecard. |
AccountNumber string Optional |
Description: Account number of cardholder. Valid Values: 0-9 Format: XXXXXXXXXX Example: 7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
CardNumberLast4Digit string Optional |
Description: Last 4 digits of card number Valid Values: 0 - 9 Format: XXXX Example: 1234 Allowable Values: 4 |
FromDate datetime Optional |
Description: Starting date of transaction search.Used as a criteria for Transaction Filter. Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020 |
ToDate datetime Optional |
Description: End date of transaction search.Used as a criteria for Transaction Filter Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020 |
DisputeStage string Optional |
Description: Code of the stage of Dispute case . Valid Values: 0-9 Example: 0,2 Allowable Values: 5 |
ProductID integer Optional |
Description: Product ID Valid Values: 0-9 Format: XXXX Example: 1234 |
ClientID integer Optional |
Description - Client ID of the client. Valid Values: 1422245 Format: XXXXX Example: 5558547 |
TransactionAmount decimal Optional |
Description - Amount of Transaction Valid Values: 0 - 9 Format: XXX.XX Example: 200.00 |
BatchSize integer Optional |
Description: Number of Transaction which can be view in one Batch Valid Values: 0-9 Format: XX Example: 20 |
PageIndex integer Optional |
Description: Number of page Valid Values: 0 - 9 Format: XX Example: 12 |
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, "InstitutionID": 3185, "AccountNumber": null, "CardNumberLast4Digit": null, "FromDate": null, "ToDate": null, "DisputeStage": null, "ProductID": null, "ClientID": null, "TransactionAmount": null, "BatchSize": 50, "PageIndex": 0 }
Response fields detail
Fields | Description |
---|---|
PendingDisputeTransactionList array |
Description: List all the dispute transactions. |
TotalRecordCount integer |
Description: Total number of records in an Array. Valid Values: 0-9 Example: 10 |
PendingDisputeTransactionList array |
Description: List all the dispute transactions. |
TotalRecordCount integer |
Description: Total number of records in an Array. Valid Values: 0-9 Example: 10 |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "PendingDisputeTransactionList": [ { "TransactionID": 23654789, "DisputeAutoResolveDate": "03/31/2016 00:00:00", "TransactionPostTime": "03/31/2016 00:00:00", "TransactionDescription": "Purchase/Payment.", "TransactionCurrencyCode": "840= Us dollor", "TransactionAmount": 200.0, "TransactionSource": "Retail = 23(Manual Auth)", "CardAcceptorNameLocation": null, "AccountNumber": "7000000000000070", "CardNumberLast4Digits": "1234", "DisputeStatus": "Resolve in favor of Cardholder", "DisputeInitiateDate": "03/31/2016 00:00:00", "LastUpdatedDate": "03/31/2016 00:00:00", "DisputeAmount": 20.0, "UserID": "John", "MerchantID": 12345, "DisputeReason": "This is Test", "TokenWalletID": null } ], "TotalRecordCount": null } } }
Cancel Chargeback
Action: POST
Endpoint: /api/CoreCredit/Dispute/CancelChargeback
Use this API to cancel the request raised for a chargeback. To cancel the chargeback request user needs to provide the Account Number and Case ID received while raising a chargeback or dispute. This input will result in the response of either success or an error.
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 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 Mandatory |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
CaseID int64 Mandatory |
Case ID assigned to a Dispute Case. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:23654789 |
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": "5000000000004480", "CaseID": 181366297 }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Updated Successfully", "Status": true, "ErrorCode": "ERR01148", "ResponseData": null } }
Get Dispute Transaction Detail
Action: POST
Endpoint: /api/CoreCredit/Dispute/GetDsputeTransactionDetail
Use this API to fetch the details of a transaction which is marked as disputed by using the transaction ID. API returns dispute transaction details list such as dispute request case ID, dispute initiation date, dispute amount, current stage of a dispute, and dispute ID.
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 |
TransactionID int64 Mandatory |
Transaction Number for the transaction being posted. Valid Values: 0-9 a-z Format: XXXXXXXXXXXXXXXX Example: 23654789 |
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": 123372036854817814 }
Response fields detail
Fields | Description |
---|---|
DisputeTransactionDetailList array |
Get or Set DisputeTransaction_List |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "DisputeTransactionDetailList": [ { "CaseID": 4450, "PurchaseTransactionID": 123372036854817810, "DisputeInitiateAmount": 200.8, "DispteResolveAmount": 200.8, "PurchaseTransactionTime": "01/16/2017 00:00:00", "DisputeInitiationDate": "01/17/2017 00:00:00", "LastDisputeStage": "Initiate Chargeback", "PurchaseTransactionAmount": 200.8, "DisputeStage": "Initiate Dispute", "DisputeID": 1055.0, "ApplicantType": null } ] } } }
GetDisputeTransactionDetail
Action: POST
Endpoint: /api/CoreCredit/Dispute/GetDisputeTransactionDetail
This API is used to fetch the Dispute Transaction Details.
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 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 |
TransactionID int64 Mandatory |
Transaction Number for the transaction being posted. Valid Values: 0-9 a-z Format: XXXXXXXXXXXXXXXX Example: 23654789 |
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": 123372036854817814 }
Response fields detail
Fields | Description |
---|---|
DisputeTransactionDetailList array |
Get or Set DisputeTransaction_List |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "DisputeTransactionDetailList": [ { "CaseID": 4450, "PurchaseTransactionID": 123372036854817810, "DisputeInitiateAmount": 200.8, "DispteResolveAmount": 200.8, "PurchaseTransactionTime": "01/16/2017 00:00:00", "DisputeInitiationDate": "01/17/2017 00:00:00", "LastDisputeStage": "Initiate Chargeback", "PurchaseTransactionAmount": 200.8, "DisputeStage": "Initiate Dispute", "DisputeID": 1055.0, "ApplicantType": null } ] } } }