Sign in

v1

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

Create installment migration

Create a migration for a specific installment. Before you do this, you need to call Create dispute migration and get a dispute ID to use here.

This endpoint generates a Dispute installment created event. Once the dispute is migrated into the system, its status changes and a Dispute status changed event is generated.

post/v1/migration/{disputeId}/installment

Path parameters

disputeIdnumber required

Dispute ID

Request body

installment_numberinteger required

Installment number.

arnstring

Installment acquirer reference number. REQUIRED for Zero balance integration.

claim_idstring required

Claim ID, same as case number for VISA.

chargeback_idstring required

Chargeback ID, same as dispute ID for VISA.

installment_disputed_amountnumber required

Disputed installment value

Example request

{
  "installment_number": 1,
  "arn": "000000000042",
  "claim_id": "88993u748",
  "chargeback_id": "8849003",
  "installment_disputed_amount": 50
}

Response

OK

idnumber

Dispute installment ID.

dispute_idnumber

Dispute ID

installmentinteger

Installment number.

arnstring

Installment acquirer reference number.

chargeback_idstring nullable

Network chargeback ID.

claim_idstring nullable

Network claim ID.

installment_disputed_amountnumber

Installment disputed amount.

network_return_reason_codestring nullable

Network returned reason code.

networkStatusstring

Dispute status from the network

reason_codenumber

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)

network_return_reject_reasonstring nullable

Formated network reject reason information.

network_response_errorstring nullable

Network response error.

transaction_idstring nullable

Transaction ID.

dispute_due_to'NR' | 'CR' | 'ND' | 'DM' | 'Q' | 'CM' | 'M' | 'CN' | 'CS' | 'OC' | 'CL' | 'TC' | 'D' | 'IAN' | 'IA' | 'IC' | 'IT' | 'ID' | 'LP' | 'P'

REQUIRED when dispute is open to Visa Collaboration (Reason code 12 and 13 and Visa network brand). Collaboration is the new name for Visa's old chargeback process, where each party has several chances to investigate and submit evidence in order to determine whether a chargeback is legitimate.<br>

NR = Merchandise/services not receive<br> CR = Cancelled recurring transaction<br> ND = Not as described<br> DM = Damaged or defective merchandise<br> Q = Quality<br> CM = Counterfeit merchandise<br> M = Misrepresentation<br> CN = Credit not processed<br> CS = Cancelled merchandise/services<br> OC = Original credit not accepted<br> CL = Non-receipt of cash<br> TC = Terms of contract (virtual account)<br> D = Duplicate<br> IAN = Incorrect account number<br> IA = Incorrect amount<br> IC = Incorrect currency<br> IT = Incorrect transaction code<br> ID = Invalid data<br> LP = Late presentment<br> P = Paid by other means<br>

For VISA, you need to fill out the collaborationQuestionnaire form object in the Create dispute form endpoint.

chargeback_ref_numstring nullable

Chargeback reference number.

network_response_amountnumber nullable

Last amount disputed in the claim registered when getting new information from network brand.

network_response_currencystring nullable

Last currency of amount disputed in the claim registered when getting new information from network brand.

is_first_installmentboolean

Dispute installment references authorization's first installment.

network_return_reject_reason_codeinteger nullable

Formatted network reject reason information.

Example response

{
  "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
}