---
updatedAt: 2026-04-22T15:15:32.000Z
agentTools:
siteIndex: https://developers.pismo.io/llms.txt
projectIndex: https://developers.pismo.io/pismo-docs/llms.txt
---
# Create dispute form
Create a dispute form with more information to send to the network.
You can create one of the following types of Expedited Billing Dispute Forms (EBDF):
1. **fraudDrfDocument** - Used for cases of fraud
2. **cardholderDisputeChargebackDrfDocument** - Used when the cardholder disputes a purchase and notifies the card issuer.
3. **pointOfInteractionErrorsDrfDocument** - Used when there's either a disagreement between parties or an error with the transaction. For example, a wrong value or a duplicate charge.
For VISA, you need to fill out the `allocationQuestionnaire` (reason 11) or `collaborationQuestionnaire` (reason 12 and 13) form object. VISA's rules for filling out form fields can be found in [this guide document](https://developers.pismo.io/pismo-docs/docs/visa-colloboration-questionaire)
For Elo, you need to fill out the `clearingElo` form object.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Card issuing - Disputes",
"version": "1.0.0",
"description": "Disputes API endpoints",
"contact": {
"name": "API Support",
"url": "https://developers.pismo.io/support/"
},
"license": {
"name": "Copyright Pismo"
}
},
"servers": [
{
"url": "https://sandbox.pismolabs.io/disputes",
"description": "Sandbox API server for testing"
}
],
"security": [
{
"BearerAuth": []
}
],
"tags": [
{
"name": "Supporting forms",
"description": "Endpoints to handle supporting forms for specific dispute types"
}
],
"components": {
"parameters": {
"disputeId": {
"name": "disputeId",
"in": "path",
"description": "Dispute ID",
"required": true,
"schema": {
"type": "number"
}
}
},
"schemas": {
"CreatedAtUTC": {
"type": "string",
"description": "Dispute created in UTC date/time.",
"format": "date-time",
"example": "2021-02-21T22:51:43.000000000Z"
},
"DisputeFormStatus": {
"type": "string",
"example": "PENDING",
"description": "Dispute form status.",
"enum": [
"PENDING",
"PROCESSED",
"FAILED",
"INACTIVE"
]
},
"DisputeFormRequest": {
"title": "DisputeFormRequest",
"type": "object",
"required": [
"form"
],
"properties": {
"dispute_installment_id": {
"type": "number",
"description": "Dispute installment ID. If not passed, the first installment is used"
},
"form": {
"description": "Field to register form used to send to network.",
"type": "object",
"properties": {
"ebdf": {
"type": "object",
"properties": {
"fraudDrfDocument": {
"$ref": "#/components/schemas/FraudDrfDocumentStructure"
},
"cardholderDisputeChargebackDrfDocument": {
"$ref": "#/components/schemas/CardholderDisputeChargebackDrfDocumentStructure"
},
"pointOfInteractionErrorsDrfDocument": {
"$ref": "#/components/schemas/PointOfInteractionErrorsDrfDocumentStructure"
}
}
},
"allocationQuestionnaire": {
"$ref": "#/components/schemas/VisaAllocationQuestionnaireDocumentStructure"
},
"collaborationQuestionnaire": {
"$ref": "#/components/schemas/VisaCollaborationQuestionnaireDocumentStructure"
},
"preArbitration": {
"$ref": "#/components/schemas/PreArbitration"
},
"clearingElo": {
"$ref": "#/components/schemas/ClearingEloStructure"
}
}
}
},
"x-examples": {
"Dispute Form Sample Request Master without Installment Id - Will use first Installment": {
"form": {
"ebdf": {
"fraudDrfDocument": {
"numberOfItems": "1",
"types": "CARD_CLOSED,REPORT_SAFE",
"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",
"cardholderParticipation": "false",
"disputeDetails": "Test Dispute details",
"chargebackRepresentative": "Test representative"
},
"pointOfInteractionErrorsDrfDocument": {
"transactionAmount": "20000",
"type": "DUPLICATE_DEBIT",
"alternateMeansOfPaymentDetails": "Test alternate means of payment details",
"disputeDetails": "Test Dispute details",
"chargebackRepresentative": "Test representative"
}
}
}
},
"Dispute Form Sample Request Master with Installment Id": {
"dispute_installment_id": 2,
"form": {
"ebdf": {
"fraudDrfDocument": {
"numberOfItems": "1",
"types": "CARD_CLOSED,REPORT_SAFE",
"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",
"cardholderParticipation": "false",
"disputeDetails": "Test Dispute details",
"chargebackRepresentative": "Test representative"
},
"pointOfInteractionErrorsDrfDocument": {
"transactionAmount": "20000",
"type": "DUPLICATE_DEBIT",
"alternateMeansOfPaymentDetails": "Test alternate means of payment details",
"disputeDetails": "Test Dispute details",
"chargebackRepresentative": "Test representative"
}
}
}
},
"Dispute Form Sample Request Visa Allocation Questionnaire": {
"dispute_installment_id": 2,
"form": {
"allocationQuestionnaire": {
"accountStatus": "AC",
"oneAuthForMultipleSalesInd": "Y"
}
}
},
"Dispute Form Sample Request Visa Collaboration Questionnaire": {
"dispute_installment_id": 2,
"form": {
"collaborationQuestionnaire": {
"incorrectCurrencyReason": "CD",
"authorizationRequestDeclinedValidDataInd": true,
"explainWhyValidDataInclusionReason": "Explain why the inclusion of valid data would have caused the Authorization Request to be declined",
"processingDateOver10DaysFmTransDateInd": true,
"processingDateOver180DaysFmTransDateInd": true,
"processingDateOver45DaysFmTransDateInd": true,
"correctCurrency": 123,
"cardholderDidNotAgreeDCC": "Y",
"transactionCodeIncorrect": "CRI",
"rolTransactionId": 123,
"incorrectTransactionId": "string",
"explainWhyCreditRefundProcessedInError": "Explain why the credit refund was processed in error",
"issuerMasterFileAccountNumberInd": "Y",
"receiptAccountNumberMatchInd": "Y",
"matchingAuthTranId": 1234567890123456,
"authorizationDate": "2022-05-20",
"authorizationCode": "A12B34",
"cardholderReceiptAmt": 12,
"merchantDisputePriceDiffInd": "Y",
"bothTransactionsOnSameAcctNumberInd": "Y",
"duplicateTranId": "123456789012345",
"duplicateTranDate": "2022-05-20",
"duplicateTranAmount": 123,
"duplicateARN": "112233445566778899001234",
"issuerOrCardholderOtherAcctWithDiffVisaCardInd": "Y",
"issuerEvidenceMerchantPassedOnFundsInd": "Y",
"cardholderAttemptToResolve": "Y",
"attemptToResolveProhLocalLaw": "Y",
"otherTranSameMerchantInd": "Y",
"providingPaymentProofOtherMeans": "A",
"arn": "001122334455667788991234",
"transactionID": "123456789012345",
"merchantFacilitiesWithdrawn": false,
"cardholderDeceased": false,
"cancellationDate": "2022-05-20",
"accountClosureDate": "2022-05-20",
"cancellationMethod": "Cancellation Reason.",
"disputeRelateToOffpremisesDistanceSellInd": "Y",
"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": "Tracking Number",
"cardholderAttemptReturnMerchandise": "Y",
"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",
"timeshareDate": "2022-05-20",
"dateOfService": "2022-05-20",
"certificationGuaranteedReservation": "GR",
"cancellationPolicyProvidedInd": "Y",
"whatWasOrdered": "What was ordered?",
"whereIsMerchandiseLocated": "Where is the merchandise located?",
"merchandiseWasCounterfeitDate": "2022-05-20",
"descCounterfeitMerchandise": "Describe the counterfeit merchandise",
"descDispOfCounterfeitMerchandise": "Describe the disposition of the counterfeit merchandise",
"originalCreditNotAccepted": "R",
"explain": "Explain",
"creditVoucherTransactionReceipt": "Y",
"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",
"damagedOrDefectiveOrderInfo": "What was ordered and how it was damaged or defective?",
"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",
"merchantReceivedReturnedMerchandiseDate": "2022-05-20",
"serviceReceivedDate": "2022-05-20",
"howMerchandiseOrServiceMisrepresented": "How was the merchandise or service misrepresented?",
"merchandiseServiceReceivedDate": "2022-05-20",
"orderDetailsNotAsDescribed": "Provide details of what was ordered and not as described",
"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",
"merchantAcceptInd": "Y",
"explainCreditIssuedLateDetailsOfNegotiations": "Pending"
}
}
},
"Dispute Form Sample Request Visa without Installment Id - Will use first Installment": {
"form": {
"collaborationQuestionnaire": {
"incorrectCurrencyReason": "CD",
"authorizationRequestDeclinedValidDataInd": true,
"explainWhyValidDataInclusionReason": "Explain why the inclusion of valid data would have caused the Authorization Request to be declined",
"processingDateOver10DaysFmTransDateInd": true,
"processingDateOver180DaysFmTransDateInd": true,
"processingDateOver45DaysFmTransDateInd": true,
"correctCurrency": 123,
"cardholderDidNotAgreeDCC": "Y",
"transactionCodeIncorrect": "CRI",
"rolTransactionId": 123,
"incorrectTransactionId": "string",
"explainWhyCreditRefundProcessedInError": "Explain why the credit refund was processed in error",
"issuerMasterFileAccountNumberInd": "Y",
"receiptAccountNumberMatchInd": "Y",
"matchingAuthTranId": 1234567890123456,
"authorizationDate": "2022-05-20",
"authorizationCode": "A12B34",
"cardholderReceiptAmt": 12,
"merchantDisputePriceDiffInd": "Y",
"bothTransactionsOnSameAcctNumberInd": "Y",
"duplicateTranId": "123456789012345",
"duplicateTranDate": "2022-05-20",
"duplicateTranAmount": 123,
"duplicateARN": "112233445566778899001234",
"issuerOrCardholderOtherAcctWithDiffVisaCardInd": "Y",
"issuerEvidenceMerchantPassedOnFundsInd": "Y",
"cardholderAttemptToResolve": "Y",
"attemptToResolveProhLocalLaw": "Y",
"otherTranSameMerchantInd": "Y",
"providingPaymentProofOtherMeans": "A",
"arn": "001122334455667788991234",
"transactionID": "123456789012345",
"merchantFacilitiesWithdrawn": false,
"cardholderDeceased": false,
"cancellationDate": "2022-05-20",
"accountClosureDate": "2022-05-20",
"cancellationMethod": "Cancellation Reason.",
"disputeRelateToOffpremisesDistanceSellInd": "Y",
"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": "Tracking Number",
"cardholderAttemptReturnMerchandise": "Y",
"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",
"timeshareDate": "2022-05-20",
"dateOfService": "2022-05-20",
"certificationGuaranteedReservation": "GR",
"cancellationPolicyProvidedInd": "Y",
"whatWasOrdered": "What was ordered?",
"whereIsMerchandiseLocated": "Where is the merchandise located?",
"merchandiseWasCounterfeitDate": "2022-05-20",
"descCounterfeitMerchandise": "Describe the counterfeit merchandise",
"descDispOfCounterfeitMerchandise": "Describe the disposition of the counterfeit merchandise",
"originalCreditNotAccepted": "R",
"explain": "Explain",
"creditVoucherTransactionReceipt": "Y",
"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",
"damagedOrDefectiveOrderInfo": "What was ordered and how it was damaged or defective?",
"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",
"merchantReceivedReturnedMerchandiseDate": "2022-05-20",
"serviceReceivedDate": "2022-05-20",
"howMerchandiseOrServiceMisrepresented": "How was the merchandise or service misrepresented?",
"merchandiseServiceReceivedDate": "2022-05-20",
"orderDetailsNotAsDescribed": "Provide details of what was ordered and not as described",
"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",
"merchantAcceptInd": "Y",
"explainCreditIssuedLateDetailsOfNegotiations": "Pending"
}
}
}
},
"description": "Dispute form request"
},
"DisputeFormResponse": {
"title": "DisputeFormResponse",
"description": "Dispute Form response.",
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 122,
"description": "Dispute form ID."
},
"dispute_installment_id": {
"type": "number",
"description": "If necessary to join Form to Installment. If not passed, first installment is used.",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/DisputeFormStatus"
},
"network": {
"type": "string",
"example": "PRIMITIVE",
"description": "Network for dispute Form.",
"enum": [
"PRIMITIVE_ON_US",
"PRIMITIVE"
]
},
"form": {
"type": "object",
"properties": {
"ebdf": {
"type": "object",
"properties": {
"fraudDrfDocument": {
"$ref": "#/components/schemas/FraudDrfDocumentStructure"
},
"cardholderDisputeChargebackDrfDocument": {
"$ref": "#/components/schemas/CardholderDisputeChargebackDrfDocumentStructure"
},
"pointOfInteractionErrorsDrfDocument": {
"$ref": "#/components/schemas/PointOfInteractionErrorsDrfDocumentStructure"
}
}
},
"allocationQuestionnaire": {
"$ref": "#/components/schemas/VisaAllocationQuestionnaireDocumentStructure"
},
"collaborationQuestionnaire": {
"$ref": "#/components/schemas/VisaCollaborationQuestionnaireDocumentStructure"
},
"preArbitration": {
"$ref": "#/components/schemas/PreArbitration"
}
}
},
"created_at": {
"$ref": "#/components/schemas/CreatedAt"
},
"created_at_utc": {
"$ref": "#/components/schemas/CreatedAtUTC"
},
"update_at": {
"description": "Update date, format = yyyy-mm-dd",
"type": "string",
"format": "date",
"example": "2021-02-22"
},
"update_at_utc": {
"description": "Update UTC date",
"type": "string",
"format": "date-time",
"example": "2021-02-21T22:51:43.000000000Z"
},
"dispute_form_type": {
"$ref": "#/components/schemas/DisputeFormType"
}
},
"x-examples": {
"Dispute Form Master Response": {
"value": {
"id": 0,
"status": "PENDING",
"network": "MASTERCARD_NETWORK",
"dispute_installment_id": 2,
"form": {
"ebdf": {
"fraudDrfDocument": {
"numberOfItems": "1",
"types": "CARD_CLOSED,REPORT_SAFE",
"additionalInformation": "Test additional information",
"chargebackRepresentative": "Test chargeback 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",
"cardholderParticipation": "false",
"disputeDetails": "Test Dispute details",
"chargebackRepresentative": "Test chargeback representative"
},
"pointOfInteractionErrorsDrfDocument": {
"transactionAmount": "20000",
"type": "DUPLICATE_DEBIT",
"alternateMeansOfPaymentDetails": "Test alternate means of payment details",
"disputeDetails": "Test Dispute details",
"chargebackRepresentative": "Test Chargeback representative"
}
}
},
"created_at": "2021-02-22",
"created_at_utc": "2021-02-21T22:51:43.000000000Z",
"updated_at": "2021-02-22",
"updated_at_utc": "2021-02-21T22:51:43.000000000Z"
}
},
"Dispute Form Visa Questionnaire Response": {
"id": 1,
"dispute_installment_id": 1,
"status": "PENDING",
"network": "PRIMITIVE",
"form": {
"collaborationQuestionnaire": {
"incorrectCurrencyReason": "CD",
"authorizationRequestDeclinedValidDataInd": true,
"explainWhyValidDataInclusionReason": "Explain why the inclusion of valid data would have caused the Authorization Request to be declined",
"processingDateOver10DaysFmTransDateInd": true,
"processingDateOver180DaysFmTransDateInd": true,
"processingDateOver45DaysFmTransDateInd": true,
"correctCurrency": 123,
"cardholderDidNotAgreeDCC": "Y",
"transactionCodeIncorrect": "CRI",
"rolTransactionId": 123,
"incorrectTransactionId": "string",
"explainWhyCreditRefundProcessedInError": "Explain why the credit refund was processed in error",
"issuerMasterFileAccountNumberInd": "Y",
"receiptAccountNumberMatchInd": "Y",
"matchingAuthTranId": 1234567890123456,
"authorizationDate": "2022-05-20",
"authorizationCode": "A12B34",
"cardholderReceiptAmt": 12,
"merchantDisputePriceDiffInd": "Y",
"bothTransactionsOnSameAcctNumberInd": "Y",
"duplicateTranId": "123456789012345",
"duplicateTranDate": "2022-05-20",
"duplicateTranAmount": 123,
"duplicateARN": "112233445566778899001234",
"issuerOrCardholderOtherAcctWithDiffVisaCardInd": "Y",
"issuerEvidenceMerchantPassedOnFundsInd": "Y",
"cardholderAttemptToResolve": "Y",
"attemptToResolveProhLocalLaw": "Y",
"otherTranSameMerchantInd": "Y",
"providingPaymentProofOtherMeans": "A",
"arn": "001122334455667788991234",
"transactionID": "123456789012345",
"merchantFacilitiesWithdrawn": false,
"cardholderDeceased": false,
"cancellationDate": "2022-05-20",
"accountClosureDate": "2022-05-20",
"cancellationMethod": "Cancellation Reason.",
"disputeRelateToOffpremisesDistanceSellInd": "Y",
"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": "Tracking Number",
"cardholderAttemptReturnMerchandise": "Y",
"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",
"timeshareDate": "2022-05-20",
"dateOfService": "2022-05-20",
"certificationGuaranteedReservation": "GR",
"cancellationPolicyProvidedInd": "Y",
"whatWasOrdered": "What was ordered?",
"whereIsMerchandiseLocated": "Where is the merchandise located?",
"merchandiseWasCounterfeitDate": "2022-05-20",
"descCounterfeitMerchandise": "Describe the counterfeit merchandise",
"descDispOfCounterfeitMerchandise": "Describe the disposition of the counterfeit merchandise",
"originalCreditNotAccepted": "R",
"explain": "Explain",
"creditVoucherTransactionReceipt": "Y",
"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",
"damagedOrDefectiveOrderInfo": "What was ordered and how it was damaged or defective?",
"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",
"merchantReceivedReturnedMerchandiseDate": "2022-05-20",
"serviceReceivedDate": "2022-05-20",
"howMerchandiseOrServiceMisrepresented": "How was the merchandise or service misrepresented?",
"merchandiseServiceReceivedDate": "2022-05-20",
"orderDetailsNotAsDescribed": "Provide details of what was ordered and not as described",
"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",
"merchantAcceptInd": "Y",
"explainCreditIssuedLateDetailsOfNegotiations": "Pending"
}
},
"created_at": "2021-02-22",
"created_at_utc": "2021-02-21T22:51:43.000000000Z",
"update_at": "2021-02-22",
"update_at_utc": "2021-02-21T22:51:43.000000000Z"
},
"Dispute Form Visa PreArbitration Request": {
"id": 142,
"dispute_id": 3842,
"dispute_installment_id": 4409,
"status": "PENDING",
"network": "PRIMITIVE",
"form": {
"preArbitration": {
"preArbReason": "reason test",
"newInformationInd": "Y",
"newInformationDescription": "test"
}
},
"created_at": "2022-08-22 11:35:40",
"created_at_utc": "2022-08-22T11:35:40.000000000Z",
"updated_at": "2022-08-22 11:49:59",
"updated_at_utc": "2022-08-22T11:49:59.000000000Z",
"dispute_form_type": {
"dispute_form_type_id": 3,
"type": "preArbitration",
"description": null
}
}
}
},
"CardholderVerificationMethodStructure": {
"type": "object",
"properties": {
"onlinePIN": {
"type": "string",
"maxLength": 1,
"description": "Online PIN Preferring. PIN preferring means that verficiation will first ask for a PIN.\n\nValid Values/Format: 1",
"example": "1"
},
"offlinePIN": {
"type": "string",
"maxLength": 1,
"description": "Offline PIN.\n\n Valid Values/Format: 2",
"example": "2"
},
"signature": {
"type": "string",
"maxLength": 1,
"description": "Signature\n\nValid Values/Format: 3",
"example": "3"
},
"none": {
"type": "string",
"maxLength": 1,
"description": "None (No Cardholder Verfication Method)\n\nValid Values/Format: 4",
"example": "4"
}
}
},
"CardholderDisputeChargebackDrfDocumentStructure": {
"type": "object",
"properties": {
"transactionAmount": {
"type": "string",
"description": "Transaction amount.\n\n Length: 0-12\n\n Valid Values/Format: Numeric",
"example": "100.00"
},
"type": {
"type": "string",
"description": "Cardholder dispute type.",
"minLength": 11,
"maxLength": 22,
"example": "PRODUCT_DISPUTE",
"enum": [
"PRODUCT_DISPUTE",
"NOT_PROVIDED",
"DIGITAL_GOODS",
"CREDIT_NOT_PROCESSED",
"COUNTERFEIT",
"RECURRING_CANCELLED",
"RECURRING_DISCLOSURE",
"ADDENDUM_DISPUTE",
"HOTEL_NO_SHOW",
"PURCHASE_INCOMPLETE",
"CANCELLATION_AGREEMENT",
"POSTED_CREDIT",
"FAILED_TRAVEL"
]
},
"deliveryDateOfGoodsOrServices": {
"maxLength": 11,
"type": "string",
"description": "In case of `PRODUCT_DISPUTE`, goods or services delivery date. Format = dd-MMM-yyyy\n",
"example": "18-FEB-2018"
},
"expectedDeliveryDateOfGoodOrServices": {
"maxLength": 11,
"type": "string",
"description": "In case of `NOT_PROVIDED`, goods or services expected delivery date. Format = dd-MMM-yyyy",
"example": "18-FEB-2018"
},
"returnDate": {
"maxLength": 11,
"type": "string",
"description": "In case of `DIGITAL_GOODS`, return or cancellation of the goods or services. Format = dd-MMM-yyyy",
"example": "18-FEB-2018"
},
"cancellationDate": {
"maxLength": 11,
"type": "string",
"description": "In case of `RECURRING_CANCELLED`, cancellation of the goods or services. Format = dd-MMM-yyyy",
"example": "18-FEB-2018"
},
"cardholderParticipation": {
"type": "boolean",
"description": "Did the cardholder participate in the transaction?",
"example": false
},
"disputeDetails": {
"maxLength": 3000,
"type": "string",
"description": "Describe the cardholder’s complaint in sufficient detail to meet the requirements for the chargeback as described in the Chargeback Guide and to enable all parties to understand the dispute.\nValid Values/Format: Alphanumeric / Special Char (~!@#$%^&*()_+{}|:\"<>?,./;'[]-=)\n",
"example": "Test dispute details..."
},
"chargebackRepresentative": {
"maxLength": 25,
"type": "string",
"description": "Customer service/chargeback representative.\nValid Values/Format: Alphanumeric / Special Char (~!@#$%^&*()_+{}|:\"<>?,./;'[]-=)\n",
"example": "Ahsta LaVista Baybee"
}
}
},
"PointOfInteractionErrorsDrfDocumentStructure": {
"type": "object",
"properties": {
"transactionAmount": {
"type": "string",
"maxLength": 12,
"description": "The transaction amount as string.",
"example": "20000"
},
"type": {
"type": "string",
"description": "Error type enum, i.e. `DUPLICATE_DEBIT`",
"example": "DUPLICATE_DEBIT",
"enum": [
"DUPLICATE_DEBIT",
"INCORRECT_AMOUNT",
"LTD_TRANSACTION",
"CURRENCY_DISPUTE",
"UNREASONABLE_AMOUNT",
"DUPLICATE_TRANSACTION",
"MERCHANT_CREDIT",
"IMPROPER_MERCHANT_SURCHARGE"
]
},
"alternateMeansOfPaymentDetails": {
"maxLength": 55,
"type": "string",
"description": "In case of `DUPLICATE_DEBIT`, Alternate means of payment details. Max length = 55 chars.\nValid Values/Format: Alphanumeric / Special Char (~!@#$%^&*()_+{}|:\"<>?,./;'[]-=)\n",
"example": "Test alternate means of payment details"
},
"disputeDetails": {
"maxLength": 4800,
"type": "string",
"description": "Describe the cardholder's complaint in sufficient detail to meet the requirements for the chargeback as described in the Chargeback Guide and to enable all parties to understand the dispute.\nValid Values/Format: Alphanumeric / Special Char (~!@#$%^&*()_+{}|:\"<>?,./;'[]-=)",
"example": "Test Dispute details"
},
"chargebackRepresentative": {
"type": "string",
"maxLength": 25,
"description": "Customer service/chargeback representative.\n\n Valid Values/Format: Alphanumeric / Special Char (~!@#$%^&*()_+{}|:\"<>?,./;'[]-=)",
"example": "Test Representative"
}
}
},
"FraudDrfDocumentStructure": {
"type": "object",
"properties": {
"numberOfItems": {
"type": "string",
"maxLength": 19,
"description": "Number of transactions being disputed as string.",
"example": "1"
},
"types": {
"type": "string",
"description": "Enter any of the valid values comma separated.\n\nValid Values/Format: `CARD_CLOSED`, `REPORT_SAFE`, `CAPTURE_CARD`, `LOST_STOLEN`, `COUNTERFEIT`, `RC_4837`, `RC_4840`\n\n`RC_4837` = Reason code 4837 (Mastercard - fraud)\n\n`RC_4840` = Reason code 4840 (Mastercard - fraudelent processing of transaction)",
"example": "CARD_CLOSED",
"enum": [
"CARD_CLOSED",
"REPORT_SAFE",
"CAPTURE_CARD",
"LOST_STOLEN",
"COUNTERFEIT",
"RC_4837",
"RC_4840"
]
},
"additionalInformation": {
"maxLength": 1000,
"type": "string",
"description": "Additional information, if needed, 1000 chars max.\n\nValid Values/Format: Alphanumeric / Special Char (~!@#$%^&*()_+{}|:\"<>?,./;'[]-=)",
"example": "Test additional information"
},
"chargebackRepresentative": {
"type": "string",
"maxLength": 25,
"description": "Customer Service/Chargeback Representative\n\nValid Values/Format: Alphanumeric / Special Char (~!@#$%^&*()_+{}|:\"<>?,./;'[]-=)",
"example": "Test representative"
},
"cardIssuerRegion": {
"type": "string",
"description": "Card issuer region.\n\nValid Values:
\n `AP` - Asian Pacific
\n `Europe` - Europe
\n `NAM` - North America
\n `LAC` - Latin America and Caribbean
\n `MEA` - Middle East and Africa",
"example": "Europe",
"enum": [
"AP",
"Europe",
"NAM",
"LAC",
"MEA"
]
},
"cardholderVerificationMethod": {
"$ref": "#/components/schemas/CardholderVerificationMethodStructure"
}
}
},
"ClearingEloStructure": {
"type": "object",
"properties": {
"transactionDestinationInstitutionIdCode": {
"type": "string",
"description": "Transaction destination institution ID code"
},
"filePathMessageNumber": {
"type": "string",
"description": "File path message number"
},
"additionalDataRecord": {
"$ref": "#/components/schemas/AdditionalDataRecordStructure"
},
"authorizationCode": {
"type": "string",
"description": "Authorization code",
"example": "661810"
},
"caller": {
"type": "string",
"description": "Caller",
"example": "ELO"
},
"clearingType": {
"type": "string",
"description": "Clearing type",
"example": "CREDIT"
},
"correlationId": {
"type": "string",
"description": "Correlation IDentifier that links related API requests and events"
},
"endpoint": {
"type": "string",
"description": "Endpoint",
"example": "000666"
},
"headerServiceFile": {
"$ref": "#/components/schemas/HeaderServiceFileStructure"
},
"mainDataRecord": {
"$ref": "#/components/schemas/MainDataRecordStructure"
},
"messageNumber": {
"type": "string",
"description": "Message number",
"example": "157"
},
"orgId": {
"type": "string",
"description": "Organization/tenant ID",
"example": "TN-41234404-7994-46d5-83d6-a55cxxxxxxxx"
},
"registrationFundsTransferData": {
"$ref": "#/components/schemas/RegistrationFundsTransferDataStructure"
},
"registrationPaymentServiceData": {
"$ref": "#/components/schemas/RegistrationPaymentServiceDataStructure"
},
"s3Path": {
"type": "string",
"description": "S3 path"
},
"settlementCountryDataRecord": {
"$ref": "#/components/schemas/SettlementCountryDataRecordStructure"
}
}
},
"AdditionalDataRecordStructure": {
"type": "object",
"properties": {
"airportTaxValue": {
"type": "string",
"description": "Airport tax Value - Registry 01 - Field 37",
"example": "000000000000"
},
"changeValue": {
"type": "string",
"description": "Change Value - Registry 01 - Field 46",
"example": "00000000000"
},
"codeProduct": {
"type": "string",
"description": "Code Product - Registry 01 - Field 33",
"example": "071"
},
"conditionalCodeChipTransaction": {
"type": "string",
"description": "Conditional code chip Transaction - Registry 01 - Field 47",
"example": "0, 1, 2"
},
"cpfOrCnpj": {
"type": "string",
"description": "CPF or CNPJ - Registry 01 - Field 45",
"example": "00000000000000"
},
"feePaymentInput": {
"type": "string",
"description": "Fee payment input - Registry 01 - Field 43",
"example": "00000"
},
"indicatorMovement": {
"type": "string",
"description": "Indicator Movement - Registry 01 - Field 40",
"example": "0"
},
"installmentNumber": {
"type": "string",
"description": "Installment Number - Registry 01 - Field 42",
"example": "000"
},
"logicalNumberEquipment": {
"type": "string",
"description": "Logical Number Equipment - Registry 01 - Field 36",
"example": "20172289"
},
"numberInstallmentsTransaction": {
"type": "string",
"description": "Number Installments Transaction - Registry 01 - Field 41",
"example": "000"
},
"pointOfSale": {
"type": "string",
"description": "Point of sale - Registry 01 - Field 35",
"example": "000000000000001"
},
"referenceNumberDispute": {
"type": "string",
"description": "Reference Number Dispute - Registry 01 - Field 30",
"example": "000000"
},
"transactionCode": {
"type": "string",
"description": "Transaction Code - Registry 01 - Field 01",
"example": "06"
},
"transactionIndicator": {
"type": "string",
"description": "Transaction Indicator - Registry 01 - Field 38",
"example": "8"
},
"transactionSubCode": {
"type": "string",
"description": "Transaction SubCode - Registry 01 - Field 02",
"example": "01"
},
"transactionValue": {
"type": "string",
"description": "Transaction Value - Registry 01 - Field 39",
"example": "000000000000"
},
"walletId": {
"type": "string",
"description": "Wallet Id - Registry 01 - Field 28",
"example": "00000000000"
}
}
},
"HeaderServiceFileStructure": {
"type": "object",
"properties": {
"codeAcquirer": {
"type": "string",
"description": "Code acquirer - Registry B0 - Field 13",
"example": "0000"
},
"codeProcessor": {
"type": "string",
"description": "Code processor - Registry B0 - Field 11",
"example": "3178"
},
"emittingBank": {
"type": "string",
"description": "Emitting bank - Registry B0 - Field 10",
"example": "0985"
},
"fileVersion": {
"type": "string",
"description": "File version - Registry B0 - Field 16",
"example": "231"
},
"flagCode": {
"type": "string",
"description": "Flag code - Registry B0 - Field 14",
"example": "007"
},
"futureUse2": {
"type": "string",
"description": "Future use - Registry B0",
"example": "0"
},
"returnDateArchive": {
"type": "string",
"description": "Return date archive - Registry B0 - Field 08",
"example": "00000000"
},
"returnTimeArchive": {
"type": "string",
"description": "Return time archive - Registry B0 - Field 09",
"example": "000000"
},
"routeIndicatorArchive": {
"type": "string",
"description": "Route indicator archive - Registry B0 - Field 15",
"example": "1"
},
"sendDate": {
"type": "string",
"description": "Send date - Registry B0 - Field 06",
"example": "20230717"
},
"serviceCode": {
"type": "string",
"description": "Service code - Registry B0 - Field 02",
"example": "10"
},
"shipmentNumber": {
"type": "string",
"description": "Shipment number - Registry B0 - Field 04",
"example": "0177"
},
"shippingDate": {
"type": "string",
"description": "Shipping date - Registry B0 - Field 03",
"example": "20230717"
},
"shippingTimeArchive": {
"type": "string",
"description": "Shipping time archive - Registry B0 - Field 07",
"example": "152300"
},
"transactionSubCode": {
"type": "string",
"description": "Transaction sub code - Registry B0 - Field 01",
"example": "B0"
},
"windowNumber": {
"type": "string",
"description": "Window number - Registry B0 - Field 05",
"example": " "
}
}
},
"MainDataRecordStructure": {
"type": "object",
"properties": {
"authorizationOrCancellationOriginIndicator": {
"type": "string",
"description": "Authorization or cancellation origin indicator - Registry 00 - Field 06",
"example": "1"
},
"cardholderVerificationMethod": {
"type": "string",
"description": "Cardholder verification method - Registry 00 - Field 24",
"example": "1"
},
"cardNumber": {
"type": "string",
"description": "Card number - Registry 00 - Field 03"
},
"codeAcquirer": {
"type": "string",
"description": "Code acquirer - Registry 00 - Field 08",
"example": "9000"
},
"codeAuthorizationTransaction": {
"type": "string",
"description": "Code authorization transaction - Registry 00 - Field 22",
"example": "661810"
},
"codeCurrency": {
"type": "string",
"description": "Code currency - Registry 00 - Field 12",
"example": "986"
},
"codeFlag": {
"type": "string",
"description": "Code flag - Registry 00 - Field 19",
"example": "007"
},
"codeReasonDispute": {
"type": "string",
"description": "Code reason dispute - Registry 00 - Field 21",
"example": "00"
},
"futureUse2": {
"type": "string",
"description": "Future use2 - Registry 00",
"example": "00"
},
"futureUse4": {
"type": "string",
"description": "Future use4 - Registry 00",
"example": "0"
},
"futureUse5": {
"type": "string",
"description": "Future use5 - Registry 00",
"example": "0000"
},
"identificationTransaction": {
"type": "string",
"description": "Identification transaction - Registry 00 - Field 20",
"example": "1"
},
"numberReferenceTransaction": {
"type": "string",
"description": "Number reference transaction - Registry 00 - Field 07",
"example": "70090003198000000723318"
},
"pointOfSaleCity": {
"type": "string",
"description": "Point of sale city - Registry 00 - Field 14",
"example": "ZAMBAS"
},
"pointOfSaleCountryCode": {
"type": "string",
"description": "Point of sale country code - Registry 00 - Field 15",
"example": "BR"
},
"pointOfSaleMcc": {
"type": "string",
"description": "Point of sale mcc - Registry 00 - Field 16",
"example": "6531"
},
"pointOfSaleName": {
"type": "string",
"description": "Point of sale name - Registry 00 - Field 13",
"example": "Lns"
},
"posEntryMode": {
"type": "string",
"description": "Pos entry mode - Registry 00 - Field 26",
"example": "07"
},
"processCode": {
"type": "string",
"description": "Process code - Registry 00 - Field 131",
"example": "53"
},
"processingDate": {
"type": "string",
"description": "Processing date - Registry 00 - Field 27",
"example": "20230717"
},
"sellValue": {
"type": "string",
"description": "Sell value - Registry 00 - Field 11",
"example": "000000001000"
},
"terminalCapability": {
"type": "string",
"description": "Terminal capability - Registry 00 - Field 23",
"example": "V"
},
"transactionCode": {
"type": "string",
"description": "Transaction code - Registry 00 - Field 01",
"example": "06"
},
"transactionDate": {
"type": "string",
"description": "Transaction date - Registry 00 - Field 09",
"example": "20230717"
},
"transactionSubCode": {
"type": "string",
"description": "Transaction subCode - Registry 00 - Field 02",
"example": "00"
},
"transactionTime": {
"type": "string",
"description": "Transaction time - Registry 00 - Field 10",
"example": "092225"
}
}
},
"RegistrationFundsTransferDataStructure": {
"type": "object",
"properties": {
"cardBIN": {
"type": "string",
"description": "Card BIN - Registry 03 - Field 137",
"example": "00000000"
},
"identificationNumberOfPersonImpacted": {
"type": "string",
"description": "Identification number of person impacted - Registry 03 - Field 133",
"example": "18230565371336"
},
"last4DigitsCard": {
"type": "string",
"description": "Last 4 digits card - Registry 03 - Field 143",
"example": "0000"
},
"nameCarrier": {
"type": "string",
"description": "Name carrier - Registry 03 - Field 134",
"example": "bR1YsI xhDVQNL"
},
"originFunds": {
"type": "string",
"description": "Origin funds - Registry 03 - Field 138",
"example": "02"
},
"phoneCarrier": {
"type": "string",
"description": "Phone carrier - Registry 03 - Field 136",
"example": "00000000000"
},
"transactionCode": {
"type": "string",
"description": "Transaction code - Registry 03 - Field 01",
"example": "06"
},
"transactionSubCode": {
"type": "string",
"description": "transactionSubCode - Registry 03 - Field 02",
"example": "P2P"
},
"typePayment": {
"type": "string",
"description": "Type payment - Registry 03 - Field 132",
"example": "06"
}
}
},
"RegistrationPaymentServiceDataStructure": {
"type": "object",
"properties": {
"amountAuthorized": {
"type": "string",
"description": "Amount authorized - Registry 05 - Field 72",
"example": "000000001000"
},
"codeAnswerAuthorization": {
"type": "string",
"description": "Code answer authorization - Registry 05 - Field 132",
"example": "00"
},
"codeCurrencyValueAuthorized": {
"type": "string",
"description": "Code currency value authorized - Registry 05 - Field 64",
"example": "986"
},
"futureUse19": {
"type": "string",
"description": "Future use 19 - Registry 05 - Field 70",
"example": "00"
},
"identifierTransaction": {
"type": "string",
"description": "Identifier transaction - Registry 05 - Field 61",
"example": "202289723318"
},
"indicatorBusinessElectronic": {
"type": "string",
"description": "Indicator business electronic - Registry 05 - Field 69",
"example": "00"
},
"transactionCode": {
"type": "string",
"description": "Transaction code - Registry 05 - Field 01",
"example": "06"
},
"transactionSubCode": {
"type": "string",
"description": "Transaction subCode - Registry 05 - Field 99",
"example": "05"
},
"valueAuthorized": {
"type": "string",
"description": "Value authorized - Registry 05 - Field 62",
"example": "000000001000"
}
}
},
"SettlementCountryDataRecordStructure": {
"type": "object",
"properties": {
"countryCodeSettlement": {
"type": "string",
"description": "Country code settlement - Registry 02 - Field 50",
"example": "BR"
},
"dateLiquidationTransaction": {
"type": "string",
"description": "Date liquidation transaction - Registry 02 - Field 139",
"example": "20230718"
},
"dateMovementTransactionOriginal": {
"type": "string",
"description": "Date movement transaction original - Registry 02 - Field 54",
"example": "00000000"
},
"municipalCode": {
"type": "string",
"description": "Municipal code - Registry 02 - Field 146",
"example": "0000000"
},
"networkReferenceId": {
"type": "string",
"description": "Network reference id - Registry 02 - Field 145",
"example": "1982391A0020319"
},
"pointOfSaleMarketplaceCode": {
"type": "string",
"description": "Point of sale marketplace code - Registry 02 - Field 140",
"example": "000000000000000"
},
"quantityDaysFinancialTransaction": {
"type": "string",
"description": "Quantity days financial transaction - Registry 02 - Field 52",
"example": "001"
},
"transactionCode": {
"type": "string",
"description": "Transaction code - Registry 02 - Field 01",
"example": "06"
},
"transactionSubCode": {
"type": "string",
"description": "Transaction subCode - Registry 02 - Field 02",
"example": "02"
},
"valueExchange": {
"type": "string",
"description": "Value exchange - Registry 02 - Field 53",
"example": "0000000000"
},
"zipCodeEstablishmentCommercial": {
"type": "string",
"description": "Zip code establishment commercial - Registry 02 - Field 81",
"example": "i7qQFhLh"
}
}
},
"VisaAllocationQuestionnaireDocumentStructure": {
"type": "object",
"title": "AllocationQuestionnaire",
"required": [
"accountStatus"
],
"properties": {
"accountStatus": {
"type": "string",
"description": "Valid in VISA Authorization Flux (reason code 11).
\n `AC` = Account closed
\n `CP` = Credit problem
\n `F` = Fraud
\n",
"enum": [
"AC",
"CP",
"F"
],
"example": "AC"
},
"oneAuthForMultipleSalesInd": {
"type": "string",
"description": "Valid in VISA Authorization Flux (reason code 11).",
"enum": [
"Y",
"N"
],
"example": "Y"
}
},
"x-examples": {
"allocationQuestionnaire": {
"accountStatus": "AC",
"oneAuthForMultipleSalesInd": "Y"
}
}
},
"VisaCollaborationQuestionnaireDocumentStructure": {
"title": "CollaborationQuestionnaire",
"x-stoplight": {
"id": "pv13s582vzuca"
},
"type": "object",
"description": "",
"properties": {
"incorrectCurrencyReason": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12.3).",
"enum": [
"CD",
"DD"
],
"example": "CD"
},
"authorizationRequestDeclinedValidDataInd": {
"type": "boolean",
"example": true,
"description": "Valid in VISA Processing Errors Flux (reason code 12)."
},
"explainWhyValidDataInclusionReason": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"maxLength": 10000,
"example": "Explain why the inclusion of valid data would have caused the Authorization Request to be declined"
},
"correctCurrency": {
"type": "integer",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"example": 986
},
"cardholderDidNotAgreeDCC": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"transactionCodeIncorrect": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"CRI",
"CRD",
"DCR"
],
"example": "CRI"
},
"rolTransactionId": {
"type": "number",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"example": 123
},
"incorrectTransactionId": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"maxLength": 17
},
"explainWhyCreditRefundProcessedInError": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"example": "Explain why the credit refund was processed in error",
"maxLength": 10000
},
"issuerMasterFileAccountNumberInd": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"receiptAccountNumberMatchInd": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"cardholderReceiptAmt": {
"type": "number",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"example": 12
},
"merchantDisputePriceDiffInd": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"bothTransactionsOnSameAcctNumberInd": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"duplicateTranId": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"example": "123456789012345"
},
"issuerOrCardholderOtherAcctWithDiffVisaCardInd": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"issuerEvidenceMerchantPassedOnFundsInd": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"cardholderAttemptToResolve": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12 and 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"attemptToResolveProhLocalLaw": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12 and 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"otherTranSameMerchantInd": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"providingPaymentProofOtherMeans": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"enum": [
"A",
"T",
"C",
"F",
"V",
"S",
"O"
],
"example": "A"
},
"arn": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"maxLength": 24,
"example": "001122334455667788991234"
},
"transactionID": {
"type": "string",
"description": "Valid in VISA Processing Errors Flux (reason code 12).",
"maxLength": 15,
"example": "123456789012345"
},
"merchantFacilitiesWithdrawn": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": false
},
"cardholderDeceased": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": false
},
"cancellationDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"format": "date",
"example": "2022-05-20"
},
"contactMethodWithMerchantInd": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": true
},
"contactMethodMerchantEmailInd": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": true
},
"contactMethodMerchantCallCenterInd": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": true
},
"contactMethodMerchantMailInd": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": true
},
"contactMethodMerchantSMSInd": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": true
},
"contactMethodMerchantInPersonInd": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": true
},
"contactMethodMerchantWebformInd": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": true
},
"contactMerchantDetailsPhoneNumber": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13)."
},
"contactMerchantDetailsEmailAddress": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13)."
},
"contactMerchantDetailsPhysicalAddress": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13)."
},
"contactMerchantDetailsApplicationName": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13)."
},
"otherFormOfPaymentInd": {
"type": "boolean",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": true
},
"otherFormOfPaymentDesc": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13)."
},
"accountClosureDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"format": "date",
"example": "2022-05-20"
},
"cancellationMethod": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"maxLength": 10000
},
"disputeRelateToOffpremisesDistanceSellInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
]
},
"disputeRelateToInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"contractDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"format": "date",
"example": "2022-05-20"
},
"merchandiseOrServices": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Merchandise",
"enum": [
"Merchandise",
"Services"
]
},
"serviceType": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "T",
"enum": [
"T",
"G",
"O"
]
},
"whatWasPurchased": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Provide details of what was purchased...",
"maxLength": 10000
},
"cardholderReceiveMerchandiseInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"chReceivedOrExpectedMerchandise": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"cardholderReturnMerchandiseInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"cardholderReturnedMerchandiseDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20",
"format": "date"
},
"returnedMerchandiseReceivedDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20",
"format": "date"
},
"returnMethod": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "FF",
"enum": [
"FF",
"FE",
"D",
"U",
"P",
"O"
]
},
"howMerchandiseReturned": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Explain how the merchandise was returned...",
"maxLength": 10000
},
"shippingTrackingNumber": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "774-4u7u3-u4u4u-35347",
"maxLength": 50
},
"cardholderAttemptReturnMerchandise": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
]
},
"attemptedReturnDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"howChAttemptReturnAndDispOfMerchandise": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Provide a detailed description of how the cardholder attempted to return and the disposition of the merchandise.",
"maxLength": 10000
},
"merchantRefuseAdvise": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "MRRM",
"enum": [
"MRRM",
"MICNRM"
]
},
"didCardholderCancel": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"didCardholderCancelBeforeShipping": {
"type": "string",
"enum": [
"Y",
"N"
],
"example": "Y",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13)."
},
"timeshareDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"format": "date",
"example": "2022-05-20"
},
"dateOfService": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"certificationGuaranteedReservation": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "GR",
"enum": [
"GR",
"RC",
"AR"
]
},
"cancellationPolicyProvidedInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"whatWasOrdered": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "What was ordered...",
"maxLength": 10000
},
"merchandiseWasCounterfeitDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"descCounterfeitMerchandise": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Describe the counterfeit merchandise",
"maxLength": 10000
},
"descDispOfCounterfeitMerchandise": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Describe the disposition of the counterfeit merchandise",
"maxLength": 10000
},
"originalCreditNotAccepted": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "R",
"enum": [
"R",
"O"
]
},
"explain": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Explain",
"maxLength": 10000
},
"creditVoucherTransactionReceiptDated": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"creditVoucherOrTransactionReceiptDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"cardholderCancelledReturnedMerchDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"merchantInLiquidationOrReceivershipInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"whatWasNotReceived": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "What was not received?"
},
"thirdPartyGiftCardInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"visaComCardVirtualAccInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"virtualAccFinancialLossInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"didMerchantCancelInd": {
"type": "string",
"description": "alid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Y",
"enum": [
"Y",
"N"
]
},
"merchantCancellationDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"nonReceiptOfTravelServicesInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"disputeInvolveBondingAuthorityInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"explainAttemptToResolveWithBondAuth": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"maxLength": 10000,
"example": "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": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"purchasedInfo": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Provide detailed description of what was purchased and an explanation of the dispute",
"maxLength": 10000
},
"expectedReceiptDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"expectedReceiptTime": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"maxLength": 25,
"example": "10:30"
},
"explainDisputePriorDeliveryDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"maxLength": 10000,
"example": "Explanation of dispute initiated prior to the expected delivery date"
},
"didCardholderCancelPriorExpectedDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"merchandiseDeliveredWrongLocation": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"lateDeliveryWrongLocation": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"maxLength": 10000,
"example": "Provide address of the agreed location or details of late delivery"
},
"didMerchantCancelMerchandiseInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"merchantCancelMerchandiseDate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "What was ordered and how it was damaged"
},
"merchandiseReceivedDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"cardholderMerchantPreviousNegotiationEvidence": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"whenNegotiationsBegin": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"explainPrevNegotiation": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"maxLength": 10000,
"example": "Explain the previous ongoing negotiations between the cardholder and merchant."
},
"cardholderFirstNotifiedIssuerDisputeDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"serviceReceivedDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"howMerchandiseOrServiceMisrepresented": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "How was the merchandise or service misrepresented?",
"maxLength": 10000
},
"merchandiseServiceReceivedDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"explainPreNegotiation": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Explain the previous ongoing negotiations between the cardholder and merchant."
},
"orderDetailsNotAsDescribed": {
"type": "string",
"maxLength": 10000,
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Provide details of what was ordered and not as described"
},
"merchantReceivedReturnedMerchandiseDate": {
"type": "string",
"format": "date",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "2022-05-20"
},
"merchantAcceptCancellationInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"qualityOfFoodInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13)."
},
"purchasedInfoAndQualityIssue": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Provide information about what was purchased and the quality issue",
"maxLength": 10000
},
"didCardholderPayWorkRedone": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"howTermsOfContractNotHonoredByMerchant": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "Provide details how the terms of the contract were either not honored by the merchant or not as described",
"maxLength": 10000
},
"nonFiatCurrencyNotDelivered": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"merchandiseDeliveredLate": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"merchantInBankruptcyLiquidationInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"nonFiatCurrencyNotMatching": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
],
"example": "Y"
},
"dispositionOfMerchandise": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"example": "a"
},
"merchantAcceptInd": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13).",
"enum": [
"Y",
"N"
]
},
"explainCreditIssuedLateDetailsOfNegotiations": {
"type": "string",
"description": "Valid in VISA Consumer Disputes Flux (Reason Code 13)."
}
},
"x-examples": {
"collaborationQuestionnaire": {
"incorrectCurrencyReason": "CD",
"authorizationRequestDeclinedValidDataInd": true,
"explainWhyValidDataInclusionReason": "Explain why the inclusion of valid data would have caused the Authorization Request to be declined",
"processingDateOver10DaysFmTransDateInd": true,
"processingDateOver180DaysFmTransDateInd": true,
"processingDateOver45DaysFmTransDateInd": true,
"correctCurrency": 123,
"cardholderDidNotAgreeDCC": "Y",
"transactionCodeIncorrect": "CRI",
"rolTransactionId": 123,
"incorrectTransactionId": "string",
"explainWhyCreditRefundProcessedInError": "Explain why the credit refund was processed in error",
"issuerMasterFileAccountNumberInd": "Y",
"receiptAccountNumberMatchInd": "Y",
"matchingAuthTranId": 1234567890123456,
"authorizationDate": "2022-05-20",
"authorizationCode": "A12B34",
"cardholderReceiptAmt": 12,
"merchantDisputePriceDiffInd": "Y",
"bothTransactionsOnSameAcctNumberInd": "Y",
"duplicateTranId": "123456789012345",
"duplicateTranDate": "2022-05-20",
"duplicateTranAmount": 123,
"duplicateARN": "112233445566778899001234",
"issuerOrCardholderOtherAcctWithDiffVisaCardInd": "Y",
"issuerEvidenceMerchantPassedOnFundsInd": "Y",
"cardholderAttemptToResolve": "Y",
"attemptToResolveProhLocalLaw": "Y",
"otherTranSameMerchantInd": "Y",
"providingPaymentProofOtherMeans": "A",
"arn": "001122334455667788991234",
"transactionID": "123456789012345",
"merchantFacilitiesWithdrawn": false,
"cardholderDeceased": false,
"cancellationDate": "2022-05-20",
"accountClosureDate": "2022-05-20",
"cancellationMethod": "Cancellation Reason.",
"disputeRelateToOffpremisesDistanceSellInd": "Y",
"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": "Tracking Number",
"cardholderAttemptReturnMerchandise": "Y",
"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",
"timeshareDate": "2022-05-20",
"dateOfService": "2022-05-20",
"certificationGuaranteedReservation": "GR",
"cancellationPolicyProvidedInd": "Y",
"whatWasOrdered": "What was ordered?",
"whereIsMerchandiseLocated": "Where is the merchandise located?",
"merchandiseWasCounterfeitDate": "2022-05-20",
"descCounterfeitMerchandise": "Describe the counterfeit merchandise",
"descDispOfCounterfeitMerchandise": "Describe the disposition of the counterfeit merchandise",
"originalCreditNotAccepted": "R",
"explain": "Explain",
"creditVoucherTransactionReceipt": "Y",
"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",
"damagedOrDefectiveOrderInfo": "What was ordered and how it was damaged or defective?",
"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",
"merchantReceivedReturnedMerchandiseDate": "2022-05-20",
"serviceReceivedDate": "2022-05-20",
"howMerchandiseOrServiceMisrepresented": "How was the merchandise or service misrepresented?",
"merchandiseServiceReceivedDate": "2022-05-20",
"orderDetailsNotAsDescribed": "Provide details of what was ordered and not as described",
"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",
"merchantAcceptInd": "Y",
"explainCreditIssuedLateDetailsOfNegotiations": "Pending"
}
}
},
"PreArbitration": {
"title": "preArbitration",
"x-stoplight": {
"id": "re5qc7d6fd1es"
},
"type": "object",
"required": [
"preArbReason"
],
"properties": {
"preArbReason": {
"type": "string",
"description": "Pre-arbitartion reason",
"example": "Reason for pre-aritration"
},
"newInformationInd": {
"type": "string",
"example": "Y",
"description": "New information - `Y` or `N`",
"enum": [
"Y",
"N"
]
},
"newInformationDescription": {
"type": "string",
"description": "New information description",
"example": "New information..."
},
"issuerCertifiesCardholderContactedInd": {
"type": "string",
"description": "Issuer certifies cardholder contact",
"enum": [
"Y",
"N"
]
}
},
"x-examples": {
"pre-arbitration visa collaboration request": {
"preArbReason": "Reason",
"newInformationInd": "Y",
"newInformationDescription": "New information",
"issuerCertifiesCardholderContactedInd": "Y"
}
}
},
"DisputeFormType": {
"title": "DisputeFormType",
"x-stoplight": {
"id": "moy5ivwdu1d1f"
},
"type": "object",
"x-examples": {
"ebdf": {
"dispute_form_type_id": 1,
"type": "ebdf",
"description": "ebdf form"
},
"collaborationQuestionnaire": {
"dispute_form_type_id": 2,
"type": "collaborationQuestionnaire",
"description": "Collaboration questionnaire visa"
},
"preArbitration": {
"dispute_form_type_id": 3,
"type": "preArbitration",
"description": "Questionnaire pre-arbitration visa"
},
"clearingElo": {
"dispute_form_type_id": 4,
"type": "clearingElo",
"description": "Clearing of Transaction Elo"
},
"allocationQuestionnaire": {
"dispute_form_type_id": 5,
"type": "allocationQuestionnaire",
"description": "Allocation questionnaire visa"
}
},
"properties": {
"dispute_form_type_id": {
"type": "number",
"description": "Unique id identification"
},
"type": {
"type": "string",
"description": "Unique type identification"
},
"description": {
"type": "string",
"description": "Generic description"
}
}
},
"CreatedAt": {
"type": "string",
"description": "Created at datetime, format = yyyy-mm-dd hh:mm:ss\"",
"example": "2024-10-18 11:21:45"
}
},
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Account access token. Tokens can expire quickly, which can result in an \"Unauthorized\" error.",
"bearerFormat": "JWT"
}
},
"responses": {
"401Unauthorized": {
"description": "Unauthorized. Invalid or missing access token."
},
"404NotFound": {
"description": "Not found"
},
"422UnprocessableEntity": {
"description": "Unprocessable entity"
},
"500InternalServerError": {
"description": "Internal server error"
}
}
},
"paths": {
"/v1/disputes/{disputeId}/forms": {
"post": {
"summary": "Create dispute form",
"description": "Create a dispute form with more information to send to the network.\n\nYou can create one of the following types of Expedited Billing Dispute Forms (EBDF):\n\n1. **fraudDrfDocument** - Used for cases of fraud\n\n2. **cardholderDisputeChargebackDrfDocument** - Used when the cardholder disputes a purchase and notifies the card issuer.\n\n3. **pointOfInteractionErrorsDrfDocument** - Used when there's either a disagreement between parties or an error with the transaction. For example, a wrong value or a duplicate charge.\n\nFor VISA, you need to fill out the `allocationQuestionnaire` (reason 11) or `collaborationQuestionnaire` (reason 12 and 13) form object. VISA's rules for filling out form fields can be found in [this guide document](https://developers.pismo.io/pismo-docs/docs/visa-colloboration-questionaire)\n\nFor Elo, you need to fill out the `clearingElo` form object.\n",
"operationId": "post-v1-disputes-disputeId-forms",
"tags": [
"Supporting forms"
],
"parameters": [
{
"$ref": "#/components/parameters/disputeId"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisputeFormRequest"
},
"examples": {
"Create a Dispute Form Master with success": {
"value": {
"dispute_installment_id": 0,
"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",
"cardholderParticipation": false,
"disputeDetails": "Test Dispute details",
"chargebackRepresentative": "Test Representative"
},
"pointOfInteractionErrorsDrfDocument": {
"transactionAmount": "20000",
"type": "DUPLICATE_DEBIT",
"alternateMeansOfPaymentDetails": "Test alternate means of payment details",
"disputeDetails": "Test Dispute details",
"chargebackRepresentative": "Test Representative"
}
}
}
}
},
"Create a Dispute Form Visa Allocation with success": {
"value": {
"dispute_installment_id": 0,
"form": {
"allocationQuestionnaire": {
"accountStatus": "AC"
}
}
}
},
"Create a Dispute Form Visa Collaboration with success": {
"value": {
"dispute_installment_id": 0,
"form": {
"collaborationQuestionnaire": {
"incorrectCurrencyReason": "CD",
"authorizationRequestDeclinedValidDataInd": true,
"explainWhyValidDataInclusionReason": "Explain why the inclusion of valid data would have caused the Authorization Request to be declined",
"processingDateOver10DaysFmTransDateInd": true,
"processingDateOver180DaysFmTransDateInd": true,
"processingDateOver45DaysFmTransDateInd": true,
"correctCurrency": 123,
"cardholderDidNotAgreeDCC": "Y",
"transactionCodeIncorrect": "CRI",
"rolTransactionId": 123,
"incorrectTransactionId": "string",
"explainWhyCreditRefundProcessedInError": "Explain why the credit refund was processed in error",
"issuerMasterFileAccountNumberInd": "Y",
"receiptAccountNumberMatchInd": "Y",
"matchingAuthTranId": 1234567890123456,
"authorizationDate": "2022-05-20",
"authorizationCode": "A12B34",
"cardholderReceiptAmt": 12,
"merchantDisputePriceDiffInd": "Y",
"bothTransactionsOnSameAcctNumberInd": "Y",
"duplicateTranId": "123456789012345",
"duplicateTranDate": "2022-05-20",
"duplicateTranAmount": 123,
"duplicateARN": "112233445566778899001234",
"issuerOrCardholderOtherAcctWithDiffVisaCardInd": "Y",
"issuerEvidenceMerchantPassedOnFundsInd": "Y",
"cardholderAttemptToResolve": "Y",
"attemptToResolveProhLocalLaw": "Y",
"otherTranSameMerchantInd": "Y",
"providingPaymentProofOtherMeans": "A",
"arn": "001122334455667788991234",
"transactionID": "123456789012345",
"merchantFacilitiesWithdrawn": false,
"cardholderDeceased": false,
"cancellationDate": "2022-05-20",
"accountClosureDate": "2022-05-20",
"cancellationMethod": "Cancellation Reason.",
"disputeRelateToOffpremisesDistanceSellInd": "Y",
"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": "Tracking Number",
"cardholderAttemptReturnMerchandise": "Y",
"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",
"timeshareDate": "2022-05-20",
"dateOfService": "2022-05-20",
"certificationGuaranteedReservation": "GR",
"cancellationPolicyProvidedInd": "Y",
"whatWasOrdered": "What was ordered?",
"whereIsMerchandiseLocated": "Where is the merchandise located?",
"merchandiseWasCounterfeitDate": "2022-05-20",
"descCounterfeitMerchandise": "Describe the counterfeit merchandise",
"descDispOfCounterfeitMerchandise": "Describe the disposition of the counterfeit merchandise",
"originalCreditNotAccepted": "R",
"explain": "Explain",
"creditVoucherTransactionReceipt": "Y",
"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",
"damagedOrDefectiveOrderInfo": "What was ordered and how it was damaged or defective?",
"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",
"merchantReceivedReturnedMerchandiseDate": "2022-05-20",
"serviceReceivedDate": "2022-05-20",
"howMerchandiseOrServiceMisrepresented": "How was the merchandise or service misrepresented?",
"merchandiseServiceReceivedDate": "2022-05-20",
"orderDetailsNotAsDescribed": "Provide details of what was ordered and not as described",
"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",
"merchantAcceptInd": "Y",
"explainCreditIssuedLateDetailsOfNegotiations": "Pending"
}
}
}
},
"Create a Dispute Form Clearing Elo with success": {
"value": {
"dispute_installment_id": 0,
"form": {
"clearingElo": {
"transactionDestinationInstitutionIdCode": "",
"filePathMessageNumber": "",
"additionalDataRecord": {
"airportTaxValue": "000000000000",
"changeValue": "00000000000",
"codeProduct": "071",
"conditionalCodeChipTransaction": "1",
"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",
"correlationId": "a40465a2-82af-4721-8938-383xxxxxxxxx",
"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": null
},
"mainDataRecord": {
"authorizationOrCancellationOriginIndicator": "1",
"cardholderVerificationMethod": "1",
"cardNumber": "",
"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": "82",
"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"
},
"s3Path": "",
"settlementCountryDataRecord": {
"countryCodeSettlement": "BR",
"dateLiquidationTransaction": "20230718",
"dateMovementTransactionOriginal": "00000000",
"municipalCode": "0000000",
"networkReferenceId": "1982391A0020319",
"pointOfSaleMarketplaceCode": "000000000000000",
"quantityDaysFinancialTransaction": "001",
"transactionCode": "06",
"transactionSubCode": "02",
"valueExchange": "0000000000",
"zipCodeEstablishmentCommercial": "i7qQFhLh"
}
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisputeFormResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/401Unauthorized"
},
"404": {
"$ref": "#/components/responses/404NotFound"
},
"422": {
"$ref": "#/components/responses/422UnprocessableEntity"
},
"500": {
"$ref": "#/components/responses/500InternalServerError"
}
}
}
}
}
}
```