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 dispute case for a card using provided card info, case type, dispute date, reason, and explanation. Maps optional dispute case details (UTID, currency, amount) and DMS references. Calls _bkmBatchService.CreateDisputeCase and returns CaseNumber and list of DisputeTransaction details including DisputeTransactionId and UTID.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createDisputeCase › Request Body
DisputeDateDispute Date
ChannelThree-digit channel code. 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]
DisputeReasonCodeDispute Reason Code - [Optional]
DisputeExplanationDispute Explanation - [Optional]
Create Dispute Case Detail - [Optional]
Dms Reference - [Optional]
createDisputeCase › Responses
Success
CaseNumberCase Number
Dispute Transaction - [Optional]
cancelDisputeCase
Cancels a dispute case by calling the internal BKM batch service with CaseNumber, Channel, DisputeTransactionId, UTID, and Description. Returns a response indicating whether the cancellation was successful.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
cancelDisputeCase › Request Body
CaseNumberCase Number
DisputeTransactionIdDispute Transaction Id
ChannelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
UTIDU T I D - [Optional]
DescriptionDescription - [Optional]
cancelDisputeCase › Responses
Success
isSuccessfulIs Successful
addDocumentByCaseNumber
Adds one or more document references to an existing case in the core banking system using the provided case number. The service accepts channel information, case number, and a list of DMS document references, and forwards them to the BKM batch service for processing. This operation performs a state-changing action by attaching documents to the specified case.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
addDocumentByCaseNumber › Request Body
CaseNumberCase Number
ChannelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
Dms References - [Optional]
addDocumentByCaseNumber › Responses
Success
getDisputeList
Retrieves the list of dispute transactions. Accepts GetDisputeListRequest with parameters such as CardNumber, CardRefNumber, CaseNumber, CustomerNumber, DisputeTransactionId, EncryptedCardNumber, ShadowCardNumber, and UTID. Calls _bkmBatchService.GetDisputeList() and maps results to GetDisputeListResponse containing DisputeList with properties like CaseNumber, DisputeTransactionId, CustomerNumber, DisputeAmount, DisputeCurrencyCode, DisputeDate, DisputeReasonCode, MaskedCardNumber, MerchantName, TrnAmount, InsertUserId, TrnCurrencyCode, TrnDate, TrnStatusDescription, AuthorizationNumber, Mcc, SourceNetwork, and Utid.
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
DisputeTransactionIdDispute Transaction Id
CustomerNumberCustomer Number
UTIDU T I D - [Optional]
ShadowCardNumberShadow Card Number - [Optional]
CardRefNumberCard Ref Number - [Optional]
EncryptedCardNumberEncrypted Card Number - [Optional]
CardNumberCard Number - [Optional]
getDisputeList › Responses
Success
Dispute List - [Optional]
getDisputeReasonDefList
Retrieves the list of dispute reason definitions. Calls _bkmBatchService.GetDisputeReasonDefList() and maps results to GetDisputeReasonDefResponse containing DisputeReasonDefinitions with properties DisputeReasonCode and DisputeReasonDescription.
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]