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 Subscriptions API

Manage notification subscriptions

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

This API exposes 7 operations across 4 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 1.13.1.

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

7 operations 4 paths 67 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 7

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

Subscriptions 7

Manage notification subscriptions

GET
/subscriptions
Get all subscriptions by entity Id
v1ListSubscriptions 10 params → 200400401403404500503504
POST
/subscriptions
Subscribe to a notification
v1CreateSubscription 6 params body → 201400401403500503504
GET
/subscriptions/{subscription-id}
Get a subscription by subscription Id
v1GetSubscriptionBySubscriptionId 7 params → 200400401403404500503504
PUT
/subscriptions/{subscription-id}
Update a specific subscription
v1UpdateSubscriptionBySubscriptionId 7 params body → 200400401403404500503504
DELETE
/subscriptions/{subscription-id}
Delete a specific subscription
v1DeleteSubscriptionBySubscriptionId 7 params → 200400401403404500503504
GET
/publicKeysdeprecated
(DEPRECATED) Get a public key by entity Id
v1PublicKeyGet 7 params → 200400401403404500503504
GET
/subscriptions/verifications/{id}
Get pending subscription verification by request id
5 params → 200400401403404500503504

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are notifications (37 properties), subscription (16 properties), subscriptionsResponse (14 properties), subscriptionResponse (13 properties). Each schema is shown below with its type and property counts.

subscriptionStatus
string
Codifies the state of the message category that merchant has registered for. Sample values are: Active, Inactive, pending authorization.
subscriptionChannels
array
(DEPRECATED) List of medium through which event notifications will be delivered to recipient. Use subscriptionChannel (singular) instead.
recommendationNotificationType
string
Codifies the subscription type to merchant for recommendations from firm.
enrollmentNotificationType
string
Codifies the subscription type to Enrollment notifications. Possible values are EnrollmentSuccess, EnrollmentPaymentMethodAdded, enrollmentNoPaymentMethodAdded…
authenticationNotificationType
string
Codifies the categories of messages the firm uses to communicate with the merchant. Sample values are: chargeback, alerts, funding. In this context, this is fo…
validationMessage
object
Object containing information about transaction validation
3 properties 2 required
clientCredentials
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
4 properties
subscriptionResponse
object
Response Object for Merchant Notification Subscription
13 properties
processingThresholdNotificationType
string
Defines the threshold notification sub types. Possible values are "ProcessingThresholdStatus", "ALL"]
adfsError
object
Object containing information about the active directory file system error.
3 properties 3 required
entityOnboardingEventNotificationType
string
Codifies the onboarding status of merchant and entities by our firm
accountInformationServiceNotificationType
string
Codifies the subscription type to Account Information Service notifications. Possible values are ConsentLinkInitiated, ConsentLinkOpened, ConsentLinkSuccessful…
recurringProgramNotificationType
string
Codifies the categories of messages the firm uses to communicate with the merchant. Sample vaues are: chargeback, alerts, funding.
payoutNotificationType
string
Codifies the subscription type to Payout notifications. Possible values include PayoutFailure, PayoutUnderReview, PayoutCreated, PayoutDenied, PayoutCompleted,…
productOnboardingNotificationType
string
Codifies the subscription type to product onboarding notifications
publicKey
object
(DEPRECATED) Public Key information
3 properties
tokenLifecycleNotificationType
string
Codifies the subscription type to Token lifecycle notifications
merchantStatusNotificationType
string
Codifies the subscription type to product onboarding notifications
orderUpdateNotificationType
string
(DEPRECATED) Subscribe to notifications for order update
entityOnboardingNotificationType
string
Codifies the onboarding status of merchant and entities by our firm
messages
object
A list of errors and warnings.
4 properties 2 required
documentNotificationType
string
Codifies the categories of messages between merchant and Firm for the document update.
refundUpdateNotificationType
string
Codifies the refund notification subscription type to merchant for recommendations from firm.
canadianKycNotificationType
string
Notifications for Canadian KYC mandates.
recipientDetails
object
Individual details information
6 properties
transactionUpdateNotificationType
string
Codifies the categories of messages between merchant and Firm for the transaction Update.
eCommerceServiceUpdateNotificationType
string
Codifies the subscription type to eCommerce Service Update notifications. Possible values are WixOnboardingComplete, All
notifications
object
Array of Notification Types.
37 properties
subscriptionGetResponse
object
subscriptionGetResponse
10 properties
subscriptionCreateTimestamp
string
Designates the hour, minute and second in a specific day when the notification subscription was created.
subscriptionResponseList
object
Response Object for Notification Get Subscription Response
2 properties
achStatusNotificationType
string
Codifies the subscription type to Ach status notifications. Possible values include AchReturnReceived, All.
securityPreferences
object
Parent Object which holds information on security preferences for sending Webhook Notifications.
9 properties
allocationOrderInstructionNotificationTypeCode
string
Defines the allocation order instruction notification sub types. Possible values are "AllocationOrderInstructionUpdate", "AllocationOrderInstructionRequest" "A…
commerceCenterUserAccessNotificationType
string
Codifies the categories of messages the firm uses to communicate with the merchant regarding Commerce Center user access registration.
subscriptionsResponse
object
Response Object for Merchant Notification Subscription
14 properties
pageInfo
object
Page Information
3 properties
securityAlertNotificationType
string
Codifies the subscription type to Login Locked notifications. Possible values are LoginLocked, PasswordReset, LoginFailed, All
subscriptionUpdatedTimestamp
string
Designates the hour, minute and second in a specific day when the notification subscription has been modified.
subscribingForEntity
string
Determines whether the subscription is for an entity within CPM (PAYER), or the subscription is for a prospective entity (BUYER).
responseCode
string
Codifies the Firm's representation of the response code being sent back to the merchant.
callbackURL
string
URL/Endpoint to receive Webhook notifications by merchant.
passcodeUpdateNotificationType
string
Codifies the subscription type to Passcode Update notifications. Possible values are PasscodeUpdateSuccess, PasscodeEnabledByUser, PasscodeEnabledBySystem, All
oAuthDetails
object
(DEPRECATED) Information on potential oAuth details to apply when sending Webhook Notification to Merchant.
3 properties
subscription
object
Request Object for Merchant Notification Subscription
16 properties 2 required
subscriptionCategory
string
Delineates a set of rules for the management of a subscription.
consumerProfileNotificationType
string
Codifies the subscription type to consumer profile notifications
responseStatus
string
Codifies the general categorization by the Firm of the response code being sent back to the merchant.
subscriptionId
string
Identifies unique occurrence of notification subscription message by the merchant for new subscription or modification of an existing subscription.
reportStatusNotificationType
string
Codifies the categories of messages the firm uses to communicate with the merchant regarding merchant reports run by firm.
paymentUpdateNotificationType
string
Subscribe to notifications for payment update
responseMessage
string
Long explanation of the response code.
authorizationDetails
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
5 properties
disputeNotificationType
string
Subscribe to notifications for dispute
allocationOrderNotificationType
string
Defines the allocation order notification sub types. Possible values are "AllocationOrderUpdateNotification", "All"
subscriptionChannel
string
Codifies the method in which the Firm communicates with the Party.
jwtDetails
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
4 properties
qrCodeStatusNotificationType
string
Codifies the subscription type to QR Status notifications. Possible values are QRCodeCreated, QRCodeExpired, QRCodePaid, QRCodeSettlementProcessing, QRCodeCanc…
secretKey
string
(DEPRECATED) This is the endpoint's confidential text used for generating signatures. This is only returned at creation.
consumerAccountUpdateType
string
Codifies the categories of messages the firm uses to communicate with the biometric merchant regarding consumer account update.
accountUpdateNotificationType
string
Codifies the categories of messages the firm uses to communicate with the merchant regarding consumer account update.
taxNotificationType
string
Codifies the subscription type to Tax notifications. Possible values are BackupWithholdingPending, BackupWithholdingPendingTwo, BackupWithholdingPrevented, Bac…
orbitalOperationsNotificationType
string
Get notifications about migrated Orbital merchant activity.
balanceMonitoringNotificationType
string
Codifies the categories of messages the firm uses to communicate with the merchant regarding consumer account balance monitoring.
directDebitAccountNotificationTypeCode
string
Information regarding Direct Debit Account updates. Sample values are "DirectDebitAccountUpdateSuccess", "DirectDebitAccountUpdateFailure", "DirectDebitAccount…
allocationOrderSettlementNotificationTypeCode
string
Defines the allocation order settlement notification sub types. Possible values are "PspSettlementTransferUpdate", "DistributionTransferUpdate", "PlatformSettl…
systemNotificationType
string
Codifies the subscription type to system notifications

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jp-morgan-chase-subscriptions-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 Subscriptions 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.