How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Product Configuration API

Product configuration APIs that can be used to create, configure and maintain Commerce platform accounts.

Product Configuration 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 Health, Merchant, and Merchant Onboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 4 paths, organized into 3 resource areas, and defines 36 schemas. It is described by OpenAPI 3.1.0, at version 1.0.3.

Requests are made against 3 base URLs: https://api.payments.jpmorgan.com/commerce/configuration/v1, https://api-cat.payments.jpmorgan.com/commerce/configuration/v1, https://api-mock.payments.jpmorgan.com/commerce/configuration/v1.

5 operations 4 paths 36 schemas 3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.3
Base URL
https://api.payments.jpmorgan.com/commerce/configuration/v1
Authentication
HTTP Bearer
Resource Areas
3

Authentication & Security 1

Product Configuration API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 1 PATCH, 1 POST. They span 3 resource areas: Health, Merchant Onboarding, Merchant. Each is listed below with its method, path, parameters, and response codes.

Health 1
GET
/health
Health check
getHealth → 200403503
Merchant Onboarding 3
POST
/merchant-boarding-requests
Create a merchant onboarding request
createMerchantOnboardingReq body → 201400401403503
PATCH
/merchant-boarding-requests/{onboardRequestId}
Update a merchant onboarding request
updateMerchantOnboardingReq 1 param body → 200400401403404503
GET
/merchant-boarding-requests/{onboardRequestId}
Retrieve merchant onboarding request details
getMerchantOnboardingReq 1 param → 200400401403404503
Merchant 1

Merchant entity information

GET
/merchant-accounts/{merchantAccountId}
Retrieve merchant details
getMerchantAccount 1 param → 200400401403404503

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are merchantResponse (17 properties), merchantOnboardingResponse (16 properties), merchantOnboardingPatchRequest (14 properties), merchantOnboardingRequest (14 properties). Each schema is shown below with its type and property counts.

HealthResponse
object
Model for health check response
4 properties 3 required
HealthStatus
string
Health status enumeration
LocationType
string
Location where the error occurred in the request
Error
object
Common Error Model matching the api-template schema
5 properties 1 required
ErrorContext
object
Error Context model
4 properties 1 required
merchantOnboardingResponse
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
16 properties
merchantOnboardingRequest
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
14 properties 3 required
accountName
string
The alias name given to a Merchant Account, labeled as D.B.A., that is different from the legal name.
email
string
A mail system that allows a party to send and receive messages electronically. An email address is composed of a local part and a domain part. The local part i…
website
string
Provides textual information about data for the protocol for specifying addresses on the Internet (Universal Resource Locator - URL) for the merchant's organiz…
enterprisePlatformIdentifier
string
A unique identifier representing the profile (configuration) for an external client or internal service of the Firm that facilitates how it interacts with the…
clientId
string
A unique internal identifier created by the Firm's small medium business (SMB) unit for referencing a merchant.
accountAlias
string
The alias chosen by the customer to identify the account.
onboardRequestStatus
string
Indicates the onboarding status of the Enterprise Platform or Merchant Account for payment processing. | Status | Description | |:-------------------------|:--…
businessProfile
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
3 properties
projectedSalesInfo
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
4 properties
payoutAccount
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
6 properties
merchantMetadataList
array
This is used for specifying an attribute used on a model for collection object that will contain one or more attributes
contactInfoPatch
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
contactInfo
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
merchantMetadata
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
merchantResponse
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
17 properties
pricingTemplate
string
The alternate label for a pre-defined format for a pricing configuration.
ProcessingTemplate
string
The alternate label for a pre-defined format for a processing entity configuration.
payoutTemplate
string
The label given to the Funds Transfer Instructions (FTI) provided on reports to the merchant.
businessDescription
string
The detailed description of an item or service offered for sale by the Merchant.
locationAddress
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
7 properties
deviceLanguageCode
string
Indicates the method of communication, either spoken or written, consisting of the use of words in a structured and conventional way. The master set of values…
merchantManualKeyedTransactionsPercentage
integer
Percentage of transactions which will be keyed into the terminal with the card not present (i.e. Mail or Phone Order). User can manually type in the credit car…
phoneNumber
string
A locator whose value identifies the formatted numeric address for routing voice or data communications via telephony, to reach a party. NOTE: Telephone number…
countryCode
string
The telephone dialing prefix for a member country in the International Telecommunication Union (ITU) that is defined by the ITU-T E.164 standard. The code is a…
merchantOnboardingPatchRequest
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
14 properties
digitalSales
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
terminalSales
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
3 properties
phone
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
locationAddressPatch
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jp-morgan-chase-product-configuration-api-openapi.yml Raw ↑

Other APIs JPMorgan Chase publishes across the network.

Digital Onboarding API
Consumer Profile Management API
Tokenization API
Reporting API
Notifications API
Request to Pay via QR Code API
Checkout API
Dispute Management API
Accounts API
Alerts and Decisioning API
Recipients API
Webhooks API
Where this information came from

This is an independent, third-party profile of Product Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.