Dispute Case Management API

Scroll down for code samples, example requests and responses.
Select a language for code samples from the tabs or the mobile navigation menu.

disputes

createDispute

POST /api/v1/disputes

Parameters

Request body

cardNumberstringoptional
Card number of the transaction to be disputed, card number must be encrypted with RSA 2048 bit, public key will be shared by NETS
acqReferenceDatastringoptional
Acquirer Reference Data of the transaction to be disputed. Referred as ARN for VISA transactions and ARD for MasterCard transactions
cardBlockedstringoptional
Status of the card. Y – Blocked N – Not blocked
cardExpiryDatestring (date)optional
Card expiry date
cardHolderNamestringoptional
Name of the Cardholder
cardSchemeDisputeReasonCodestringoptional
Card Scheme Dispute reason code to be used for reporting chargebacks. Conditional – to be filled if it is a straight through case, and Card Scheme Retrieval Request and Card Scheme Fraud reason code are not filled. In Case of straight through cases, when No Card Scheme Reason Code (Dispute/Fraud/Retrieval) is present, dispute will not be created and the create dispute request will be rejected with an error message. when the case is not a Straight through case, this field is optional.
cardSchemeFraudReasonCodestringoptional
Card Scheme Fraud reason code to be used if the transaction needs to be fraud reported. Conditional – to be filled if it is a straight through case, and Card Scheme Retrieval Request and Card Scheme Dispute reason code are not filled.

In Case of straight through cases, when No Card Scheme Reason Code (Dispute/Fraud/Retrieval) is present, dispute will not be created and the create dispute request will be rejected with an error message. when the case is not a Straight through case, this field is Optional.
cardSchemeRetrvRequestReasonCodestringoptional
Card Scheme Retrieval Request reason code to be used. Conditional – to be filled if it is a straight through case, and Card Scheme Fraud reason code and Card Scheme Dispute reason code are not filled.

In Case of straight through cases, when No Card Scheme Reason Code (Dispute/Fraud/Retrieval) is present, dispute will not be created and the create dispute request will be rejected with an error message.

when the case is not a Straight through case, this field is Optional.
cardSchemeTransactionIDstringoptional
Unique transaction identifier of the transaction issued by Card Schemes 1) MasterCard : DE 63 Transaction Life Cycle ID 2) VISA : Transaction Identifier - TCR 5 Position 5 - 19).This unique transaction ID is only available on Not-ONUS transactions.
caseHandlerIDstringoptional
Identification of case handler , stored as business data in NETS. This will not be the user id
claimValidationRequiredstringoptional
Indication of a normal case or a difficult case. 1) Y – Manual verification required by NETS after submitting the dispute (Difficult case) 2) N – Manual verification not required (Normal case) by NETS and can be directly sent for chargeback to scheme. In Case of straight through cases it should be filled with N.
disputeAmountnumberoptional
Amount to be disputed on the transaction. Required only when there is need for chargeback. i.e when Dispute reason is filled. (signed)
disputeCurrencystringoptional
Currency of the transaction to be disputed
documentsListarrayoptional
- documentBinarystring (byte)optional
- documentIDstringoptional
- documentTypestringoptional
- mimeTypestringoptional
interimAccountstringoptional
Account number to be used for bookkeeping
issuerSuperCaseIDstringoptional
Unique identifier used to identify the Super Case in Issuer’s system. Disputes with the same Issuer Super Case ID
issuerTransactionIDstringoptional
Unique identifier used to identify the transaction in dispute system
netsDisputeReasonCodestringoptional
Nets Dispute reason code to be used for reporting chargebacks. Conditional – To be filled when the case is not a Straight through case, and Retrieval Request and Fraud reason code are not filled. One of the Nets Reason Code (Dispute, Fraud, Retrieval) is always Mandatory, when cases are not straight through In Case of straight through cases when Nets Reason Code (Dispute, Fraud, Retrieval) is not filled, dispute will be created with default dispute reason code D019.
netsFraudReasonCodestringoptional
Nets Fraud reason code to be used if the transaction needs to be fraud reported. Conditional – To be filled when the case is not a Straight through case and when Retrieval Request and Dispute reason code are not filled. One of the Nets Reason Code (Dispute, Fraud, Retrieval) is always Mandatory In Case of straight through cases when Nets Reason Code (Dispute, Fraud, Retrieval) is not filled, dispute will be created with default dispute reason code D019.
netsRetrvRequestReasonCodestringoptional
Nets Retrieval Request reason code to be used. Conditional – To be filled when the case is not a Straight through case and when Dispute Reason and Fraud reason code are not filled.

One of the Nets Reason Code (Dispute, Fraud, Retrieval) is always Mandatory

In Case of straight through cases when Nets Reason Code (Dispute, Fraud, Retrieval) is not filled, dispute will be created with default dispute reason code D019.
netsTransactionIDstringoptional
Identifier of the card transaction in Nets Clearing system.
notesstringoptional
Comments from Issuer
transactionAmountnumberoptional
Purchase amount of the transaction to be disputed (signed)
transactionCurrencystringoptional
Purchase currency of the transaction to be disputed
transactionDatestring (date)optional
Purchase date of the transaction to be disputed. YYYY-MM-DD
transactionTimestring (date)optional
Purchase time of the transaction to be disputed. If not available, then 00:00:00
additionalDataListarrayoptional
- namestringoptional
- valuestringoptional

Request body

{
    "cardNumber": "string",
    "acqReferenceData": "string",
    "cardBlocked": "string",
    "cardExpiryDate": "2019-08-24",
    "cardHolderName": "string",
    "cardSchemeDisputeReasonCode": "string",
    "cardSchemeFraudReasonCode": "string",
    "cardSchemeRetrvRequestReasonCode": "string",
    "cardSchemeTransactionID": "string",
    "caseHandlerID": "string",
    "claimValidationRequired": "string",
    "disputeAmount": 0,
    "disputeCurrency": "string",
    "documentsList": [
        {
            "documentBinary": "string",
            "documentID": "string",
            "documentType": "string",
            "mimeType": "string"
        }
    ],
    "interimAccount": "string",
    "issuerSuperCaseID": "string",
    "issuerTransactionID": "string",
    "netsDisputeReasonCode": "string",
    "netsFraudReasonCode": "string",
    "netsRetrvRequestReasonCode": "string",
    "netsTransactionID": "string",
    "notes": "string",
    "transactionAmount": 0,
    "transactionCurrency": "string",
    "transactionDate": "2019-08-24",
    "transactionTime": "2019-08-24",
    "additionalDataList": [
        {
            "name": "string",
            "value": "string"
        }
    ]
}

Responses

200OKoptional
- disputeCaseNumberstringoptional
  Case number of the disputed transaction
- disputeGroupNumberstringoptional
  Disptue Case group of the claim created in NETS. Disputes reported on a card number on a day at different times will get same case group ID
- responseCodestringoptional
  Status of the dispute case creation. 00 – Case with all documents successfully created, 01 – Case created successfully with few documents; 99 – Case creation failed
- disputeErrorCodestringoptional
  Error code indicating failure of the dispute creation
  
  DIS0001E System error. Please contact system administrator at Nets
  
  DIS0002E There are no transaction based on the search criteria
  
  DIS0003W There are more than one transaction for the search criteria. Dispute case created on latest transaction matching
  
  DIS0004E Please enter all mandatory search criteria
  
  DIS0005E Invalid dispute amount
  
  DIS0009E Dispute already exists for the transaction
  
  DIS0012E Invalid date. Expected format is yyyy-MM-dd
- disputeErrorCodeTextstringoptional
  Text associated with the error code
- documentsErrorListarrayoptional
  - claimIDstringoptional
  - documentErrorCodestringoptional
  - documentErrorTextstringoptional
  - documentIDstringoptional
- issuerSuperCaseIDstringoptional
  Unique identifier used to identify the Super Case in Issuer’s system
- issuerTransactionIDstringoptional
  Unique identifier used to identify the transaction in Issuer’s system
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "disputeCaseNumber": "string",
    "disputeGroupNumber": "string",
    "responseCode": "st",
    "disputeErrorCode": "string",
    "disputeErrorCodeText": "string",
    "documentsErrorList": [
        {
            "claimID": "string",
            "documentErrorCode": "string",
            "documentErrorText": "string",
            "documentID": "string"
        }
    ],
    "issuerSuperCaseID": "string",
    "issuerTransactionID": "string"
}

getDocument

GET /api/v1/disputes/document/{documentId}

Parameters

documentIdstringrequired
documentId
encodingstringoptional
encoding
sizeLimitstringoptional
sizeLimit

Responses

200OKoptional
- descriptionstringoptional
- fileobjectoptional
  - absolutebooleanoptional
  - absolutePathstringoptional
  - canonicalPathstringoptional
  - directorybooleanoptional
  - filebooleanoptional
  - freeSpaceinteger (int64)optional
  - hiddenbooleanoptional
  - namestringoptional
  - parentstringoptional
  - pathstringoptional
  - totalSpaceinteger (int64)optional
  - usableSpaceinteger (int64)optional
- filenamestringoptional
- inputStreamobjectoptional
- openbooleanoptional
- readablebooleanoptional
- uriobjectoptional
  - absolutebooleanoptional
  - authoritystringoptional
  - fragmentstringoptional
  - hoststringoptional
  - opaquebooleanoptional
  - pathstringoptional
  - portinteger (int32)optional
  - querystringoptional
  - rawAuthoritystringoptional
  - rawFragmentstringoptional
  - rawPathstringoptional
  - rawQuerystringoptional
  - rawSchemeSpecificPartstringoptional
  - rawUserInfostringoptional
  - schemestringoptional
  - schemeSpecificPartstringoptional
  - userInfostringoptional
- urlobjectoptional
  - authoritystringoptional
  - contentobjectoptional
  - defaultPortinteger (int32)optional
  - filestringoptional
  - hoststringoptional
  - pathstringoptional
  - portinteger (int32)optional
  - protocolstringoptional
  - querystringoptional
  - refstringoptional
  - userInfostringoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "description": "string",
    "file": {
        "absolute": true,
        "absolutePath": "string",
        "canonicalPath": "string",
        "directory": true,
        "file": true,
        "freeSpace": 0,
        "hidden": true,
        "name": "string",
        "parent": "string",
        "path": "string",
        "totalSpace": 0,
        "usableSpace": 0
    },
    "filename": "string",
    "inputStream": {},
    "open": true,
    "readable": true,
    "uri": {
        "absolute": true,
        "authority": "string",
        "fragment": "string",
        "host": "string",
        "opaque": true,
        "path": "string",
        "port": 0,
        "query": "string",
        "rawAuthority": "string",
        "rawFragment": "string",
        "rawPath": "string",
        "rawQuery": "string",
        "rawSchemeSpecificPart": "string",
        "rawUserInfo": "string",
        "scheme": "string",
        "schemeSpecificPart": "string",
        "userInfo": "string"
    },
    "url": {
        "authority": "string",
        "content": {},
        "defaultPort": 0,
        "file": "string",
        "host": "string",
        "path": "string",
        "port": 0,
        "protocol": "string",
        "query": "string",
        "ref": "string",
        "userInfo": "string"
    }
}

getDispute

POST /api/v1/disputes/list

Parameters

Request body

additionalSearchIndexarrayoptional
- indexNamestringoptional
- indexValuestringoptional
cardIdstringoptional
cardNumberstringoptional
disputeCaseNumberstringoptional
disputeCaseStatusstringoptional
disputeCreatedDatestringoptional
disputeGroupNumberstringoptional
disputeModifiedDatestringoptional
historystringoptional
nextPageKeystringoptional
numberOfDisputeCasesinteger (int32)optional

Request body

{
    "additionalSearchIndex": [
        {
            "indexName": "string",
            "indexValue": "string"
        }
    ],
    "cardId": "string",
    "cardNumber": "string",
    "disputeCaseNumber": "string",
    "disputeCaseStatus": "string",
    "disputeCreatedDate": "string",
    "disputeGroupNumber": "string",
    "disputeModifiedDate": "string",
    "history": "string",
    "nextPageKey": "string",
    "numberOfDisputeCases": 0
}

Responses

200OKoptional
- disputeCaseListarrayoptional
  - authorisationSituationstringoptional
  - cardSchemestringoptional
  - clearingSettlementAmountnumberoptional
  - clearingSettlementCurrencystringoptional
  - clearingSettlementDatestringoptional
  - clearingSituationstringoptional
  - clearingTransactionAmountnumberoptional
  - clearingTransactionCurrencystringoptional
  - clearingTransactionDatestringoptional
  - disputeAdditionalDataarrayoptional
    namestringoptional
    valuestringoptional
  - disputeCaseNumberstringoptional
  - disputeCaseReasonListarrayoptional
    cardSchemeReasonstringoptional
    disputeCaseReasonstringoptional
    disputeCaseReasonTypestringoptional
  - disputeCreatedDatestringoptional
  - disputeDocumentListarrayoptional
    documentDescriptionstringoptional
    documentIdstringoptional
    documentTypestringoptional
    updateTimeStampstringoptional
    userstringoptional
  - disputeDueDatestringoptional
  - disputeGroupNumberstringoptional
  - disputeGroupStatusstringoptional
  - disputeSettlementAmountnumberoptional
  - disputeSettlementCurrencystringoptional
  - disputeSettlementDatestringoptional
  - disputeStatusListarrayoptional
    caseStatusUserIdstringoptional
    disputeCaseFreeTextstringoptional
    disputeCaseOtherActionsstringoptional
    disputeCaseStatusstringoptional
    disputeCaseStatusTextstringoptional
    disputeCaseStatusTimestampstringoptional
  - disputeTransactionAmountnumberoptional
  - disputeTransactionCurrencystringoptional
  - issuerResponseDueDatestringoptional
  - maskedCardNumberstringoptional
  - merchantAddressstringoptional
  - merchantCategorystringoptional
  - merchantCategoryTextstringoptional
  - merchantCountrystringoptional
  - merchantLocationstringoptional
  - merchantNamestringoptional
  - panIdstringoptional
  - queueNamestringoptional
- disputeErrorCodestringoptional
- disputeErrorCodeTextstringoptional
- disputeGroupQueuestringoptional
- moreDisputeFlagstringoptional
- nextPageKeystringoptional
- numberOfDisputeCasesinteger (int32)optional
- responseCodestringoptional
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "disputeCaseList": [
        {
            "authorisationSituation": "string",
            "cardScheme": "string",
            "clearingSettlementAmount": 0,
            "clearingSettlementCurrency": "string",
            "clearingSettlementDate": "string",
            "clearingSituation": "string",
            "clearingTransactionAmount": 0,
            "clearingTransactionCurrency": "string",
            "clearingTransactionDate": "string",
            "disputeAdditionalData": [
                {
                    "name": "string",
                    "value": "string"
                }
            ],
            "disputeCaseNumber": "string",
            "disputeCaseReasonList": [
                {
                    "cardSchemeReason": "string",
                    "disputeCaseReason": "string",
                    "disputeCaseReasonType": "string"
                }
            ],
            "disputeCreatedDate": "string",
            "disputeDocumentList": [
                {
                    "documentDescription": "string",
                    "documentId": "string",
                    "documentType": "string",
                    "updateTimeStamp": "string",
                    "user": "string"
                }
            ],
            "disputeDueDate": "string",
            "disputeGroupNumber": "string",
            "disputeGroupStatus": "string",
            "disputeSettlementAmount": 0,
            "disputeSettlementCurrency": "string",
            "disputeSettlementDate": "string",
            "disputeStatusList": [
                {
                    "caseStatusUserId": "string",
                    "disputeCaseFreeText": "string",
                    "disputeCaseOtherActions": "string",
                    "disputeCaseStatus": "string",
                    "disputeCaseStatusText": "string",
                    "disputeCaseStatusTimestamp": "string"
                }
            ],
            "disputeTransactionAmount": 0,
            "disputeTransactionCurrency": "string",
            "issuerResponseDueDate": "string",
            "maskedCardNumber": "string",
            "merchantAddress": "string",
            "merchantCategory": "string",
            "merchantCategoryText": "string",
            "merchantCountry": "string",
            "merchantLocation": "string",
            "merchantName": "string",
            "panId": "string",
            "queueName": "string"
        }
    ],
    "disputeErrorCode": "string",
    "disputeErrorCodeText": "string",
    "disputeGroupQueue": "string",
    "moreDisputeFlag": "string",
    "nextPageKey": "string",
    "numberOfDisputeCases": 0,
    "responseCode": "string"
}

getCasesByQueue

POST /api/v1/disputes/list-cases-by-queue

Parameters

Request body

accessTokenstringoptional
additionalInformationListarrayoptional
- namestringoptional
- valuestringoptional
isOpenstringoptional
nextPageKeystringoptional
passwordstringoptional
queueIDinteger (int32)optional
userIDstringoptional

Request body

{
    "accessToken": "string",
    "additionalInformationList": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "isOpen": "string",
    "nextPageKey": "string",
    "password": "string",
    "queueID": 0,
    "userID": "string"
}

Responses

200OKoptional
- caseListarrayoptional
  - acquiringReferenceNumberstringoptional
  - disputeCaseNumberstringoptional
  - maskedCardNumberstringoptional
- errorCodestringoptional
- errorTextstringoptional
- moreDisputeFlagstringoptional
- nextPageKeystringoptional
- numberOfCasesinteger (int32)optional
- queueNamestringoptional
- responseCodestringoptional
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "caseList": [
        {
            "acquiringReferenceNumber": "string",
            "disputeCaseNumber": "string",
            "maskedCardNumber": "string"
        }
    ],
    "errorCode": "string",
    "errorText": "string",
    "moreDisputeFlag": "string",
    "nextPageKey": "string",
    "numberOfCases": 0,
    "queueName": "string",
    "responseCode": "string"
}

updateDispute

PATCH /api/v1/disputes/{disputeId}

Parameters

disputeIdstringrequired
disputeId

Request body

accessTokenstringoptional
acknowledgeClosurestringoptional
additionalInformationListarrayoptional
- namestringoptional
- valuestringoptional
cardIDstringoptional
cardNumberstringoptional
closeDisputestringoptional
disputeCaseNumberstringoptional
disputeGroupNumberstringoptional
documentsListarrayoptional
- documentBinarystring (byte)optional
- documentIDstringoptional
- documentTypestringoptional
- mimeTypestringoptional
interimAccountstringoptional
notesstringoptional
passwordstringoptional
privateNotesstringoptional
rejectClosurestringoptional
submitDisputestringoptional
userIDstringoptional

Request body

{
    "accessToken": "string",
    "acknowledgeClosure": "string",
    "additionalInformationList": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "cardID": "string",
    "cardNumber": "string",
    "closeDispute": "string",
    "disputeCaseNumber": "string",
    "disputeGroupNumber": "string",
    "documentsList": [
        {
            "documentBinary": "string",
            "documentID": "string",
            "documentType": "string",
            "mimeType": "string"
        }
    ],
    "interimAccount": "string",
    "notes": "string",
    "password": "string",
    "privateNotes": "string",
    "rejectClosure": "string",
    "submitDispute": "string",
    "userID": "string"
}

Responses

200OKoptional
- documentsErrorListarrayoptional
  - claimIDstringoptional
  - documentErrorCodestringoptional
  - documentErrorTextstringoptional
  - documentIDstringoptional
- errorCodestringoptional
- errorTextstringoptional
- responseCodestringoptional
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "documentsErrorList": [
        {
            "claimID": "string",
            "documentErrorCode": "string",
            "documentErrorText": "string",
            "documentID": "string"
        }
    ],
    "errorCode": "string",
    "errorText": "string",
    "responseCode": "string"
}