Dispute
Dispute
DisputeDocumentsManagement
Action: POST
Endpoint: /api/DisputeDocumentsManagement
Use this API to Add/Download/View Documents to/from Case ID.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CaseID Int64 Mandatory |
ID which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198 Allowable Values: 10 |
DecisionFlag Int32 Mandatory |
Used for performing various operations when respective flag values defined below are passed. Valid Values: 1, 2 and 3. Example: 1 = Upload, 2 = Download and 3 = View Allowable Values: 1 |
DocumentType Int32 Conditional |
Document Type Valid Values: 1, 2, etc. Example : 1= Cardholder Dispute Form, 2 = Merchant Communication Letter/email Please refer appendix Section : Document Type Condition: If the value in ‘DecisionFlag’ field is given as 1, then this field should become Mandatory. Allowable Values: 2 |
MIMEType string Conditional |
MIME type Example :.pdf,.png,.jpg, .jpeg Condition: If the value in ‘DecisionFlag’ field is given as 1, then this field should become Mandatory. |
DocImage byte[] Conditional |
Document image in bytes Condition: If the value in ‘DecisionFlag’ field is given as 1, then this field should become Mandatory. |
DocumentName string Conditional |
Name of the document. Condition: If the value in ‘DecisionFlag’ field is given as 1, then this field should become Mandatory. Allowable Values: 60 |
DocumentUniqueID Int32 Conditional |
System generated unique Document ID. Example: 1,2,3 etc Condition: If the value in ‘DecisionFlag’ field is given as 2, then this field should become Mandatory. |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CaseID": 9856198, "DecisionFlag": 1, "DocumentType": 2, "MIMEType": "", "DocImage": "RG9jSW1hZ2U=", "DocumentName": "", "DocumentUniqueID": 317 }
Response Fields Detail
Fields | Description |
---|---|
DocImage byte[] |
Document image in bytes. |
MIMEType string |
MIME type. Example : .pdf,.png,.jpg, .jpeg |
DocumentType Int32 |
Document Type Valid Values: 1, 2, etc. Example : 1= Cardholder Dispute Form, 2 = Merchant Communication Letter/email Please refer appendix Section : Document Type |
DocumentUniqueID Int32 |
System generated unique Document ID. Example: 1,2,3 etc. |
DocumentList array |
DisputeDocuments description |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "DocumentList": [ { "DocImage": "RG9jSW1hZ2U=", "MIMEType": ".pdf", "DocumentType": 2, "DocumentUniqueID": 317, "DocumentName": "Doc2.pdf", "DocumentUploadedBy": "admin", "DocumentUploadedDate": "2020-12-22T00:00:00", "DocumentStatus": "Archived", "DocumentFileSize": "0.0020 KB" } ] } }
GetDisputeCaseHistory
Action: POST
Endpoint: /api/GetDisputeCaseHistory
Use this API to fetch the case history of a dispute transaction.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CaseID Int64 Conditional |
ID which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198 Condition: At least one of Case ID or TransactionID is required. Allowable Values: 10 |
TransactionID string Conditional |
Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example:147852369 Condition: At least one of Case ID or TransactionID is required. Allowable Values: 19 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CaseID": 9856198, "TransactionID": "" }
Response Fields Detail
Fields | Description |
---|---|
DisputeCaseHistoryList array |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "DisputeCaseHistoryList": [ { "CaseID": 9856198, "CaseHistoryDate": "2020-12-22T00:00:00", "ReasonCode": "2", "UserID": "adminuser", "TransactionAmount": 100.11, "DisputeAmount": 600.3, "Notes": "", "DisputeStatusDescription": "" } ] } }
GetDisputeDetails
Action: POST
Endpoint: /api/GetDisputeDetails
Use this API to fetch the Dispute Transaction Details.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CaseID Int64 Conditional |
ID which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198 Condition: At least one of Case ID or TransactionID is required. Allowable Values: 10 |
TransactionID string Conditional |
Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example:147852369 Condition: At least one of Case ID or TransactionID is required. Allowable Values: 19 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CaseID": 9856198, "TransactionID": "" }
Response Fields Detail
Fields | Description |
---|---|
TransactionAmount decimal |
Transaction Amount Valid Values: 0-9 Example:100.11 |
TransactionID string |
Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Valid alues: 0-9 Example: 147852369 |
TransactionCurrencyCode string |
Transaction Currency Code Valid Values:0-9 Example:840 Appendix Section: Refer Appendix Section: Primary Currency Code |
MerchantName string |
Name of the merchant and its location from where the transaction initiated |
Association string |
Name of network of transaction. Example: Visa, MasterCard, Discover, Pulse, Star |
TransactionDate datetime |
Date of transaction posted on account Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00 |
DisputeDetailList array |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "TransactionAmount": 100.11, "TransactionID": "926200438", "TransactionCurrencyCode": "USD", "MerchantName": "BRIGHTSPARK TRAVEL INC", "Association": "PULSE", "TransactionDate": "2020-12-22T00:00:00", "DisputeDetailList": [ { "CaseID": 9856198, "ReasonCodeCategory": "1", "ReasonCode": "2", "ChargebackType": 1, "DisputeAmount": 10.0, "CaseStatus": "Open", "NoteReason": "Disputed Transaction", "Notes": "raising a dispute", "DisputeStatusDescription": "Initiate Dispute", "DisputeResolveAmount": 10.0, "DisputeInitiationDate": "2020-12-22T00:00:00", "DisputeClosedDate": "2020-12-22T00:00:00", "DisputeStage": "Initiate Dispute" } ] } }
GetNetworkDataDetails
Action: POST
Endpoint: /api/GetNetworkDataDetails
Use this API to fetch the VROL Dispute Transaction Details.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CaseID Int64 Mandatory |
ID which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198 Allowable Values: 10 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CaseID": 9856198 }
Response Fields Detail
Fields | Description |
---|---|
DisputeConditionCode string |
Dispute Condition Code through which Dispute raised in VROl platform. |
VROLFinancialID string |
Financial ID which is generated at VROL platform to track the Dispute. |
VROLCaseNumber string |
Case Number which is generated at VROL platform to track the Dispute. |
VROLBundleCaseNumber string |
Bundle Case Number which is generated at VROL platform to track the number of Disputes under the same ID. |
RaisedChargebackDate datetime |
The Date on which the Chargeback is raised at Network. |
ReasonCode string |
Reason Code for Dispute. |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "DisputeConditionCode": "123", "VROLFinancialID": "FID-123", "VROLCaseNumber": "CS-123", "VROLBundleCaseNumber": "BCN-123", "RaisedChargebackDate": "2020-12-22T00:00:00", "ReasonCode": "RC-123" } }
ManageDispute
Action: POST
Endpoint: /api/ManageDispute
Use this API to update the dispute against a Transaction.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CaseID Int64 Mandatory |
ID which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198 Allowable Values: 10 |
ReasonCodeCategory string Optional |
Reason Code Category for Dispute. Please refer appendix Section : Reason Code Category Allowable Values: 2 |
ReasonCode string Optional |
Reason Code for Dispute. Please refer appendix Section : Reason Code Allowable Values: 4 |
ChargebackType Int32 Optional |
Chargeback Type shows the Dispute Amount should be Full or Partial. Valid Values: 1 and 2 Example: 1 = Full and 2 = partial Allowable Values: 1 |
DisputeAmount decimal Conditional |
Disputed amount on the card. Example:600.30 Condition: If the value in ‘Chargeback Type’ field is given as 2, then this field should become Mandatory. |
Notes string Optional |
Notes entered by the user Valid Values : A-Z,0-9 Example : Card found Allowable Values: 2000 |
DisputeStatusCode string Optional |
Status of the Dispute. Please refer appendix Section : Dispute Status. Valid Values: 0-9 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CaseID": 9856198, "ReasonCodeCategory": "5", "ReasonCode": "3", "ChargebackType": 1, "DisputeAmount": 6.33, "Notes": "", "DisputeStatusCode": "1" }
Response Fields Detail
Fields | Description |
---|
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "CaseID": 9856198 } }
RaiseDispute
Action: POST
Endpoint: /api/RaiseDispute
Use this API to raise the dispute for a Transaction. Dispute can be raised as Full or Partial.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
AccountNumber string Conditional |
Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition: At least one of Proxy Number/Account Number is required. Allowable Values: 19 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Proxy Number/Account Number is required. Allowable Values: 19 |
TransactionID string Mandatory |
Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example : 147852369 Allowable Values: 19 |
ReasonCodeCategory string Mandatory |
Reason Code Category for Dispute. Valid values: 0-9 Please refer appendix Section : Reason Code Category Allowable Values: 2 |
ReasonCode string Optional |
Reason Code for Dispute. Please refer appendix Section : Reason Code Allowable Values: 4 |
ChargebackType Int32 Optional |
Chargeback Type shows the Dispute Amount should be Full or Partial. By default 1. Valid Values: 1 and 2 Example: 1 = Full and 2 = partial Allowable Values: 1 |
DisputeAmount decimal Conditional |
Disputed amount on the card. Example:600.30 Condition: If the value in ‘Chargeback Type’ field is given as 2, then this field should become Mandatory. |
Notes string Mandatory |
Notes entered by the user Valid Values : A-Z,0-9 Example : Card found Allowable Values: 2000 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "AccountNumber": "", "ProxyNumber": "1316728", "TransactionID": "147852369", "ReasonCodeCategory": "2", "ReasonCode": "80", "ChargebackType": 1, "DisputeAmount": 5.3, "Notes": "Raising dispute on the transaction" }
Response Fields Detail
Fields | Description |
---|---|
CaseID Int64 |
ID which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198 |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "CaseID": 9856198 } }
UpdateNetworkDataDetails
Action: POST
Endpoint: /api/UpdateNetworkDataDetails
Use this API to update the Raised Chargeback Date and/or Reason Code of Chargeback details.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CaseID Int64 Mandatory |
ID which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198 Allowable Values: 10 |
ReasonCode string Conditional |
Reason Code for Dispute which is being generated at Network. Condition: Either Raised Chargeback Date or Reason Code is mandatory. Allowable Values: 4 |
RaisedChargebackDate datetime Conditional |
The Date on which the Chargeback is raised at Network. Condition: Either Raised Chargeback Date or Reason Code is mandatory. |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CaseID": 9856198, "ReasonCode": "1", "RaisedChargebackDate": "2020-08-31T00:00:00" }
Response Fields Detail
Fields | Description |
---|
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": null }