v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Disputes

Get dispute

Get information about a specific dispute given its ID in the path.

You can use the List disputes endpoint to get dispute IDs.

get/v1/disputes/{disputeId}

Path parameters

disputeIdnumber required

Dispute ID

Response

OK

idnumber

Dispute ID

org_idstring

Organization ID

account_idinteger

Account ID

authorization_idinteger

Authorization ID.

disputed_amountnumber

Disputed amount.

commentstring nullable

Client custom dispute comment.

REQUIRED for Visa partial dispute to explain why partial.

airport_taxboolean

For ELO card network, should dispute for airport tax be created? Default is true for ELO.

airport_tax_partialboolean

For ELO card network, should airport tax be partially disputed? Default is false.

airport_tax_amountnumber

Airport tax amount to be disputed. REQUIRED if airport_tax_partial is true.

dispute_reasonnumber

Each card network, such as Visa or Mastercard, defines and maintains their own unique set of reason codes, which banks that issue credit and debit cards under their brands apply to disputes. Here's a reason code quick reference for the major credit card networks.

For Visa, this would be either 10 (fraud - card present), 11 (authorization), 12 (processing error), or 13 (consumer dispute).

For more infomation, refer to the Visa or Mastercard chargeback quides.

For example - 4853 (Mastercard - cardholder dispute), 12 (Visa - processing error) or 72 (ELO - denied authorization)

modalitynumber

Dispute modality - legacy term for reason code to file the dispute.

dispute_status'OPENED' | 'PENDING' | 'CANCELED' | 'FAILED' | 'CHARGEBACK_REJECTED' | 'CHARGEBACK_CREATED' | 'CHARGEBACK_ACCEPTED' | 'CHARGEBACK_CLOSED' | 'SECOND_PRESENTMENT' | 'PRE_ARBITRATION_OPENED' | 'PRE_ARBITRATION_ACCEPTED' | 'PRE_ARBITRATION_DECLINED' | 'PRE_ARBITRATION_RECALL' | 'PRE_ARB_ALLOCATION_OPENED' | 'FAILED_PRE_ARBITRATION' | 'PRE_ARB_ALLOCATION_ACCEPTED' | 'PRE_ARB_ALLOCATION_DECLINED' | 'PRE_ARB_ALLOCATION_RECALLED' | 'FAILED_DECLINE_PRE_ARB' | 'FAILED_ACCEPT_PRE_ARB' | 'FAILED_ON_CLOSE' | 'EXPIRED' | 'ISSUER_LOSS' | 'MIGRATION' | 'FAILED_MIGRATION'

Dispute status enums.

dispute_group_status'OPEN' | 'APPROVED' | 'DENIED' | 'CARDNETWORK_CHARGEBACK' | 'ANALYSING' | 'CARDNETWORK_SECOND_PRESENTMENT' | 'FAILED' | 'CARDNETWORK_PREARBITRATION' | 'RESEND' | 'LOSS' | 'WON' | 'REJECTED' | 'FAILED_PROCESSED'

Group status enums

timelinestring

Client custom timeline information.

protocolstring

Client custom protocol ID. This is primarily for you to internally identify a request. If not provided, Pismo creates a CID (correlation ID) field for this purpose.

metadatastring

Any data object with key/value pairs. No limit on length.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

created_atstring date-time

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

updated_atstring date

Dispute last updated date, format = yyyy-mm-dd.

created_at_utcstring date-time

Dispute created in UTC date/time.

updated_at_utcstring

When dispute updated in UTC date/time.

is_networkboolean

Open a dispute over a network authorization.

is_dispute_migratedboolean

Has this dispute been migrated to the Pismo platform?

reversal_idnumber

Dispute credit reversal ID.

network_return_reason_codestring

Network reason code response.

network_brand_type'Visa' | 'Mastercard' | 'Elo'

Network brand

transaction_datestring

Transaction date related to authorization, format = yyyy-mm-dd

stop_automated_installmentboolean

Automated dispute installment control flag. If an issuer opens a dispute for a transaction that has more than one installment, with installments that can still be posted, the issuer will need to open a dispute for subsequent installments as well. With automated dispute installment control, once you open a chargeback for the first installment, the same information can be used for subsequent transaction installments.

card_hashstring

Card number hash.

authorization_codestring

Authorization code

transaction_amountnumber

Transaction amount

is_dispute_invalid_transactionboolean

Is this an invalid authorization dispute?

network_return_reject_reason_codeinteger

Formatted network reject reason information.

network_response_errorstring

Network response error.

Example response

{
  "id": 48670,
  "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
  "account_id": 6912345,
  "authorization_id": 4352243,
  "disputed_amount": 10,
  "comment": "Custom comment",
  "airport_tax_amount": 25,
  "dispute_reason": 4853,
  "modality": 4855,
  "dispute_status": "PENDING",
  "dispute_group_status": "OPEN",
  "timeline": "{ \"data\": \"test\"}",
  "protocol": "20251128111532456",
  "metadata": "{ \"key\": \"value\"}",
  "created_at": "2024-09-12T16:46:16.43663522",
  "updated_at": "2021-02-22",
  "created_at_utc": "2021-02-21T22:51:43.000000000Z",
  "updated_at_utc": "2022-10-13T19:56:010000000Z",
  "is_network": true,
  "reversal_id": 10042,
  "network_return_reason_code": "2833",
  "network_brand_type": "Visa",
  "transaction_date": "2021-02-02",
  "stop_automated_installment": true,
  "card_hash": "XYZddue74kd8",
  "authorization_code": "F0JR9H",
  "transaction_amount": 86753.09,
  "dispute_installments": [
    {
      "id": 50068,
      "dispute_id": 48670,
      "installment": 2,
      "arn": "000000485723",
      "chargeback_id": "4586",
      "claim_id": "00058678",
      "installment_disputed_amount": 45.5,
      "network_return_reason_code": "4853",
      "networkStatus": "Authorization Dispute - Accepted by Acq",
      "reason_code": 4853,
      "network_return_reject_reason": "5000",
      "network_response_error": "The network returned [Create First Chargeback - Details provided in the request are invalid.], reasonCode [INVALID_REQUEST] and the source [SYSTEM]",
      "dispute_status": {
        "id": 316,
        "description": "PENDING",
        "type": "PRIMITIVE_ON_US",
        "group": "OPEN"
      },
      "network_response": {
        "id": 5,
        "dispute_id": 48670,
        "dispute_installment_id": 8675309,
        "claim_id": "00058678",
        "chargeback_id": "4586",
        "reason_code": 4853,
        "response_error": "The network returned [[edf00094-c762-49cc-9a92-380c49adf557_V_1638813966704] Visa returned an ApiException], reasonCode [E-200100002] with the source [One or more required fields are missing. Please correct the following errors:PinPreferringCard].",
        "reject_reason": "Code1=0283(00):D0025/000;DE072=D0025\\4837\\\\"
      },
      "transaction_id": "5000",
      "dispute_form_list": [
        {
          "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"
        }
      ],
      "dispute_fraud_report": {
        "fraud_report_id": 1,
        "status": "PENDING",
        "network_brand_type": "Visa",
        "report": {
          "acct_status": "ACCT_IS_OPEN",
          "chgbk_indicator": "1",
          "cvc_invalid_indicator": "Y",
          "device_type": "1",
          "fraud_type": "00",
          "report_date": "2021-02-11",
          "sub_type": "K",
          "authorization_origin_indicator": "Y",
          "notification_code": "1",
          "exchange_indicator": "N",
          "exchange_value": 9.99,
          "card_service_code": "C"
        },
        "fraud_report_network_id": 1,
        "comment_network": "Fraud report disputed transaction is already reported to the fraud system Last item fraud is not a FD1.",
        "created_at": "2024-09-12T16:46:16.43663522",
        "updated_at": "2024-09-12T16:46:16.43663522"
      },
      "pre_arbitration": {
        "pre_arbitration_response_id": 8775309,
        "memo": "This is a test memo.",
        "updated_chargeback_reason_code": 4853,
        "merchant_name": "Acme Dry Goods",
        "acquiring_institution_code": "004321",
        "change_reason_code_reason": "This is a test reason",
        "case_network_response": "COMPLETED_SND_2/10/2021 8:43:21 AM",
        "justify_not_accepted_fully": "Only partial amount in dispute.",
        "currency_code_request": "840",
        "currency_code_response": "840",
        "amount_request": 18.36,
        "amount_response": 15.25,
        "acquirer_memo": "Not valid",
        "action": "REJECT",
        "response_date": "2021-02-14"
      },
      "dispute_due_to": "NR",
      "network_return_reject_reason_code": 5000
    }
  ],
  "network_return_reject_reason_code": 5000,
  "network_response_error": "The network returned [Create First Chargeback - Details provided in the request are invalid.], reasonCode [INVALID_REQUEST] and the source [SYSTEM]"
}