Dispute Management API is one of 26 APIs that JPMorgan Chase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Disputes-Actions, Disputes Data Retrieval, and Health Check. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
8 operations
across 8 paths,
organized into 3 resource areas,
and defines 89 schemas.
It is described by OpenAPI 3.0.1, at version 1.1.3.
Requests are made against 2 base URLs: https://api.payments.jpmorgan.com/commerce/v1, https://api-sandbox.payments.jpmorgan.com/commerce/v1.
The identity and technical contract details declared by the specification.
messages
object
A list of errors and warnings
5 properties
contextMessage
object
Object containing information in the file
4 properties
code
string
Codifies a raised exception encountered by an internal or external system, sub-system, interface, job, module, system component with which the web service appl…
message
string
Provides textual description of a problem that has occurred and is preventing the system from completing a task. Messages can be a confirmation, warning or not…
field
string
The field for which the error has occured.
requestId
string
Unique request identifier provided by the requestor.
platformId
string
Platform identifier provided by the requestor. Identifies the platform used to onboard the merchant and enforce the authentication.
traceId
string
A number assigned by a transaction originator to assist in identifying a transaction uniquely. The systems trace audit number remains unchanged for all message…
healthCheckResource
object
Contains health check information about a resource
1 property
httpStatus
integer
The response code that is returned to the client based on how a backend service handled the request
title
string
Short human readable title of the error
location
string
Location of the field for which the error occurred in the request
disputesRequest
object
Specifies attributes used to query and retrieve a list of dispute cases
11 properties
1 required
entityIds
object
Entity identifiers for a Merchant Organization, determined by the hierarchical structure within the system.
companyIds
object
A list of unique company identifiers. Reserved for future use. Currently not active.
1 property
merchantIds
object
A list of unique processing entities or transaction division identifiers.
1 property
disputeTypes
array
A list of labels representing the categories or cycles of disputes. By default it returns all types of disputes.
disputeStatuses
array
A list of dispute status filters to apply when querying disputes. Use the value 'ALL' to return disputes matching other filters, regardless of their status.
paymentMethodList
array
A list of payment method codes to filter disputes by card brand or payment type.
disputesStatusFilter
string
Represents the possible status values used to filter disputes in a query. Includes all valid dispute statuses, as well as the special value 'ALL' to indicate t…
disputesResponse
object
Disputes response object.
4 properties
3 required
disputeData
object
Dispute information
19 properties
11 required
disputeValue
object
Contains dispute amount and currency.
2 properties
disputeReason
object
Contains reason code and description of a dispute.
2 properties
paymentMethod
object
Contains payment method code and description.
3 properties
merchantData
object
Contains basic data of a merchant.
4 properties
transactionData
object
Contains basic data of an original sale or refund transaction.
6 properties
authorizationData
object
Contains detailed information about transaction authorization.
2 properties
pagination
object
This is used for specifying pagination related information.
1 property
disputeDetailsResponse
object
Dispute details response
3 properties
disputeDetails
object
Includes details of a specific dispute.
31 properties
disputeType
string
Codifies the category of an inquiry or disagreement related to a payment transaction on a consumer payment account.
disputeId
integer
A unique identifier assigned by the acquirer to track each inquiry or case created for a transaction dispute on an account.
acquirerReferenceNumber
string
Identifies a unique number assigned by the payment brand to a credit card transaction for use when it goes from the Firm acting as the acquiring bank through t…
maskedAccountNumber
string
The Card Number is a number recognized by various payment systems to route debit card, ATM and credit Card transactions to an issuer and to identify the underl…
disputeInitiatedDate
string
Designates the date the dispute case record was substantiated or established.
disputeAmount
number
Specifies the monetary value of the total amount of a charge the customer is disputing on their account with the merchant.
disputeCurrencyCode
string
The currency code for the dispute amount, always in the merchant's settlement currency.
disputeReasonCode
string
Codifies the reason for the disputed case.
disputeReasonDescription
string
Textual reason description of the disputed case.
disputeCategoryCode
string
The category of the dispute based on the reason code.
responseDueDate
string
Due date before which the merchant can challenge the dispute in YYYY-MM-DD format.
disputeStatus
string
The label for the current stage of a case in the dispute resolution process
statusUpdateTimestamp
string
Represents the date and time when the status of a dispute case was last updated in UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.
outcome
string
The label given to the financial outcome of a chargeback dispute where money was taken back from the merchant for a sale and indicates if the case has been Won…
paymentMethodCode
string
Codifies the method used to pay for the exchange of money, goods or services between a merchant and their customer. Examples: VI for Visa, MC for MasterCard et…
paymentMethodName
string
English label for the method used to pay for the exchange of money, goods or services between a merchant and their customer. Examples: Visa, MasterCard, PayPal…
merchantOrderNumber
string
A unique identifier assigned by the merchant or on behalf of the merchant for the intention to purchase goods and/or services. The merchant order provides the…
transactionTimestamp
string
Designates the date and time in UTC timezone, on which the original sale or refund transaction was performed. The format is YYYY-MM-DDTHH:MM:SSZ.
authorizationTimestamp
string
Designates the year, month and day along with timestamp when an authorization for a transaction was received by transaction processing system. This may be diff…
authorizationCurrency
string
Codifies the monetary unit that was associated with the financial transaction (such as sale, refund)
transactionAmount
number
Specifies the monetary value of the transaction performed.
transactionCurrency
string
Codifies the monetary unit that was associated with the financial transaction (such as sale, refund)
transactionId
string
The transaction identifier of the original transaction.
submitterPlatformId
string
Identifies the platform used to facilitate the request of the transaction that is being disputed.
companyId
string
Identifies a unique entity which represents a relationship at the highest of the three levels of the account hierarchy of the backend proprietary merchant acqu…
merchantId
string
Identifies a unique entity for transaction processing at the lowest level of the account hierarchy of the backend proprietary merchant acquiring processing pla…
companyName
string
The label given to a unique entity which represents a relationship at the highest of the three levels of the account hierarchy of the back-end proprietary merc…
merchantName
string
The label given to a unique entity for transaction processing at the lowest level of the account hierarchy of the backend proprietary merchant acquiring proces…
authorizationReferenceNumber
string
Identifies a reference number generated at debit card transaction time.
issuerDocumentCode
integer
Codifies a document is required by the payment network from the issuer for a disputed transaction. If this is set to 1, expect an issuer document arrival in ne…
issuerDocumentExpected
boolean
Codifies a document is required by the payment network from the issuer for a disputed transaction. If this is set to true, expect an issuer document arrival in…
issuerDocumentReceived
boolean
Codifies a document is received by the payment network from the issuer for a disputed transaction. If this is set to true, an issuer document is received from…
merchantDataDetailed
object
Contains detailed information about merchant.
4 properties
transactionDataDetailed
object
Contains detailed information about sale or refund transaction.
2 properties
authorizationDataDetailed
object
Contains detailed information about transaction authorization.
10 properties
relatedItemsData
object
Contains information about other related disputes items.
5 properties
caseTimelineEvent
object
Depicts a specific event within the chronological timeline of all events in a particular dispute case.
3 properties
challengeRequest
object
Contains request attributes required to challenge a dispute.
2 properties
2 required
last4CardNumber
string
Identifies the last 4 digits of card number. The truncated value is used in place of the full number to protect against exposure of confidential information.
supportingDocument
object
Contains supporting document information for the dispute action.
2 properties
2 required
challengeDisputeResponse
object
Challenge action response
6 properties
actionProcessingStatus
string
Codifies dispute action processing status code, in response of the case action requested by merchant. Possible values are, INPROGRESS: The request is being pro…
fulfillRequest
object
Contains request attributes required to fulfill retrieval-request dispute.
2 properties
2 required
fulfillDisputeResponse
object
Fulfill action response
6 properties
acceptRequest
object
Contains request attributes required to accept a dispute.
1 property
1 required
acceptDisputeResponse
object
Accept dispute response.
6 properties
disputesStatusData
object
Dispute current status related information.
7 properties
disputesStatusResponse
object
Dispute Response
4 properties
disputesStatusRequest
object
Retrieve dispute status request.
2 properties
1 required
disputeIds
object
List of unique case identifiers.
1 property
relatedFinancialItemsData
object
Dispute related financial items.
2 properties
statusUpdateStartDate
object
Dispute case status update date. This is to set start date-time of the range, in format YYYY-MM-DDTHH:MM:SSZ.
1 property
statusUpdateEndDate
object
Dispute case status update date. This is to set end date-time of the range, in format YYYY-MM-DDTHH:MM:SSZ.
1 property
transactionTypeCode
string
Codifies whether a transaction type will be grouped as a debit, credit or non monetary. C value indicates Credit and D indicates Debit.
disputeDocumentsResponse
object
Dispute document response
4 properties
documentData
object
Document data attached to a case.
3 properties
statusInquiryParameters
object
Status enquiry parameters
relatedItems
array
Includes details about items related to disputes.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
