The identity and technical contract details declared by the specification.
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.