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

JPMorgan Chase Payment Links API

Operations related to catalog services

JPMorgan Chase Payment Links 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 Payment Links. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 1.9.2.

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

4 operations 2 paths 35 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.9.2
Base URL
https://api.payments.jpmorgan.com/onboarding/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Links 4

Operations related to catalog services

POST
/payment-links
Create a sharable payment link
2 params body → 200400401404408500
GET
/payment-links
Returns the list of already created links
6 params → 200400401403408500503
PATCH
/payment-links/{linkId}
Updates a payment link
4 params body → 200400401403404408500
GET
/payment-links/{linkId}
Retrieves a payment link
3 params → 200400401403408500503

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are paymentLink (13 properties), cardholderAccountHistory (12 properties), softMerchant (11 properties), paymentCardAuthenticationRequest (7 properties). Each schema is shown below with its type and property counts.

recurringPaymentDetails
object
Information required for recurring payments.
1 property
paymentMethodOptions
object
Defines payment method options.
2 properties
installmentPaymentDetails
object
Information required for installment payments.
1 property
validationMessage
object
Information about errors occurred in transaction validation
3 properties
subMerchantSupplementalData
object
Additionsl data provided by merchant for reference purposes.
1 property
capture
object
Capture Option
1 property
klarnaOptions
object
Codifies consumer choices and industry data provided by merchant to complete the payment with Klarna payment provider.
1 property
paymentCardAuthenticationRequest
object
paymentCardAuthenticationRequest models SCA request data which will be sent to 3DS provider if the Shopper is using a payment card as a payment method. This me…
7 properties
purchaseInfo
object
Purchase information.
4 properties
requestorPriorTransactionAuthenticationInfo
object
Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
4 properties
requestorAuthenticationInfo
object
Information about how the 3DS Requestor authenticated the Cardholder before or during the transaction.
4 properties
messages
object
A list of errors and warnings
4 properties
address
object
Specifies an address.
7 properties
cardOnFile
object
Card On File Option
3 properties
linkItemProduct
object
Product information used on linked item
4 properties 1 required
paymentLink
object
Payment Link
13 properties 3 required
cardholderAccountHistory
object
Additional information about the Cardholder’s Account provided by the 3DS Requestor.
12 properties
merchantFraudRiskAssessment
object
Merchant's assessment of the level of fraud risk for the specific authentication for both the Cardholder and the authentication being conducted.
7 properties
merchantIdentification
object
Sub Merchannt Identification Information
3 properties
responseCode
string
Short explanation of response Code
authorization
object
Auth Options
5 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…
expirationTimestamp
string
Designates the hour, minute, and second in a specific day after which a payment link will expire. The status will be changed to EXPIRED afterwards.
responseStatus
string
The label given to the state of a response to a request submitted by a consumer through the Firm's Application Program Interface (API) that matches a test case…
linkConsumer
object
Profile information of the consumer whom the payment link transaction will be billed to
3 properties
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…
createdTimestamp
string
Designates the hour, minute and second in a specific day when the record was created.
responseMessage
string
Long explanation of response Message
listLinkResponse
object
Payment Link Responses
2 properties
softMerchant
object
Soft merchant information is passed to the card association along with the transaction. This soft merchant information may also be used for cases where smaller…
11 properties
paymentMethodType
string
Codifies the method of payment accepted for the checkout session.
linkItem
object
Link Item
3 properties 1 required
linkCheckoutOptions
object
Checkout option information needed during payment link creation.
4 properties
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…
updatePaymentLinkRequest
object
Defines a request for updating a payment link.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jp-morgan-chase-payment-links-api-openapi.yml Raw ↑

Other APIs JPMorgan Chase publishes across the network.

Notifications API
Accounts API
Recipients API
Webhooks API
Transactions API
Documents API
JPMorgan Chase Account Information API
JPMorgan Chase Account Restrictions API
JPMorgan Chase Account Services API
JPMorgan Chase Account Statements API
JPMorgan Chase Account Transactions API
JPMorgan Chase Account Updates API
Where this information came from

This is an independent, third-party profile of JPMorgan Chase Payment Links 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.