JPMorgan Chase Disputes Data Retrieval API is one of 65 APIs that JPMorgan Chase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Disputes Data Retrieval. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
4 operations
across 4 paths,
and defines 78 schemas.
It is described by OpenAPI 3.2.0, 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.
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…
disputeReason
object
Contains reason code and description of a dispute.
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
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.
pagination
object
This is used for specifying pagination related information.
1 property
responseDueDate
string
Due date before which the merchant can challenge the dispute in YYYY-MM-DD format.
disputeType
string
Codifies the category of an inquiry or disagreement related to a payment transaction on a consumer payment account.
relatedItems
array
Includes details about items related to disputes.
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…
merchantDataDetailed
object
Contains detailed information about merchant.
4 properties
disputeIds
object
List of unique case identifiers.
1 property
documentData
object
Document data attached to a case.
3 properties
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…
disputeTypes
array
A list of labels representing the categories or cycles of disputes. By default it returns all types of disputes.
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…
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…
disputeDetails
object
Includes details of a specific dispute.
31 properties
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.
authorizationDataDetailed
object
Contains detailed information about transaction authorization.
10 properties
disputeReasonCode
string
Codifies the reason for the disputed case.
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…
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…
disputeDetailsResponse
object
Dispute details response
3 properties
relatedFinancialItemsData
object
Dispute related financial items.
2 properties
disputesStatusRequest
object
Retrieve dispute status request.
2 properties
1 required
disputeCurrencyCode
string
The currency code for the dispute amount, always in the merchant's settlement currency.
disputeStatus
string
The label for the current stage of a case in the dispute resolution process
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…
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…
disputeAmount
number
Specifies the monetary value of the total amount of a charge the customer is disputing on their account with the merchant.
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.
disputeData
object
Dispute information
19 properties
11 required
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…
disputesResponse
object
Disputes response object.
4 properties
3 required
merchantIds
object
A list of unique processing entities or transaction division identifiers.
1 property
authorizationData
object
Contains detailed information about transaction authorization.
2 properties
authorizationReferenceNumber
string
Identifies a reference number generated at debit card transaction time.
disputesRequest
object
Specifies attributes used to query and retrieve a list of dispute cases
11 properties
1 required
disputeReasonDescription
string
Textual reason description of the disputed case.
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…
disputeId
integer
A unique identifier assigned by the acquirer to track each inquiry or case created for a transaction dispute on an account.
transactionAmount
number
Specifies the monetary value of the transaction performed.
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…
transactionData
object
Contains basic data of an original sale or refund transaction.
6 properties
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.
entityIds
object
Entity identifiers for a Merchant Organization, determined by the hierarchical structure within the system.
title
string
Short human readable title of the error
transactionCurrency
string
Codifies the monetary unit that was associated with the financial transaction (such as sale, refund)
disputeDocumentsResponse
object
Dispute document response
4 properties
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…
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…
requestId
string
Unique request identifier provided by the requestor.
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…
companyIds
object
A list of unique company identifiers. Reserved for future use. Currently not active.
1 property
disputeCategoryCode
string
The category of the dispute based on the reason code.
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…
submitterPlatformId
string
Identifies the platform used to facilitate the request of the transaction that is being disputed.
disputesStatusResponse
object
Dispute Response
4 properties
location
string
Location of the field for which the error occurred in the request
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…
transactionDataDetailed
object
Contains detailed information about sale or refund transaction.
2 properties
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…
statusInquiryParameters
object
Status enquiry parameters
merchantData
object
Contains basic data of a merchant.
4 properties
disputeValue
object
Contains dispute amount and currency.
2 properties
authorizationCurrency
string
Codifies the monetary unit that was associated with the financial transaction (such as sale, refund)
httpStatus
integer
The response code that is returned to the client based on how a backend service handled the request
contextMessage
object
Object containing information in the file
4 properties
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
relatedItemsData
object
Contains information about other related disputes items.
5 properties
paymentMethodList
array
A list of payment method codes to filter disputes by card brand or payment type.
disputesStatusData
object
Dispute current status related information.
7 properties
field
string
The field for which the error has occured.
caseTimelineEvent
object
Depicts a specific event within the chronological timeline of all events in a particular dispute case.
3 properties
disputeInitiatedDate
string
Designates the date the dispute case record was substantiated or established.
transactionId
string
The transaction identifier of the original transaction.
paymentMethod
object
Contains payment method code and description.
3 properties
messages
object
A list of errors and warnings
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
