Dispute API 3.0 Workflows
The Creating an API 3.0 Dispute guide gives general instructions for creating a dispute claim. This page shows the endpoint workflows for specific combinations of ClaimReasonType and ClaimReason, which you submit with the /claim/intake/addClaimReasons endpoint (third endpoint in every sequence).
Warning
You must call the endpoints in the order shown for each dispute type. Failure to follow the sequence will prevent you from completing the intake flow.
ClaimReasonType | ClaimReason |
|---|---|
Fraud"I did not authorize this transaction. I suspect fraud." | CardLost — "I lost my card."CardStolen — "My card was stolen."CardNotReceived — "I did not receive my card."CardSecure — "I didn't make the purchase, but I still have my card." |
NonFraud"I made this purchase, but there is a problem and I need to dispute it." | MerchantDuplicate — "I was charged more than once." MerchantCreditNotIssued — Mastercard only. "I canceled or returned the merchandise or service and have not received the expected credit." MerchantNotProvided — "I haven't received merchandise or a service I purchased." MerchantRecurring — "I have an issue with a recurring transaction on my account."MerchandiseServiceIssue — "I am dissatisfied with merchandise or a service I received." ChargedCreditedIncorrect — "I was charged or credited incorrectly." |
Fraud workflow
When ClaimReasonType is Fraud, call these endpoints in this order.
Initiate the claim and obtain the claim reason
/claim/intake/create/claim/intake/retrieveReasons/claim/intake/addClaimReasons
/claim/intake/retrieveTransactions/claim/intake/addTransactions
Get follow-up questionnaire answers
/claim/intake/retrieveQuestionnaire/claim/intake/addQuestionnaire
- Optional.
/claim/intake/retrieveDocRequirements - Optional.
/claim/intake/addDocuments
- Optional.
/claim/intake/retrieveSummary /claim/intake/submit
Non-fraud workflows
When ClaimReasonType is NonFraud, follow one of these sequences:
Merchant duplicate
Follow this sequence when ClaimReason is MerchantDuplicate.
Initiate the claim and obtain the claim reason
/claim/intake/create/claim/intake/retrieveReasons/claim/intake/addClaimReasons
/claim/intake/retrieveTransactions/claim/intake/addTransactions
Get follow-up questionnaire answers
/claim/intake/retrieveQuestionnaire/claim/intake/retrieveOtherAccounts/claim/intake/retrieveSimilarTransactions/claim/intake/addSimilarTransactions/claim/intake/addQuestionnaire
- Optional.
/claim/intake/retrieveDocRequirements - Optional.
/claim/intake/addDocuments
- Optional.
/claim/intake/retrieveSummary /claim/intake/submit
Merchant credit not issued
Mastercard only
Follow this sequence when ClaimReason is MerchantNotProvided, MerchantRecurring, MerchandiseServiceIssue or ChargedCreditedIncorrect.
Initiate the claim and obtain the claim reason
/claim/intake/create/claim/intake/retrieveReasons/claim/intake/addClaimReasons
/claim/intake/retrieveTransactions/claim/intake/addTransactions
Get follow-up questionnaire answers
/claim/intake/retrieveQuestionnaire- Optional.
/claim/intake/retrieveCreditTransactions - Optional.
/intake/addSimilarTransactions /claim/intake/addQuestionnaire
- Optional.
/claim/intake/retrieveDocRequirements - Optional.
/claim/intake/addDocuments
- Optional.
/claim/intake/retrieveSummary /claim/intake/submit
Other reasons
Follow this sequence when ClaimReason is MerchantNotProvided, MerchantRecurring, or MerchandiseServiceIssue, ChargedCreditedIncorrect.
Initiate the claim and obtain the claim reason
/claim/intake/create/claim/intake/retrieveReasons/claim/intake/addClaimReasons
/claim/intake/retrieveTransactions/claim/intake/addTransactions
Get follow-up questionnaire answers
/claim/intake/retrieveQuestionnaire/claim/intake/addQuestionnaire
- Optional.
/claim/intake/retrieveDocRequirements - Optional.
/claim/intake/addDocuments
- Optional.
/claim/intake/retrieveSummary /claim/intake/submit
Updated 14 days ago
