# Create dispute installment
Create a dispute installment for transactions with multiple Installments.
This endpoint generates a [Dispute installment created](https://developers.pismo.io/events/docs/disputes-dispute-installment-creation-1) event.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"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": "Installments",
"description": "Endpoints to handle disputes applied to installments"
}
],
"components": {
"parameters": {
"disputeId": {
"name": "disputeId",
"in": "path",
"description": "Dispute ID",
"required": true,
"schema": {
"type": "number"
}
}
},
"schemas": {
"DisputeID": {
"type": "number",
"description": "Dispute ID",
"example": 1876567
},
"disputeDueTo": {
"type": "string",
"description": "**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.
\n\n`NR` = Merchandise/services not receive
\n`CR` = Cancelled recurring transaction
\n`ND` = Not as described
\n`DM` = Damaged or defective merchandise
\n`Q` = Quality
\n`CM` = Counterfeit merchandise
\n`M` = Misrepresentation
\n`CN` = Credit not processed
\n`CS` = Cancelled merchandise/services
\n`OC` = Original credit not accepted
\n`CL` = Non-receipt of cash
\n`TC` = Terms of contract (virtual account)
\n`D` = Duplicate
\n`IAN` = Incorrect account number
\n`IA` = Incorrect amount
\n`IC` = Incorrect currency
\n`IT` = Incorrect transaction code
\n`ID` = Invalid data
\n`LP` = Late presentment
\n`P` = Paid by other means
\n\nFor VISA, you need to fill out the `collaborationQuestionnaire` form object in the [Create dispute form](https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-disputeid-forms) endpoint.\n",
"enum": [
"NR",
"CR",
"ND",
"DM",
"Q",
"CM",
"M",
"CN",
"CS",
"OC",
"CL",
"TC",
"D",
"IAN",
"IA",
"IC",
"IT",
"ID",
"LP",
"P"
],
"example": "NR"
},
"reasonCode": {
"type": "number",
"description": "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](https://www.chargebackgurus.com/blog/a-definitive-guide-to-chargeback-reason-codes-by-card-network#chargback-reason-code-quick-reference-guide) for the major credit card networks.\n\nFor Visa, this would be either `10` (fraud - card present), `11` (authorization), `12` (processing error), or `13` (consumer dispute).\n\nFor more infomation, refer to the [Visa](https://usa.visa.com/dam/VCOM/global/support-legal/documents/chargeback-management-guidelines-for-visa-merchants-vbs-19-may-16-%20v2.pdf) or [Mastercard](https://www.mastercard.us/content/dam/public/mastercardcom/na/global-site/documents/chargeback-guide.pdf) chargeback quides.\n\nFor example - `4853` (Mastercard - cardholder dispute), `12` (Visa - processing error) or `72` (ELO - denied authorization)\n",
"example": 4853
},
"DisputeGroupStatus": {
"description": "Group status enums\n",
"type": "string",
"example": "OPEN",
"enum": [
"OPEN",
"APPROVED",
"DENIED",
"CARDNETWORK_CHARGEBACK",
"ANALYSING",
"CARDNETWORK_SECOND_PRESENTMENT",
"FAILED",
"CARDNETWORK_PREARBITRATION",
"RESEND",
"LOSS",
"WON",
"REJECTED",
"FAILED_PROCESSED"
]
},
"DisputeFormStatus": {
"type": "string",
"example": "PENDING",
"description": "Dispute form status.",
"enum": [
"PENDING",
"PROCESSED",
"FAILED",
"INACTIVE"
]
},
"DisputeStatusObject": {
"type": "object",
"description": "Dispute status informations.",
"properties": {
"id": {
"type": "number",
"example": 5634,
"description": "Dispute status ID."
},
"description": {
"type": "string",
"example": "CHARGEBACK_CONFIDENCE_CREDIT_SYSTEM_DISAGREEMENT",
"description": "Description status - enums for a client's state machine, not to be implemented for anyone else at this point."
},
"type": {
"type": "string",
"example": "MASTERCARD_CARD",
"description": "Type status ID."
},
"group": {
"$ref": "#/components/schemas/DisputeGroupStatus"
}
}
},
"NetworkBrand": {
"type": "string",
"example": "Visa",
"description": "Network brand",
"enum": [
"Visa",
"Mastercard",
"Elo"
]
},
"DisputeInstallmentId": {
"type": "integer",
"description": "Dispute installment ID.",
"example": 8675309
},
"DisputeInstallment": {
"title": "DisputeInstallment",
"type": "object",
"description": "Dispute installment information",
"properties": {
"id": {
"type": "number",
"example": 50068,
"description": "Dispute installment ID."
},
"dispute_id": {
"$ref": "#/components/schemas/DisputeID"
},
"installment": {
"type": "integer",
"example": 2,
"description": "Installment number."
},
"arn": {
"type": "string",
"example": "000000485723",
"description": "Installment acquirer reference number."
},
"chargeback_id": {
"type": "string",
"example": "4586",
"description": "Network chargeback ID.",
"nullable": true
},
"claim_id": {
"type": "string",
"example": "00058678",
"description": "Network claim ID.",
"nullable": true
},
"installment_disputed_amount": {
"type": "number",
"example": 45.5,
"description": "Installment disputed amount."
},
"network_return_reason_code": {
"type": "string",
"description": "Network returned reason code.",
"example": "4853",
"nullable": true
},
"networkStatus": {
"type": "string",
"description": "Dispute status from the network",
"example": "Authorization Dispute - Accepted by Acq"
},
"reason_code": {
"$ref": "#/components/schemas/reasonCode"
},
"network_return_reject_reason": {
"example": "5000",
"description": "Formated network reject reason information.",
"type": "string",
"nullable": true
},
"network_response_error": {
"example": "The network returned [Create First Chargeback - Details provided in the request are invalid.], reasonCode [INVALID_REQUEST] and the source [SYSTEM]",
"description": "Network response error.",
"type": "string",
"nullable": true
},
"dispute_status": {
"$ref": "#/components/schemas/DisputeStatusObject"
},
"network_response": {
"type": "object",
"description": "Network response information",
"nullable": true,
"properties": {
"id": {
"type": "number",
"example": 5,
"description": "Network response ID."
},
"dispute_id": {
"$ref": "#/components/schemas/DisputeID"
},
"dispute_installment_id": {
"$ref": "#/components/schemas/DisputeInstallmentId"
},
"claim_id": {
"type": "string",
"example": "00058678",
"description": "Network claim ID."
},
"chargeback_id": {
"type": "string",
"example": "4586",
"description": "Network chargeback ID."
},
"reason_code": {
"$ref": "#/components/schemas/reasonCode"
},
"response_error": {
"type": "string",
"example": "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].",
"description": "Network response error."
},
"reject_reason": {
"type": "string",
"example": "Code1=0283(00):D0025/000;DE072=D0025\\4837\\\\",
"description": "Network reject reason information."
}
}
},
"transaction_id": {
"example": "5000",
"description": "Transaction ID.",
"type": "string",
"nullable": true
},
"dispute_form_list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DisputeFormResponse"
}
},
"dispute_fraud_report": {
"$ref": "#/components/schemas/DisputeFraudReportDto"
},
"pre_arbitration": {
"$ref": "#/components/schemas/preArbitrationDto"
},
"dispute_due_to": {
"$ref": "#/components/schemas/disputeDueTo"
},
"chargeback_ref_num": {
"type": "string",
"description": "Chargeback reference number.",
"nullable": true
},
"network_response_amount": {
"type": "number",
"description": "Last amount disputed in the claim registered when getting new information from network brand.",
"nullable": true
},
"network_response_currency": {
"type": "string",
"description": "Last currency of amount disputed in the claim registered when getting new information from network brand.",
"nullable": true
},
"is_first_installment": {
"type": "boolean",
"description": "Dispute installment references authorization's first installment."
},
"network_return_reject_reason_code": {
"example": 5000,
"description": "Formatted network reject reason information.",
"type": "integer",
"nullable": true
}
},
"x-examples": {
"Dispute Installment registered on Mastercom": {
"id": 50068,
"dispute_id": 42,
"installment": 2,
"arn": "000000485723",
"chargeback_id": "4586",
"claim_id": "00058678",
"installment_disputed_amount": 45.5,
"network_return_reason_code": null,
"reason_code": 4853,
"network_return_reject_reason": null,
"network_response_error": null,
"dispute_status": {
"id": 5,
"description": "CHARGEBACK_CONFIDENCE_CREDIT_SYSTEM_DISAGREEMENT",
"type": "MASTERCARD_CARD",
"group": "CARDNETWORK_CHARGEBACK"
},
"network_response": null,
"networkStatus": "Authorization Dispute - Accepted by Acq",
"transaction_id": null,
"dispute_form_list": [
{
"id": 143,
"dispute_id": 42,
"dispute_installment_id": 2,
"status": "FAILED",
"network": "MASTERCARD_CARD",
"form": {
"ebdf": {
"fraudDrfDocument": {
"numberOfItems": "1",
"types": "CARD_CLOSED,REPORT_SAFE",
"additionalInformation": "Test additional information",
"chargebackRepresentative": "Test representative",
"cardIssuerRegion": "LAC",
"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"
}
}
},
"created_at": "2022-08-23 10:45:38",
"created_at_utc": "2022-08-23T10:45:38.000000000Z",
"updated_at": "2022-08-23 10:46:31",
"updated_at_utc": "2022-08-23T10:46:31.000000000Z",
"dispute_form_type": {
"dispute_form_type_id": 1,
"type": "ebdf",
"description": null
}
}
],
"dispute_fraud_report": null,
"pre_arb_master": null,
"chargeback_ref_num": null,
"network_response_amount": null,
"network_response_currency": null,
"is_first_installment": false,
"network_return_reject_reason_code": null
},
"Rejected Dispute Installment": {
"id": 50068,
"dispute_id": 42,
"installment": 1,
"arn": "000000485723",
"chargeback_id": "4586",
"claim_id": "00058678",
"installment_disputed_amount": 45.5,
"network_return_reason_code": "2844",
"reason_code": 4853,
"network_return_reject_reason": "Code1=0283(00):D0025/000;DE072=D0025\\\\\\\\4837\\\\\\\\\\\\\\\\",
"network_response_error": null,
"dispute_status": {
"id": 5,
"description": "REJECTED_CHARGEBACK_CONFIDENCE_CREDIT_SYSTEM_DISAGREEMENT",
"type": "MASTERCARD_CARD",
"group": "DENIED"
},
"network_response": null,
"networkStatus": "Authorization Dispute - Accepted by Acq",
"transaction_id": null,
"dispute_form": null,
"dispute_fraud_report": null,
"dispute_form_id": null,
"pre_arb_master": null,
"chargeback_ref_num": null,
"network_response_amount": null,
"network_response_currency": null,
"is_first_installment": true,
"network_return_reject_reason_code": 283
}
}
},
"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": "MASTERCARD_CARD",
"description": "Network for dispute Form.",
"enum": [
"MASTERCARD_CARD",
"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": {
"description": "Created at date, format = yyyy-mm-dd",
"type": "string",
"format": "date",
"example": "2021-02-22"
},
"created_at_utc": {
"description": "Created at UTC date",
"type": "string",
"format": "date-time",
"example": "2021-02-21T22:51:43.000000000Z"
},
"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"
}
}
},
"DisputeFraudReportDocumentStructure": {
"type": "object",
"required": [
"acct_status",
"chgbk_indicator",
"cvc_invalid_indicator",
"device_type",
"fraud_type",
"report_date",
"sub_type"
],
"properties": {
"acct_status": {
"type": "string",
"description": "Account status",
"example": "ACCT_IS_OPEN",
"enum": [
"ACCT_IS_OPEN",
"ACCT_HAS_BEEN_CLOSED"
]
},
"chgbk_indicator": {
"type": "string",
"description": "Indicates if this is a chargeback. true = `1`, false = `0`",
"example": "1",
"enum": [
"0",
"1"
]
},
"cvc_invalid_indicator": {
"type": "string",
"description": "Mastercard CVC invalid code indicator\n",
"example": "Y",
"enum": [
"Y",
"*",
"M",
"N",
"P",
"U",
"?",
"E"
]
},
"device_type": {
"type": "string",
"description": "Mastercard account device type.\n",
"example": "1",
"enum": [
"1",
"2",
"3",
"4",
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J"
]
},
"fraud_type": {
"type": "string",
"description": "Mastercard fraud type codes\n",
"enum": [
"00",
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"51",
"55",
"56",
"57"
],
"example": "00"
},
"report_date": {
"type": "string",
"description": "Fraud report date, format = yyyy-mm-dd.",
"example": "2021-02-11"
},
"sub_type": {
"type": "string",
"description": "Mastercard fraud sub type codes\n",
"example": "K",
"enum": [
"K",
"N",
"P",
"U"
]
},
"authorization_origin_indicator": {
"type": "string",
"description": "Authorization origin indicator, default is null. **REQUIRED** for ELO network.
\n `Y` - Issuer authorized
\n `X` - Parameter authorized
\n `N` - Not Authorized
\n",
"enum": [
"Y",
"X",
"N"
],
"nullable": true,
"minLength": 1,
"maxLength": 1,
"example": "Y"
},
"notification_code": {
"type": "string",
"description": "Notification type code. Default is null. **REQUIRED** for ELO network.
\n `1` - First notification
\n `2` - Notification sent again
\n `3` - Change
\n `4` - Deletion (cancellation fraud warning)
\n `5` = Reactivation
\n",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"nullable": true,
"minLength": 1,
"maxLength": 1,
"example": "1"
},
"exchange_indicator": {
"type": "string",
"description": "Is this an exchange? Default is `N`. **REQUIRED** for ELO network.
\n `Y` - Yes
\n `N` - No
\n",
"enum": [
"N",
"Y"
],
"minLength": 1,
"maxLength": 1,
"example": "N"
},
"exchange_value": {
"type": "number",
"description": "Exchange value. **REQUIRED** for ELO network.",
"example": 9.99
},
"card_service_code": {
"type": "string",
"description": "Card type. **REQUIRED** for ELO network.
\n `C` - Chip
\n `M` - Stripe
\n",
"enum": [
"C",
"M"
],
"minLength": 1,
"maxLength": 1,
"example": "C"
}
},
"x-examples": {
"example-1": {
"acct_status": "ACCT_IS_OPEN",
"chgbk_indicator": "0",
"cvc_invalid_indicator": "Y",
"device_type": "1",
"fraud_type": "00",
"report_date": "2021-02-11",
"sub_type": "K"
}
}
},
"DisputeFraudReportDto": {
"description": "Response to a dispute fraud report.",
"type": "object",
"properties": {
"fraud_report_id": {
"type": "number",
"example": 1,
"description": "Dispute fraud report ID."
},
"status": {
"$ref": "#/components/schemas/DisputeFormStatus"
},
"network_brand_type": {
"$ref": "#/components/schemas/NetworkBrand"
},
"report": {
"$ref": "#/components/schemas/DisputeFraudReportDocumentStructure"
},
"fraud_report_network_id": {
"type": "number",
"example": 1,
"description": "Fraud report network identifier."
},
"comment_network": {
"type": "string",
"example": "Fraud report disputed transaction is already reported to the fraud system Last item fraud is not a FD1.",
"description": "Fraud Report comment network."
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2021-02-22T22:51:43.000000000Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2021-02-22T22:51:43.000000000Z"
}
}
},
"preArbitrationDto": {
"title": "",
"type": "object",
"description": "Information when dispute is submitted to Pre-Arbitration and case was created.",
"x-examples": {},
"properties": {
"pre_arbitration_response_id": {
"type": "number",
"example": 8775309,
"description": "Case ID created from Mastercom."
},
"memo": {
"type": "string",
"description": "Enter a memo pertaining to the case.",
"example": "This is a test memo."
},
"updated_chargeback_reason_code": {
"$ref": "#/components/schemas/reasonCode"
},
"merchant_name": {
"type": "string",
"example": "Acme Dry Goods",
"description": "Merchant name."
},
"acquiring_institution_code": {
"type": "string",
"example": "004321",
"description": "Acquiring institution code."
},
"change_reason_code_reason": {
"type": "string",
"description": "Change reason code reason.",
"example": "This is a test reason"
},
"case_network_response": {
"type": "string",
"example": "COMPLETED_SND_2/10/2021 8:43:21 AM",
"description": "Updates response from Mastecom about the case."
},
"justify_not_accepted_fully": {
"type": "string",
"description": "Justify why not accepted fully",
"example": "Only partial amount in dispute."
},
"is_partial": {
"type": "boolean",
"description": "Is this a partial dispute? Default is `false`.",
"default": false
},
"currency_code_request": {
"type": "string",
"description": "ISO 4217 3-letter currency code request.",
"example": "840"
},
"currency_code_response": {
"$ref": "#/components/schemas/CurrencyCode"
},
"amount_request": {
"type": "number",
"description": "Request amount",
"example": 18.36
},
"amount_response": {
"type": "number",
"description": "Response amount",
"example": 15.25
},
"acquirer_memo": {
"type": "string",
"description": "Memo from the acquirer included in the Mastercard pre-arbitration rejection response.",
"example": "Not valid"
},
"action": {
"type": "string",
"description": "Network pre-arbitration action.",
"enum": [
"ACCEPT",
"REJECT",
"REBUT",
"ESCALATE",
"WITHDRAW",
"FAVORSENDER",
"FAVORRECEIVER",
"DECLINED",
"MODIFYCASE",
"CREATECASE",
"EXPIRED"
],
"example": "REJECT"
},
"response_date": {
"type": "string",
"description": "Date of the network's pre-arbitration response. Format = yyyy-mm-dd",
"example": "2021-02-14"
}
}
},
"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"
}
}
},
"CurrencyCode": {
"type": "string",
"description": "ISO 4217 3-letter currency code, For example, `986` = Brazilian real and `840` = US dollar.",
"example": "840"
}
},
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Account access token. Tokens can expire quickly, which can result in an \"Unauthorized\" error.",
"bearerFormat": "JWT"
}
},
"responses": {
"400BadRequest": {
"description": "Bad Request"
},
"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}/installment": {
"post": {
"summary": "Create dispute installment",
"description": "Create a dispute installment for transactions with multiple Installments.\n\nThis endpoint generates a [Dispute installment created](https://developers.pismo.io/events/docs/disputes-dispute-installment-creation-1) event.\n",
"operationId": "post-v1-disputes-disputeId-installment",
"tags": [
"Installments"
],
"parameters": [
{
"$ref": "#/components/parameters/disputeId"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"installment": {
"type": "integer",
"example": 1,
"description": "Installment number."
},
"arn": {
"type": "string",
"example": "000000000042",
"description": "Installment acquirer reference number."
},
"installment_disputed_amount": {
"type": "number",
"example": 50,
"description": "Disputed installment value"
},
"reason_code": {
"$ref": "#/components/schemas/reasonCode"
},
"document_indicator": {
"type": "boolean",
"description": "Document submission indicator (ELO). Default is `true`.",
"example": true
}
},
"required": [
"installment",
"arn",
"installment_disputed_amount"
]
},
"examples": {
"Create a Dispute Installment with success": {
"value": {
"installment": 1,
"arn": "000000000042",
"installment_disputed_amount": 50,
"reason_code": 4853
}
}
}
}
},
"description": "Dispute Installment informations."
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisputeInstallment"
},
"examples": {
"Dispute Installment registered on Mastercom": {
"value": {
"id": 50068,
"dispute_id": 42,
"installment": 2,
"arn": "000000485723",
"chargeback_id": "4586",
"claim_id": "00058678",
"installment_disputed_amount": 45.5,
"dispute_status": {
"id": 5,
"description": "CHARGEBACK_CONFIDENCE_CREDIT_SYSTEM_DISAGREEMENT.",
"type": "MASTERCARD_CARD",
"group": "CARDNETWORK_CHARGEBACK"
},
"reason_code": 4853,
"network_return_reason_code": null,
"network_return_reject_reason": null,
"is_first_installment": true,
"network_return_reject_reason_code": null
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400BadRequest"
},
"401": {
"$ref": "#/components/responses/401Unauthorized"
},
"404": {
"$ref": "#/components/responses/404NotFound"
},
"422": {
"$ref": "#/components/responses/422UnprocessableEntity"
},
"500": {
"$ref": "#/components/responses/500InternalServerError"
}
}
}
}
}
}
```