v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Supporting forms

Update dispute form

Update a dispute form - only if status is PENDING or FAILED.

put/v1/disputes/{disputeId}/forms/{disputeFormId}

Path parameters

disputeIdnumber required

Dispute ID

disputeFormIdnumber required

Dispute form ID

Request body

dispute_installment_idnumber

Dispute installment ID. If not passed, the first installment is used

Example request

{
  "form": {
    "ebdf": {
      "fraudDrfDocument": {
        "numberOfItems": "1",
        "types": "CARD_CLOSED",
        "additionalInformation": "Test additional information",
        "chargebackRepresentative": "Test representative",
        "cardIssuerRegion": "Europe",
        "cardholderVerificationMethod": {
          "onlinePIN": "1",
          "offlinePIN": "2",
          "signature": "3",
          "none": "4"
        }
      },
      "cardholderDisputeChargebackDrfDocument": {
        "transactionAmount": "100.00",
        "type": "PRODUCT_DISPUTE",
        "deliveryDateOfGoodsOrServices": "18-FEB-2018",
        "expectedDeliveryDateOfGoodOrServices": "18-FEB-2018",
        "returnDate": "18-FEB-2018",
        "cancellationDate": "18-FEB-2018",
        "disputeDetails": "Test dispute details...",
        "chargebackRepresentative": "Ahsta LaVista Baybee"
      },
      "pointOfInteractionErrorsDrfDocument": {
        "transactionAmount": "20000",
        "type": "DUPLICATE_DEBIT",
        "alternateMeansOfPaymentDetails": "Test alternate means of payment details",
        "disputeDetails": "Test Dispute details",
        "chargebackRepresentative": "Test Representative"
      }
    },
    "allocationQuestionnaire": {
      "accountStatus": "AC",
      "oneAuthForMultipleSalesInd": "Y"
    },
    "collaborationQuestionnaire": {
      "incorrectCurrencyReason": "CD",
      "authorizationRequestDeclinedValidDataInd": true,
      "explainWhyValidDataInclusionReason": "Explain why the inclusion of valid data would have caused the Authorization Request to be declined",
      "correctCurrency": 986,
      "cardholderDidNotAgreeDCC": "Y",
      "transactionCodeIncorrect": "CRI",
      "rolTransactionId": 123,
      "explainWhyCreditRefundProcessedInError": "Explain why the credit refund was processed in error",
      "issuerMasterFileAccountNumberInd": "Y",
      "receiptAccountNumberMatchInd": "Y",
      "cardholderReceiptAmt": 12,
      "merchantDisputePriceDiffInd": "Y",
      "bothTransactionsOnSameAcctNumberInd": "Y",
      "duplicateTranId": "123456789012345",
      "issuerOrCardholderOtherAcctWithDiffVisaCardInd": "Y",
      "issuerEvidenceMerchantPassedOnFundsInd": "Y",
      "cardholderAttemptToResolve": "Y",
      "attemptToResolveProhLocalLaw": "Y",
      "otherTranSameMerchantInd": "Y",
      "providingPaymentProofOtherMeans": "A",
      "arn": "001122334455667788991234",
      "transactionID": "123456789012345",
      "cancellationDate": "2022-05-20",
      "contactMethodWithMerchantInd": true,
      "contactMethodMerchantEmailInd": true,
      "contactMethodMerchantCallCenterInd": true,
      "contactMethodMerchantMailInd": true,
      "contactMethodMerchantSMSInd": true,
      "contactMethodMerchantInPersonInd": true,
      "contactMethodMerchantWebformInd": true,
      "otherFormOfPaymentInd": true,
      "accountClosureDate": "2022-05-20",
      "disputeRelateToInd": "Y",
      "contractDate": "2022-05-20",
      "merchandiseOrServices": "Merchandise",
      "serviceType": "T",
      "whatWasPurchased": "Provide details of what was purchased...",
      "cardholderReceiveMerchandiseInd": "Y",
      "chReceivedOrExpectedMerchandise": "2022-05-20",
      "cardholderReturnMerchandiseInd": "Y",
      "cardholderReturnedMerchandiseDate": "2022-05-20",
      "returnedMerchandiseReceivedDate": "2022-05-20",
      "returnMethod": "FF",
      "howMerchandiseReturned": "Explain how the merchandise was returned...",
      "shippingTrackingNumber": "774-4u7u3-u4u4u-35347",
      "attemptedReturnDate": "2022-05-20",
      "howChAttemptReturnAndDispOfMerchandise": "Provide a detailed description of how the cardholder attempted to return and the disposition of the merchandise.",
      "merchantRefuseAdvise": "MRRM",
      "didCardholderCancel": "Y",
      "didCardholderCancelBeforeShipping": "Y",
      "timeshareDate": "2022-05-20",
      "dateOfService": "2022-05-20",
      "certificationGuaranteedReservation": "GR",
      "cancellationPolicyProvidedInd": "Y",
      "whatWasOrdered": "What was ordered...",
      "merchandiseWasCounterfeitDate": "2022-05-20",
      "descCounterfeitMerchandise": "Describe the counterfeit merchandise",
      "descDispOfCounterfeitMerchandise": "Describe the disposition of the counterfeit merchandise",
      "originalCreditNotAccepted": "R",
      "explain": "Explain",
      "creditVoucherTransactionReceiptDated": "Y",
      "creditVoucherOrTransactionReceiptDate": "2022-05-20",
      "cardholderCancelledReturnedMerchDate": "2022-05-20",
      "merchantInLiquidationOrReceivershipInd": "Y",
      "whatWasNotReceived": "What was not received?",
      "thirdPartyGiftCardInd": "Y",
      "visaComCardVirtualAccInd": "Y",
      "virtualAccFinancialLossInd": "Y",
      "didMerchantCancelInd": "Y",
      "merchantCancellationDate": "2022-05-20",
      "nonReceiptOfTravelServicesInd": "Y",
      "disputeInvolveBondingAuthorityInd": "Y",
      "explainAttemptToResolveWithBondAuth": "Provide an explanation of the attempt to resolve the dispute with the bonding authority/insurance scheme or where the information was obtained to confirm an insufficient bond/insurance scheme",
      "bondAuthLetterOrAdviceDate": "2022-05-20",
      "purchasedInfo": "Provide detailed description of what was purchased and an explanation of the dispute",
      "expectedReceiptDate": "2022-05-20",
      "expectedReceiptTime": "10:30",
      "explainDisputePriorDeliveryDate": "Explanation of dispute initiated prior to the expected delivery date",
      "didCardholderCancelPriorExpectedDate": "Y",
      "merchandiseDeliveredWrongLocation": "Y",
      "lateDeliveryWrongLocation": "Provide address of the agreed location or details of late delivery",
      "didMerchantCancelMerchandiseInd": "Y",
      "merchantCancelMerchandiseDate": "What was ordered and how it was damaged",
      "merchandiseReceivedDate": "2022-05-20",
      "cardholderMerchantPreviousNegotiationEvidence": "Y",
      "whenNegotiationsBegin": "2022-05-20",
      "explainPrevNegotiation": "Explain the previous ongoing negotiations between the cardholder and merchant.",
      "cardholderFirstNotifiedIssuerDisputeDate": "2022-05-20",
      "serviceReceivedDate": "2022-05-20",
      "howMerchandiseOrServiceMisrepresented": "How was the merchandise or service misrepresented?",
      "merchandiseServiceReceivedDate": "2022-05-20",
      "explainPreNegotiation": "Explain the previous ongoing negotiations between the cardholder and merchant.",
      "orderDetailsNotAsDescribed": "Provide details of what was ordered and not as described",
      "merchantReceivedReturnedMerchandiseDate": "2022-05-20",
      "merchantAcceptCancellationInd": "Y",
      "purchasedInfoAndQualityIssue": "Provide information about what was purchased and the quality issue",
      "didCardholderPayWorkRedone": "Y",
      "howTermsOfContractNotHonoredByMerchant": "Provide details how the terms of the contract were either not honored by the merchant or not as described",
      "nonFiatCurrencyNotDelivered": "Y",
      "merchandiseDeliveredLate": "Y",
      "merchantInBankruptcyLiquidationInd": "Y",
      "nonFiatCurrencyNotMatching": "Y",
      "dispositionOfMerchandise": "a"
    },
    "preArbitration": {
      "preArbReason": "Reason for pre-aritration",
      "newInformationInd": "Y",
      "newInformationDescription": "New information..."
    },
    "clearingElo": {
      "additionalDataRecord": {
        "airportTaxValue": "000000000000",
        "changeValue": "00000000000",
        "codeProduct": "071",
        "conditionalCodeChipTransaction": "0, 1, 2",
        "cpfOrCnpj": "00000000000000",
        "feePaymentInput": "00000",
        "indicatorMovement": "0",
        "installmentNumber": "000",
        "logicalNumberEquipment": "20172289",
        "numberInstallmentsTransaction": "000",
        "pointOfSale": "000000000000001",
        "referenceNumberDispute": "000000",
        "transactionCode": "06",
        "transactionIndicator": "8",
        "transactionSubCode": "01",
        "transactionValue": "000000000000",
        "walletId": "00000000000"
      },
      "authorizationCode": "661810",
      "caller": "ELO",
      "clearingType": "CREDIT",
      "endpoint": "000666",
      "headerServiceFile": {
        "codeAcquirer": "0000",
        "codeProcessor": "3178",
        "emittingBank": "0985",
        "fileVersion": "231",
        "flagCode": "007",
        "futureUse2": "0",
        "returnDateArchive": "00000000",
        "returnTimeArchive": "000000",
        "routeIndicatorArchive": "1",
        "sendDate": "20230717",
        "serviceCode": "10",
        "shipmentNumber": "0177",
        "shippingDate": "20230717",
        "shippingTimeArchive": "152300",
        "transactionSubCode": "B0",
        "windowNumber": " "
      },
      "mainDataRecord": {
        "authorizationOrCancellationOriginIndicator": "1",
        "cardholderVerificationMethod": "1",
        "codeAcquirer": "9000",
        "codeAuthorizationTransaction": "661810",
        "codeCurrency": "986",
        "codeFlag": "007",
        "codeReasonDispute": "00",
        "futureUse2": "00",
        "futureUse4": "0",
        "futureUse5": "0000",
        "identificationTransaction": "1",
        "numberReferenceTransaction": "70090003198000000723318",
        "pointOfSaleCity": "ZAMBAS",
        "pointOfSaleCountryCode": "BR",
        "pointOfSaleMcc": "6531",
        "pointOfSaleName": "Lns",
        "posEntryMode": "07",
        "processCode": "53",
        "processingDate": "20230717",
        "sellValue": "000000001000",
        "terminalCapability": "V",
        "transactionCode": "06",
        "transactionDate": "20230717",
        "transactionSubCode": "00",
        "transactionTime": "092225"
      },
      "messageNumber": "157",
      "orgId": "TN-41234404-7994-46d5-83d6-a55cxxxxxxxx",
      "registrationFundsTransferData": {
        "cardBIN": "00000000",
        "identificationNumberOfPersonImpacted": "18230565371336",
        "last4DigitsCard": "0000",
        "nameCarrier": "bR1YsI xhDVQNL",
        "originFunds": "02",
        "phoneCarrier": "00000000000",
        "transactionCode": "06",
        "transactionSubCode": "P2P",
        "typePayment": "06"
      },
      "registrationPaymentServiceData": {
        "amountAuthorized": "000000001000",
        "codeAnswerAuthorization": "00",
        "codeCurrencyValueAuthorized": "986",
        "futureUse19": "00",
        "identifierTransaction": "202289723318",
        "indicatorBusinessElectronic": "00",
        "transactionCode": "06",
        "transactionSubCode": "05",
        "valueAuthorized": "000000001000"
      },
      "settlementCountryDataRecord": {
        "countryCodeSettlement": "BR",
        "dateLiquidationTransaction": "20230718",
        "dateMovementTransactionOriginal": "00000000",
        "municipalCode": "0000000",
        "networkReferenceId": "1982391A0020319",
        "pointOfSaleMarketplaceCode": "000000000000000",
        "quantityDaysFinancialTransaction": "001",
        "transactionCode": "06",
        "transactionSubCode": "02",
        "valueExchange": "0000000000",
        "zipCodeEstablishmentCommercial": "i7qQFhLh"
      }
    }
  }
}

Response

OK

idnumber

Dispute form ID.

dispute_installment_idnumber nullable

If necessary to join Form to Installment. If not passed, first installment is used.

status'PENDING' | 'PROCESSED' | 'FAILED' | 'INACTIVE'

Dispute form status.

network'MASTERCARD_CARD' | 'PRIMITIVE'

Network for dispute Form.

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

created_at_utcstring date-time

Dispute created in UTC date/time.

update_atstring date

Update date, format = yyyy-mm-dd

update_at_utcstring date-time

Update UTC date

Example response

{
  "id": 122,
  "status": "PENDING",
  "network": "MASTERCARD_CARD",
  "form": {
    "ebdf": {
      "fraudDrfDocument": {
        "numberOfItems": "1",
        "types": "CARD_CLOSED",
        "additionalInformation": "Test additional information",
        "chargebackRepresentative": "Test representative",
        "cardIssuerRegion": "Europe",
        "cardholderVerificationMethod": {
          "onlinePIN": "1",
          "offlinePIN": "2",
          "signature": "3",
          "none": "4"
        }
      },
      "cardholderDisputeChargebackDrfDocument": {
        "transactionAmount": "100.00",
        "type": "PRODUCT_DISPUTE",
        "deliveryDateOfGoodsOrServices": "18-FEB-2018",
        "expectedDeliveryDateOfGoodOrServices": "18-FEB-2018",
        "returnDate": "18-FEB-2018",
        "cancellationDate": "18-FEB-2018",
        "disputeDetails": "Test dispute details...",
        "chargebackRepresentative": "Ahsta LaVista Baybee"
      },
      "pointOfInteractionErrorsDrfDocument": {
        "transactionAmount": "20000",
        "type": "DUPLICATE_DEBIT",
        "alternateMeansOfPaymentDetails": "Test alternate means of payment details",
        "disputeDetails": "Test Dispute details",
        "chargebackRepresentative": "Test Representative"
      }
    },
    "allocationQuestionnaire": {
      "accountStatus": "AC",
      "oneAuthForMultipleSalesInd": "Y"
    },
    "collaborationQuestionnaire": {
      "incorrectCurrencyReason": "CD",
      "authorizationRequestDeclinedValidDataInd": true,
      "explainWhyValidDataInclusionReason": "Explain why the inclusion of valid data would have caused the Authorization Request to be declined",
      "correctCurrency": 986,
      "cardholderDidNotAgreeDCC": "Y",
      "transactionCodeIncorrect": "CRI",
      "rolTransactionId": 123,
      "explainWhyCreditRefundProcessedInError": "Explain why the credit refund was processed in error",
      "issuerMasterFileAccountNumberInd": "Y",
      "receiptAccountNumberMatchInd": "Y",
      "cardholderReceiptAmt": 12,
      "merchantDisputePriceDiffInd": "Y",
      "bothTransactionsOnSameAcctNumberInd": "Y",
      "duplicateTranId": "123456789012345",
      "issuerOrCardholderOtherAcctWithDiffVisaCardInd": "Y",
      "issuerEvidenceMerchantPassedOnFundsInd": "Y",
      "cardholderAttemptToResolve": "Y",
      "attemptToResolveProhLocalLaw": "Y",
      "otherTranSameMerchantInd": "Y",
      "providingPaymentProofOtherMeans": "A",
      "arn": "001122334455667788991234",
      "transactionID": "123456789012345",
      "cancellationDate": "2022-05-20",
      "contactMethodWithMerchantInd": true,
      "contactMethodMerchantEmailInd": true,
      "contactMethodMerchantCallCenterInd": true,
      "contactMethodMerchantMailInd": true,
      "contactMethodMerchantSMSInd": true,
      "contactMethodMerchantInPersonInd": true,
      "contactMethodMerchantWebformInd": true,
      "otherFormOfPaymentInd": true,
      "accountClosureDate": "2022-05-20",
      "disputeRelateToInd": "Y",
      "contractDate": "2022-05-20",
      "merchandiseOrServices": "Merchandise",
      "serviceType": "T",
      "whatWasPurchased": "Provide details of what was purchased...",
      "cardholderReceiveMerchandiseInd": "Y",
      "chReceivedOrExpectedMerchandise": "2022-05-20",
      "cardholderReturnMerchandiseInd": "Y",
      "cardholderReturnedMerchandiseDate": "2022-05-20",
      "returnedMerchandiseReceivedDate": "2022-05-20",
      "returnMethod": "FF",
      "howMerchandiseReturned": "Explain how the merchandise was returned...",
      "shippingTrackingNumber": "774-4u7u3-u4u4u-35347",
      "attemptedReturnDate": "2022-05-20",
      "howChAttemptReturnAndDispOfMerchandise": "Provide a detailed description of how the cardholder attempted to return and the disposition of the merchandise.",
      "merchantRefuseAdvise": "MRRM",
      "didCardholderCancel": "Y",
      "didCardholderCancelBeforeShipping": "Y",
      "timeshareDate": "2022-05-20",
      "dateOfService": "2022-05-20",
      "certificationGuaranteedReservation": "GR",
      "cancellationPolicyProvidedInd": "Y",
      "whatWasOrdered": "What was ordered...",
      "merchandiseWasCounterfeitDate": "2022-05-20",
      "descCounterfeitMerchandise": "Describe the counterfeit merchandise",
      "descDispOfCounterfeitMerchandise": "Describe the disposition of the counterfeit merchandise",
      "originalCreditNotAccepted": "R",
      "explain": "Explain",
      "creditVoucherTransactionReceiptDated": "Y",
      "creditVoucherOrTransactionReceiptDate": "2022-05-20",
      "cardholderCancelledReturnedMerchDate": "2022-05-20",
      "merchantInLiquidationOrReceivershipInd": "Y",
      "whatWasNotReceived": "What was not received?",
      "thirdPartyGiftCardInd": "Y",
      "visaComCardVirtualAccInd": "Y",
      "virtualAccFinancialLossInd": "Y",
      "didMerchantCancelInd": "Y",
      "merchantCancellationDate": "2022-05-20",
      "nonReceiptOfTravelServicesInd": "Y",
      "disputeInvolveBondingAuthorityInd": "Y",
      "explainAttemptToResolveWithBondAuth": "Provide an explanation of the attempt to resolve the dispute with the bonding authority/insurance scheme or where the information was obtained to confirm an insufficient bond/insurance scheme",
      "bondAuthLetterOrAdviceDate": "2022-05-20",
      "purchasedInfo": "Provide detailed description of what was purchased and an explanation of the dispute",
      "expectedReceiptDate": "2022-05-20",
      "expectedReceiptTime": "10:30",
      "explainDisputePriorDeliveryDate": "Explanation of dispute initiated prior to the expected delivery date",
      "didCardholderCancelPriorExpectedDate": "Y",
      "merchandiseDeliveredWrongLocation": "Y",
      "lateDeliveryWrongLocation": "Provide address of the agreed location or details of late delivery",
      "didMerchantCancelMerchandiseInd": "Y",
      "merchantCancelMerchandiseDate": "What was ordered and how it was damaged",
      "merchandiseReceivedDate": "2022-05-20",
      "cardholderMerchantPreviousNegotiationEvidence": "Y",
      "whenNegotiationsBegin": "2022-05-20",
      "explainPrevNegotiation": "Explain the previous ongoing negotiations between the cardholder and merchant.",
      "cardholderFirstNotifiedIssuerDisputeDate": "2022-05-20",
      "serviceReceivedDate": "2022-05-20",
      "howMerchandiseOrServiceMisrepresented": "How was the merchandise or service misrepresented?",
      "merchandiseServiceReceivedDate": "2022-05-20",
      "explainPreNegotiation": "Explain the previous ongoing negotiations between the cardholder and merchant.",
      "orderDetailsNotAsDescribed": "Provide details of what was ordered and not as described",
      "merchantReceivedReturnedMerchandiseDate": "2022-05-20",
      "merchantAcceptCancellationInd": "Y",
      "purchasedInfoAndQualityIssue": "Provide information about what was purchased and the quality issue",
      "didCardholderPayWorkRedone": "Y",
      "howTermsOfContractNotHonoredByMerchant": "Provide details how the terms of the contract were either not honored by the merchant or not as described",
      "nonFiatCurrencyNotDelivered": "Y",
      "merchandiseDeliveredLate": "Y",
      "merchantInBankruptcyLiquidationInd": "Y",
      "nonFiatCurrencyNotMatching": "Y",
      "dispositionOfMerchandise": "a"
    },
    "preArbitration": {
      "preArbReason": "Reason for pre-aritration",
      "newInformationInd": "Y",
      "newInformationDescription": "New information..."
    }
  },
  "created_at": "2024-09-12T16:46:16.43663522",
  "created_at_utc": "2021-02-21T22:51:43.000000000Z",
  "update_at": "2021-02-22",
  "update_at_utc": "2021-02-21T22:51:43.000000000Z"
}