Disputes and chargebacks
Open a dispute against a transaction, attach the evidence, and cancel a case that should not have been raised.
createDisputeCase
Creates a new dispute case for a credit card transaction. Supports multiple dispute case details and DMS references. Returns the case number and related dispute transaction details.
Part of:
- Journey 02 · Managing a card product — step 1, Open and evidence a case
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createDisputeCase › Request Body
ChannelThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
ShadowCardNumberShadow Card Number - [Optional]
CardRefNumberCard Ref Number - [Optional]
EncryptedCardNumberEncrypted Card Number - [Optional]
CardNumberCard Number - [Optional]
CaseTypeCase Type - [Optional]
DisputeDateDispute Date - [Optional]
DisputeReasonCodeDispute Reason Code - [Optional]
DisputeExplanationDispute Explanation - [Optional]
ExternalCaseIdExternal Case Id
SpecialFollowupSpecial Followup
VipFlagVip Flag
Create Dispute Case Detail - [Optional]
Dms Reference - [Optional]
createDisputeCase › Responses
Success
CaseNumberCase Number
Dispute Transaction - [Optional]
cancelDisputeCase
Cancels a dispute case by calling the BKM batch service with case number, channel, description, dispute transaction ID, and UTID. Returns a response indicating whether the cancellation was successful.
Part of:
- Journey 02 · Managing a card product — step 2, Track and manage
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
cancelDisputeCase › Request Body
ChannelThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
CaseNumberCase Number - [Optional]
DisputeTransactionIdDispute Transaction Id - [Optional]
UTIDU T I D - [Optional]
DescriptionDescription - [Optional]
cancelDisputeCase › Responses
Success
isSuccessfulIs Successful
addDocumentByCaseNumber
Adds one or more document references to a case number in the BKM batch system. It requires the channel, case number, and a list of DMS references.
Part of:
- Journey 02 · Managing a card product — step 1, Open and evidence a case
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
addDocumentByCaseNumber › Request Body
ChannelThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
CaseNumberCase Number - [Optional]
ExternalCaseIdExternal Case Id
ExternalDocumentIdExternal Document Id
Dms References - [Optional]
addDocumentByCaseNumber › Responses
Success
getDisputeList
Retrieves a list of dispute transactions for a given card or customer. Filters can be applied by card number, card reference number, case number, customer number, dispute transaction ID, shadow card number, encrypted card number, or UTID. Returns detailed information for each dispute including case number, dispute transaction ID, dispute amount and currency, dispute date and reason code, transaction details (amount, currency, date, status, authorization number, MCC, merchant name), source network, and associated customer/card information.
Part of:
- Journey 02 · Managing a card product — step 2, Track and manage
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getDisputeList › Request Body
CaseNumberCase Number - [Optional]
DisputeTransactionIdDispute Transaction Id - [Optional]
UTIDU T I D - [Optional]
CustomerNumberCustomer Number - [Optional]
ShadowCardNumberShadow Card Number - [Optional]
CardRefNumberCard Ref Number - [Optional]
EncryptedCardNumberEncrypted Card Number - [Optional]
CardNumberCard Number - [Optional]
ExternalCaseIdExternal Case Id
getDisputeList › Responses
Success
Dispute List - [Optional]
getDisputeReasonDefList
Retrieves a list of all dispute reason definitions in the system. Each item includes the dispute reason code and its corresponding description. No input parameters are required.
Part of:
- Journey 02 · Managing a card product — step 1, Open and evidence a case
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getDisputeReasonDefList › Responses
Success
Dispute Reason Definitions - [Optional]