JPMorgan Chase Reports 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 Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
3 operations
across 2 paths,
and defines 54 schemas.
It is described by OpenAPI 3.2.0, at version 1.4.0.
Requests are made against 4 base URLs: https://api.reports.jpmorgan.com/api/v1, https://api.reports-files.jpmorgan.com/api/v1, https://api.reports.test.jpmorgan.com/api/v1, https://api-mock.payments.jpmorgan.com/api/v1.
The identity and technical contract details declared by the specification.
reportStatus
string
The label for a valid state applicable to a gamification item. This includes both gamification item set-up and operational status plus Customer status.
reportDetails
object
reportDetails
2 properties
2 required
reportAttributeName
string
The name of the attribute in the report.
reportFileName
string
The merchant defined name for report file. By default= "Entity ID". "Report Type" . "frequency". "From Date YYYY-MM-DD". "To Date YYYY-MM-DD"
sectionRowCountDisplayIndicator
boolean
Indicates the BOOLEAN value to display row count for each report section. This field is only applicable when the report is generated in PDF format.
responseStatus
string
Request result status.
scheduleFrequency
string
The planned intervals at which events, activities or processes occur. Allowed values for ADHOC reports: adhoc. Allowed values for SCHEDULED reports: daily, wee…
reportPostResponse
object
Report Configuration Response
4 properties
4 required
intervalParams
object
Interval Parameter
reportSection
object
The label given as a header for the section.
6 properties
1 required
lastPage
boolean
Indicates the BOOLEAN value to signify whether or not the response is the final page of results.
updateTimestamp
string
Indicates the specific time of the day ( in hour, minute and second) when the configuration was most recently updated.
intervalParamsAdhoc
object
Interval Parameter
3 properties
3 required
scheduleFrequencyScheduled
string
Recurring scheduled report generation frequency.
errorMessage
string
Describes a message if problem occurred or error preventing the system from completing a task.
entityIds
array
Indicates the array of applicable processing entities for which the reporting data is required.
reportConfigRequestByConfigId
object
report configuration request
2 properties
2 required
reportHeader
string
The header of the report file. By default= entityId= "Entity ID", ReportTypeName= "Report Type" , Frequency="frequency", FromDate="From Date YYYY-MM-DD" , ToDa…
intervalParamsScheduled
object
Interval Parameter
2 properties
2 required
code
string
Short informative code about the error.
validationMessage
object
Object containing information about transaction validation
3 properties
2 required
frequencyConfig
object
Frequency configuration.
reportDescription
string
The textual description of the report.
frequencyConfigScheduled
object
Scheduled frequency configuration (Daily/Weekly|Mon/Monthly|12/MTD/Monthly Fiscal).
4 properties
2 required
fileDelimiter
string
Indicates the demarcation operator to separate and distinguish individual data fields wthin a report, facilitating structred organization and retrieval of info…
reportTypeNames
array
The names of the report types.
responseMessage
string
Long explanation of the response message.
frequencyConfigAdhoc
object
Adhoc frequency configuration.
3 properties
3 required
fileHeader
string
The textual information in the first row of a file. By default= EntityId= "Entity ID",Frequency="frequency"
reportList
object
List of all report runs
3 properties
reportConfigRequestByEntity
object
report configuration request
18 properties
3 required
filterAttribute
object
Report Detail
2 properties
2 required
responseCode
string
Short explanation of the response code.
selectedFields
object
Section Selected Fields
7 properties
adfsError
object
Object containing information in the file
3 properties
3 required
entityType
string
Codifies the level of the merchant relationship as it relates to the acquiring account.
reportConfigStatus
string
The status of the report configuration.
report
object
Report Configuration
9 properties
7 required
csvColumnNameDisplayIndicator
boolean
Indicates the BOOLEAN value to display column name in the report.
reportConfigRequest
object
report configuration request
scheduleFrequencyAdhoc
string
Ad-hoc report generation frequency for one-time reports. Allowed values for ADHOC reports: adhoc.
next
string
Indicates the reference for the next page for paginated response. Use the value of next to fetch the next batch of report configs. If the lastPage = TRUE; then…
reportSections
array
The label given as a header for the section.
sortOrder
object
Sort Order
2 properties
2 required
reportConfigurationName
string
The merchant defined name of the report configuration.
fileTrailer
string
The textual information in the last row of a file. By default= EntityId= "Entity ID ",Frequency="frequency"
reportIdentifier
string
Identifies a unique occurrence of reporting events.
reportConfigurationId
string
A system generated unique identifier for report configuration.
reportFormat
string
Codifies the document file format as text or binary file format for storing documents on a storage media, especially for use by computers.
reportFormatList
array
Format of the report. Default value is CSV
messages
object
A list of errors and warnings.
4 properties
2 required
transactionProcessingEntityIdentifier
string
Identifies a unique entity for transaction processing at the lowest level of the account hierarchy of the backend proprietary merchant acquiring processing pla…
totalRowCountDisplayIndicator
boolean
Indicates the BOOLEAN value to display total number of row count in the report for all sections. This field is only applicable when the report is generated in…
createTimestamp
string
Designates the hour, minute and second in a specific day when the record was created.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
