Notifications API
Notification API enables merchants to subscribe to and receive notifications in real-time.
Notifications 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 Health Check, Notification, and Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 4 operations across 4 paths, and defines 443 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 6 base URLs: https://api.payments.jpmorgan.com/trust-safety/v1, https://api-cat.payments.jpmorgan.com/trust-safety/v1, https://api-mock.payments.jpmorgan.com/trust-safety/v1, https://mns-aws.jpmchase.com/v1, https://mns-aws-cat.jpmchase.com/v1, https://api-mock.payments.jpmorgan.com/v1.
4 operations
4 paths
443 schemas
4 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Notifications API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.
Notifications 4
GET
/notifications/{notification-id}
Get a notification by notification Id
GET
/notificationTypes
Get all notification event types available
GET
/notifications
Get all notifications within a date range by notification status
GET
/public-keys
Get a notification public key
Schemas 443
The contract defines 443 schemas that model the data the API accepts and returns. The most detailed are notificationResponse (47 properties), transactionCompleted (40 properties), transactionFailed (37 properties), programUpdated (23 properties). Each schema is shown below with its type and property counts.
IndividualId
object
Can be used if organization ID is not populated, when the underlying payer is an Individual. It should be used together with Ultimate Debtor Name and address,…
3 properties
1 required
InitiatingParty
object
The financial institution or agent that initiates the payment or transaction on behalf of the ordering party.
Payment
object
Representation of the payment instruction.
10 properties
8 required
PaymentHoldNotificationData
object
Common properties shared by all payment hold notification event payloads. This is the supertype for PaymentHeldData and PaymentHoldAmendedData.
3 properties
2 required
DecisionSubstatus
string
Substatus providing additional detail on the current state of the payment hold. | Enum Value | Description | |------------|-------------| | PENDINGACTIONCLIENT…
UnstructuredAddress
array
Unstructured Addresses
IndividualIdentification
object
Individual Identification Schemes
1 property
1 required
CreditorAgent
object
The Bank or financial institution of the creditor (the party receiving the payment).
4 properties
1 required
AmountDecimal
string
A String representation of a (potentially) whole number or decimal positive number. - Amount should be more than 0.01 with maximum of two decimal places allowe…
UltimateCreditor
object
Represents the ultimate beneficiary of the funds in the payment transaction. This is the final recipient who will receive the funds, even if the payment is cre…
DecisionStatus
string
Status of the payment hold | Enum Value | Description | |------------|-------------| | PENDING | Payment hold is pending review and decision | | APPROVED | Pay…
IntermediaryAgent
object
An agent between the debtor's agent and the creditor's agent. Usage: If more than one intermediary agent is present, then IntermediaryAgent1 identifies the age…
3 properties
UltimateDebtor
object
Represents the ultimate party responsible for the payment, who is the original source of funds in the transaction, even if the payment is made on their behalf…
NotificationBase
object
Common CloudEvents envelope properties shared by all payment hold notification events. See [CloudEvents Specification v1.0](https://github.com/cloudevents/spec…
5 properties
5 required
AdditionalInstitutions
array
Additional Institutions
IsoCountrySubdivisionCode
string
ISO 3166-2 Alphanumeric Country Subdivision Code
BasicParty
object
A party is an entity involved in a financial transaction. This entity can be an individual, a corporation, or any other organization that participates in the t…
4 properties
Debtor
object
The party that owes money and is responsible for repaying the debt.
AdditionalInstitution
object
Additional Institution
4 properties
2 required
Address
object
Information that locates and identifies a specific address
8 properties
PostalCode
string
Postal code
TransferType
string
Indicates the direction of the money movement. The transaction is either a credit push transfer or a direct debit pull transfer. | Market/Instrument | Transfer…
IsoCurrencyCode
string
ISO 4217 Alpha-3 Currency Code
EndToEndId
string
Customer assigned Unique identifier to unambiguously identify the Payment transaction. This identification is passed on, unchanged, throughout the entire end-t…
AccountId
string
Account number.
OrganizationId
object
Collection of registration information held against the party. It can be used when the underlying payer is a Legal Entity. It should be used together with Ulti…
5 properties
1 required
StreetName
string
Street name
PaymentIdentifiers
object
Identifiers associated with the Payment Instruction throughout its lifecycle.
2 properties
1 required
Source
string
Indicates the source of the decision on the payment hold. | Enum Value | Description | |------------|-------------| | API | Decision made via the API | | JPMCU…
PaymentType
string
The type of payment being initiated - WIRE for Wire Payments, ACH for ACH Payments, RTP for Real-Time Payments
OrganizationIdentification
object
Organization Identification Schemes
1 property
1 required
Creditor
object
The creditor (payee) of the payment instruction.
Party
Uuid
string
Unique payment hold identifier generated by JPMC
FinancialInstitutionIdType
string
FraudType
string
Type of fraud | Enum Value | Description | |------------|-------------| | BUSINESSEMAILCOMPROMISE | Fraudulent email schemes targeting business transactions |…
Account
object
Representation of a bank account. Features of the model may vary between different account types.
3 properties
1 required
Fraud
object
Fraud details associated with a rejected payment hold. Only present when rejectReason is FRAUD.
2 properties
Rule
object
Client defined rule
4 properties
Distribution
object
Describes distribution details for ACH payment hold. JPM might distribute the payment after a hold is created,but before the hold is decisioned. You should sti…
2 properties
PreviousInstructingAgent
object
The Previous Instructing Agent represents the financial institution or agent that previously transmitted the payment instruction within the payment chain, befo…
3 properties
Notification
Payment hold notification event (CloudEvents v1.0). The type field indicates whether the payload represents a newly held payment, an update to an existing hold…
AddressType
string
Type of address
Decision
object
Details of how the hold was resolved. Present only for holds that have already been decisioned.
3 properties
PaymentHoldClosedData
Data payload for com.jpmorgan.payments.payment.hold.closed.v1 events. Contains the hold details when the hold is decisioned by the bank or when the decision is…
AdditionalParties
object
Additional parties involved in the payment transaction.
6 properties
DebtorAgent
object
An agent is a financial institution that acts on behalf of the debtor in a financial transaction. The agent facilitates the transaction by processing payments,…
4 properties
1 required
DecisionRejectReason
string
Reason for REJECT action. Only populated for action=REJECT and when status=REJECTED. If the reason is "Fraud", additional fraud details should be provided in t…
PaymentHoldAmendedData
Data payload for com.jpmorgan.payments.payment.hold.ammended.v1 events. A payment hold has been updated (decisioned, distributed, reassigned). The payload incl…
PartyId
Party Identification
AccountType
string
Account Type
FinancialInstitutionId
object
Financial Institution Identifier
3 properties
2 required
PaymentHeldData
Data payload for com.jpmorgan.payments.payment.hold.placed.v1 events. A payment has been held for review. The payload contains the complete hold including the…
IsoCountryCode
string
ISO 3166-1 Alpha-2 Country Code
PaymentValue
object
A positive amount of value.
2 properties
2 required
subscriptionChannels
array
(DEPRECATED) List of medium through which event notifications will be delivered to recipient. Use subscriptionChannel (singular) instead.
accountUpdated
object
Account Updated
12 properties
payoutFailureResolved
object
Information about previously faced payout issue is resolved and released for deposit .
4 properties
caseCreateTimestamp
string
Designates the date, hour, minute and second the dispute case record was substantiated or established.
orderErrored
object
Information on order that was errored.
5 properties
refundClosed
object
Information regarding the refund closed notification
4 properties
phone
object
Phone Information
3 properties
responseDueDate
string
Designates the date, hour, minute, and second when a task must be completed.
methodOfPayment
string
Codifies the method used to pay for the exchange of money, goods or services between a merchant and their customer. Examples: Visa, MasterCard, PayPal, Bill Me…
account
object
Account
3 properties
balanceLimits
object
Balance Limits
2 properties
bulkTokenUpdate
object
Information on status of the bulk tokenization files.
7 properties
scoreDetail
object
Score Details for a day
4 properties
disputeStatus
string
Label given to the current standing of the Dispute. Sample values would be New, Needs Response, Challenged - JPMC, Accept, Expired, Challenged - Merchant, Chal…
merchantAddress
object
The provided address for a given Merchant
3 properties
disputeInitiatedDate
string
Designates the date, hour, minute and second the dispute case record was substantiated or established.
first6CardNumber
string
Identifies the first six digits of the primary account number of a credit, debit or pre-paid card. As of 2017, this does not necessarily align to the Issuer Id…
supportedNotification
object
Supported Notification details
3 properties
merchantOnboardingInProgress
object
Information when merchant onboarding process is updated
7 properties
validationMessage
object
Object containing information about transaction validation
3 properties
2 required
payoutPostedTimestamp
string
Designates the year, month, and day when a payout is posted for processing. The payout process covers multiple transactions within a payout.
PartyIdentity
object
Representation of a party with its role, identity, and verification status.
4 properties
clientId
string
Unique identifier created by the Firm as a small medium business for the merchant and platform.
sourceResponseMessage
string
Long explanation of response Message from source system
monthlyErrored
object
Information when Monthly Report Generation has failed with error
1 property
consumerProfileCreated
object
Information for new consumer profile created in the system.
4 properties
Value
object
Value
2 properties
2 required
transactionCompleted
object
Transaction Completed
40 properties
publicKeys
object
Response Object for Public Keys information
1 property
passwordReset
object
Denotes a Password Reset request notification sent to the consumer upon request
2 properties
restrictionAdded
object
Restriction Added
10 properties
ConsentLinkRequest
object
Representation of a User's consent detail for accessing financial data
8 properties
3 required
documentFailed
object
Document failure details
5 properties
entityOnboardingNotification
object
Information regarding the onboarding status of merchant and entities by our Firm.
8 properties
mopActivationDeclined
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
4 properties
ConsentLinkInitiated
object
Consent Link event published as part of account linking flow for consent link URL is generated
2 properties
2 required
ConsentStatus
string
Type of consent status | Consent Status | Description | |:---------------------|:--------------------------------------------------------------------------| |…
financialAdjustmentInitiated
object
Details about the financial adjustment impacting merchant payouts
8 properties
disputeReasonCode
string
Codifies the chargeback reason for the disputed case.
directDebitReturn
object
If the first direct debit attempt returns an error code other than R03, or if the second direct debit attempt fails for any reason, send a webhook to the Platf…
4 properties
onboardingStatus
object
Product Onboarding Status information
4 properties
paymentUpdateNotification
object
The Payment updates information
20 properties
qrCodeCreated
object
Information regarding the created state of QR Code
6 properties
accountClosedSuccess
object
Notification sent when account is closed Successfully
1 property
entityOnboardingV2
object
Information sent in the notification when the status of an entity changes during the onboarding process.
4 properties
merchantOnboardingCompleted
object
Information when merchant onboarding process is updated
7 properties
fxInformation
object
This is used for specifying Foreign Exchange related information for a transaction
4 properties
passcodeUpdate
object
passcodeUpdate
3 properties
entityOnboardingEventNotification
object
Information regarding the onboarding status of merchant and entities by our Firm.
1 property
consumerProfileId
string
Identifies a unique occurrence of a consumer's information maintained by the Firm on behalf of the merchant. The consumer profile contains information relevant…
identificationStatus
string
Codifies the current state of the workflow for customer identification process during onboarding.
accountUpdaterStatus
object
Account Updater Status
9 properties
notificationResponseTimestamp
string
Designates the date, hour, minute and second the response was provided against a request. In this context, this is the notification response timestamp for paym…
hasOutstandingInformation
boolean
Indicates whether there are outstanding items for the client to complete certain task and steps.
paymentAmount
object
The value representation of a monetary amount. The amount value should be more than 0.01 with maximum of two decimal places allowed
2 properties
ConsentLinkFailed
object
Consent Link event published as part of account linking flow for failure
ConsentDetail
object
Representation of a User's consent detail with account information.
firmDisputeCaseID
string
Identifies a unique post deposit event that occured after the merchant has been funded for the original transaction.
distributionTransferUpdate
object
Distribution Transfer Update notification sub-type.
13 properties
restrictions
object
Restrictions
4 properties
discountAmount
object
Discount Amount paid.
2 properties
paymentType
string
Codifies the method used to pay for the exchange of money, goods or services between a merchant and their customer. Examples: Visa, MasterCard, PayPal, Bill Me…
paymentClosed
object
Information on transaction that was successfully closed at the payment gateway.
11 properties
entityOnboardingInformationRequested
object
Information sent in the notification when the status of an entity changes during the onboarding process.
4 properties
orderApproved
object
Information on order that was approved.
5 properties
qrCodePaid
object
Information regarding the payment details of the QR code
6 properties
oldAccountInformation
object
Information about previous card account which will be updated with the new card.
3 properties
accountClosedByConsumerSuccess
object
Notification sent when account is closed Successfully by consumer
1 property
tokenStateChange
object
Information on potential changes in the token and its state.
10 properties
ISOCurrencyCode
string
Currency of the money movement: a 3 alpha character ISO 4217 currency code.
subscriptionVerification
object
Mandatory notifications to verify a subscription's delivery details before it becomes activated.
1 property
processingThresholdStatus
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
4 properties
IBAN
object
International bank account number (IBAN) standard numbering system.
4 properties
1 required
penaltyAmount
object
Penalty amount paid
2 properties
directDebitAccountUpdateFailure
object
Information when a merchant's attempt to update their DDA failed.
2 properties
icPlusStatementCompleted
object
Information when IC Plus monthly billing statement has completed.
3 properties
terminalDeactivation
object
Canadian KYC mandate notification to warn the merchant that if uplift is not completed, their terminal will be deactivated.
6 properties
hostMessage
string
Message received from Issuer, network or processor. Can be blank
taxNotification
object
Information on status of the Tax Notification
8 properties
weeklyCompleted
object
Information when Weekly Report Generation has Completed
1 property
EmailInfo
object
Representation of detailed email information.
3 properties
ClientId
string
Unique Identifier of the client that is generated by PBB.
accountholderInformation
object
Accountholder Information
7 properties
orderDeclined
object
Information on order that was declined.
5 properties
parameters
object
Document generation parameters
1 property
passcodeEnabledBySystem
object
Activation Level - ACTIVE | Definition - Notification sent when passcode is updated Successfully by System
1 property
maskedAccountNumber
string
Identifies a concealed number associated with the card number recognized by various payment systems. This is typically concealed by storing only the first 6 an…
merchantOnboardingDeclined
object
Information when merchant onboarding process is updated
8 properties
accountFailed
object
Account Failed
4 properties
disputeReasonDescription
string
Textual description of the chargeback reason for the disputed case.
paymentRetry
object
Retry Recommendations
12 properties
microDepositVerificationFailed
object
Microdeposits verify the legitimacy and ownership of a bank account, with an amount less than 1 dollar. A microdeposit could not be completed
1 property
AccountType_2
string
Specifies the type of account. | Account Type | Description | |----------------|------------------------| | CHECKING | A Checking account. | | SAVINGS | A Savi…
individualLastName
string
That part of an individual's name generally placed at the end of the given name. The last name is also known as the surname or family name.
recurringProgramPaymentStatus
object
Information on Program Payment Status.
21 properties
AdditionalContext
object
3 properties
3 required
PartyRole
string
The role of the party to the account.
merchantId
string
Identifies a unique entity for transaction processing at the lowest level of the account hierarchy of the backend proprietary merchant acquiring processing pla…
hostResponseCode
string
Codifies the payment processor’s representation of the authorization response code being sent back to the merchant during credit card authorization.
notificationResponse
object
Response Object for Merchant Notification.
47 properties
debtorAccount
object
Debtor Account
4 properties
enrollmentUpdate
object
enrollmentUpdate
3 properties
enrollmentNoPaymentMethodAdded
object
Activation Level - ACTIVE | Definition - Notification sent when enrollment is success but payment method is not added
2 properties
transactionFailed
object
Transaction Failed
37 properties
payoutRejectedResolved
object
Information about payout resubmitted and released for deposit.
4 properties
dailyCompleted
object
Information when Daily Report Generation has Completed
1 property
merchantReactivationCompleted
object
Information when merchant reactivation process is completed
3 properties
refundUpdateNotification
object
Information regarding the status of a refund
16 properties
organizationName
string
Labels an entity as identified in its formation documents and, where applicable, as registered with a state, local, or federal government, or other chartering,…
planName
string
The label for a payment program or contract offered by the merchant for products or services that include product pricing and billing frequency.
closureType
string
Codifies the method by which a chargeback or dispute will be resolved or dispositioned. Values are auto or manual.
alternateAccount
object
This object provides alternate account details.
2 properties
loginLocked
object
Notification sent when profile login is locked
2 properties
upliftInitiated
object
Canadian KYC mandate notification when uplift is required.
5 properties
originatingTransaction
object
This is used for specifying the details of the original transaction that is being referenced in the context of a return transaction.
2 properties
payoutFailure
object
Payout Failure information
4 properties
hostRespCode
string
(Deprecated) Codifies the response being sent back to merchant from Authorization Engine during Credit Card authorization. (e.g. 00=Approved, 01=Referral to Is…
accountLinkSuccess
object
Information on account link success.
9 properties
changeDetails
object
Change Details
2 properties
allocationOrderInstructionRequest
object
Allocation Order Instruction Request notification sub-type.
7 properties
interestAmount
object
Interest amount paid.
2 properties
loginFailed
object
Denotes failed login attempt from the Portal
1 property
requestId
string
Merchant identifier for the request. The value must be unique.
AccountBasic
object
Basic representation of a financial account.
7 properties
restrictionRemoved
object
Restriction Removed
3 properties
qrCodeSettlementProcessing
object
Information regarding the settlement details of the QR code
2 properties
partyAddress
object
This denotes the physical location details of the party involved in the transaction.
7 properties
tokenReferenceIdentifier
string
A reference to the token number that is assigned for an account.
allocationOrderNotification
object
(DEPRECATED) Allocation Order Notification type.
1 property
disputeNotification
object
The payment network sends dispute information via Disputes Management platform.
12 properties
tokenLifecycleNotification
object
The token lifecycle updates information.
5 properties
recommendationNotification
object
Information regarding recommendations from the Firm.
1 property
weeklyErrored
object
Information when Weekly Report Generation has failed with error
1 property
creditor
object
Creditor details of the transaction.
5 properties
disputeAmount
object
Object containing dispute Amount
2 properties
refundItem
object
Refund Item Details
9 properties
ConsentLinkId
string
Unique identifier to access Pay by Bank UI for Link (UUID)
planId
string
A unique identifier for a payment program or contract managed by the Firm on behalf of the merchant for products or services that include product pricing and b…
recipientAccountValidation
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
7 properties
sourceResponseCode
string
Short explanation of response Code from the source system.
dailyErrored
object
Information when Daily Report Generation has failed with error
1 property
consumerProfile
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
FinancialInstitution
object
Represents a financial institution with its name and logo.
2 properties
1 required
ISOCountryCode
string
ISO 3166-1 Alpha-2 Country Code
caseCompleteDate
string
Designates the hour, minute and second of the day the case is stipulated to be resolved by the firm.
paymentAccount
object
Payment Account Information
13 properties
mopActivationCompleted
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
4 properties
wixOnboardingComplete
object
Wix Onboarding Complete notification information.
2 properties
reductionAmount
object
Reduction Amount paid.
2 properties
consumerAccountUpdate
object
The biometric consumer Account Update information.
7 properties
disputeRuling
string
The label given to the verdict or decision or a dispute. Indicates if the case has been won or lost by the merchant.
address
object
Accountholder Address Information
8 properties
merchantAccountClosed
object
Information regarding merchant status when account is closed due to termination
3 properties
recurringProgramNotification
object
The Recurring program updates information.
5 properties
recipientUpdated
object
Recipient Updated
6 properties
transactionUpdateNotification
object
Transaction Update Notification
3 properties
enrollmentPaymentMethodAdded
object
Activation Level - ACTIVE | Definition - Notification sent when enrollment is success and payment method is added
2 properties
entityOnboardingNew
object
Information sent in the notification when the status of an entity changes during the onboarding process.
4 properties
entityOnboarding
object
Information sent in the notification when the status of an entity changes during the onboarding process.
5 properties
error
object
Error
4 properties
recurringProgramId
string
A Firm generated identifier that connects a merchant's consumer to products/services offered by the merchant. The program (subscription) allows a consumer to r…
partyName
object
Object containing individual's first and last name.
2 properties
directDebitRetry
object
If the direct debit attempt is returned with error code R03 (insufficient funds in the linked account), a second webhook will be sent to the Platform indicatin…
4 properties
closed
object
(DEPRECATED) Information on dispute case that was closed on the network side.
8 properties
entityOnboardingApproved
object
Information sent in the notification when the status of an entity changes during the onboarding process.
4 properties
authenticationUpdateNotification
object
The Cardholder Authentication updates information.
1 property
identity
object
This is used for specifying the various identities associated with the party involved in the transaction such as Tax ID, National ID, etc.
2 properties
directDebitAmount
object
Object containing direct debit Amount
3 properties
TraceId
string
A unique identifier generated by server for tracing the request through the system.
programUpdated
object
Information on Program taken in Recurring Program
23 properties
accountLinkException
object
Information on account link exception.
11 properties
merchantStatusNotification
object
Information regarding the state of onboarding and termination status
15 properties
merchantSuspendedWithFundHold
object
Information regarding merchant status when account is suspended with fund hold
3 properties
monthlyCompleted
object
Information when Monthly Report Generation has Completed
1 property
allocationOrderInstructionNotification
object
Allocation Order Instruction Notification.
2 properties
recurringProgramMetadata
object
Recurring Program Metadata
2 properties
merchantSuspendedWithoutFundHold
object
Information regarding merchant status when account is suspended without fund hold
3 properties
adfsError
object
Object containing information about the active directory file system error.
3 properties
3 required
context
object
Context
5 properties
SORTCODE
object
Account identifier specific to the SORTCODE account numbering scheme.
3 properties
1 required
webhookVerification
object
The mandatory notification to verify a webhook subscription's callback URL and security preferences before activating that subscription.
2 properties
notificationSearchResponse
object
List of notifications sent to merchant
4 properties
merchantOnboardingDeclinedWithCreditPull
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
4 properties
User
object
Pay by Bank User
1 property
Balance
object
Balance Information
3 properties
2 required
paymentErrored
object
Information on transaction that failed with an error at the payment gateway.
8 properties
infoUpdateSuccess
object
Notification sent when Info of the entity is updated successfully
3 properties
restrictionFailed
object
Restriction Failed
4 properties
passcodeUpdateSuccess
object
Activation Level - ACTIVE | Definition - Notification sent when passcode is updated Successfully
1 property
securityAlert
object
securityAlert
3 properties
procStatusMessage
string
(DEPRECATED) Textual information describing the success or failure of an individual request for whether transactions have successfully passed all of the Gatewa…
adhocRunErrored
object
Information when Adhoc Report Generation has failed with error
1 property
transactionId
string
Identifies a unique occurrence of a transaction.
transactionIdentifier
string
Identifies a unique occurrence of a transaction.
scoreDetails
array
Array of score detail
aggregateOverdrawn
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
7 properties
microDepositSent
object
Microdeposits verify the legitimacy and ownership of a bank account, with an amount less than 1 dollar. A microdeposit has been successfully sent to the receiv…
1 property
allocationOrderUpdateNotification
object
(DEPRECATED) Allocation Order Update Notification sub type.
8 properties
commerceCenterUserAccessNotification
object
Commerce Center user access notification event data.
1 property
payoutCompleted
object
Payout Completed Information
4 properties
platformSettlementTransferUpdate
object
Platform Settlement Transfer Update notification sub-type.
13 properties
documentNotification
object
Document notification
2 properties
creditorAccount
object
Creditor Account
5 properties
productOnboardingNotification
object
(DEPRECATED) Product Onboarding Notification information
1 property
merchantReactivationDeclined
object
Information when merchant reactivation process is declined.
4 properties
upliftReminder
object
Canadian KYC mandate notification to remind the merchant that uplift is required.
6 properties
errorDetails
object
Error information if the network registration failed
1 property
paidAmount
object
Original amount paid.
2 properties
backupWithholdingStoppedTwo
object
Notification assigned when merchant is removed from Backup Withholding
4 properties
paymentVoid
object
Transaction Void Informaton
3 properties
disputeReceived
object
Information on the dispute case that was received on the network side.
3 properties
disputeMerchantResponseRequested
object
Information on the dispute case that requires response from the merchant.
6 properties
transactionChangeRequested
object
Transaction Change Requested
5 properties
merchantDoingBusinessAsName
string
The moniker given to an alias name for a Merchant labeled as D.B.A. that is different from the legal name.
FinancialInstitutionIdType_2
string
Financial Institution Identifier Type
payoutDenied
object
Payout Denied Information
4 properties
partyDetails
object
Provides detailed information about the party involved in the transaction.
5 properties
backupWithholdingPreventedTwo
object
Notification assigned when merchant submits their updated tax form before backup withholding effective date
4 properties
settlement
object
Defines the Settlement information for the PSP in an Allocation Order.
7 properties
merchantSuspendedAutoblock
object
Information regarding merchant status when account is suspended with autoblock
3 properties
procStatus
string
(DEPRECATED) Codifies the success or failure of an individual request for whether transactions have successfully passed all of the Gateway edit checks.
accountholderInfo
array
Array of Accountholder Information
fullName
string
The party's name as provided at the time the party is onboarded or updated based on firm policies and business rules that allow for such updates. For an indivi…
consumerProfileNotification
object
The platform send notification for consumer profile updates.
6 properties
supportedSubType
object
The second level categories of events the firm uses to communicate with the merchant.
3 properties
allocation
object
Defines an Allocation which is contained in an Allocation Order.
8 properties
orderUpdateNotification
object
(DEPRECATED) The Order updates information.
18 properties
messageToMerchant
string
Provides textual information entered by the Firm, pertinent to a chargeback dispute.
notificationSubType
string
The second level categories of events the firm uses to communicate with the merchant. This second level helps the merchant further narrow down the notification…
AddressInfo
object
Representation of an address object.
7 properties
payoutTotalTransactionAmount
object
Specifies the monetary value, in the settled currency, of all transactions.
2 properties
externalProfileId
string
an ID that is used by the plaform uses to refer to the C3 on their own systems
payoutUnderReviewReleased
object
Information about previously held payout released.
4 properties
ConsentLinkType
string
Type of consent link that defines how account connects. | Consent Link Type | Description | |:------------------|:---------------------------------------------…
cardType
string
English label for the method used to pay for the exchange of money, goods or services between a merchant and their customer. Examples: Visa, MasterCard, PayPal…
consumerCommunicationUpdated
object
Information on Communication Preference taken in Recurring Program.
12 properties
achReturnAmount
object
Object containing ach Return Amount
2 properties
passcodeEnabledByUser
object
Activation Level - ACTIVE | Definition - Notification sent when passcode is updated Successfully by user
1 property
allocationOrderInstructionUpdate
object
Allocation Order Instruction Update notification sub-type.
13 properties
AccountStatus
string
Account Status
orbitalOperations
object
Get notifications about migrated Orbital merchant activity.
1 property
ConsentLink
object
Representation of a generated consent link.
3 properties
2 required
ConsumerProfileId
string
Internal consumer profile identifier provided by JPMC
responseMessage
string
Long explanation of the response code.
planUpdated
object
Information on Plans taken in Recurring Program
14 properties
backupWithholdingStartedTwo
object
Notification assigned when Merchant is placed on Backup Withholding
4 properties
reportConfiguration
object
Report Configuration Information
11 properties
backupWithholdingStopped
object
Notification assigned when merchant is removed from Backup Withholding
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…
refundDeclined
object
Information regarding the refund declinednotification.
4 properties
ErrorContext
object
4 properties
1 required
ConsentId
string
Unique identifier to access consent resources (UUID)
financialAdjustmentAmount
object
Specifies the positive or negative monetary amount to debit or credit a merchant's bank account apart from regular billing of fees and separately classed as a…
2 properties
Amount
string
The value representation of a monetary amount. The amount value should be more than 0.01 with maximum of two decimal places allowed.
messages
object
A list of errors and warnings.
4 properties
2 required
cardUpdateSuccess
object
Notification sent when card info is updated successfully
4 properties
microDepositVerified
object
Microdeposits verify the legitimacy and ownership of a bank account, with an amount less than 1 dollar. A microdeposit has been verified
1 property
ReferenceId
string
A unique identifier provided by the client for the request, which will be returned upon the completion of the consent process.
canadianKyc
object
Notification type for events related to Canadian KYC mandates.
4 properties
infoUpdateFailure
object
Denotes failed update of Consumers Information and what was being updated
2 properties
ExternalUserProfile
object
Details of the external user.
4 properties
directDebitInitiated
object
In some situations, to return a merchant’s account to a non‑negative balance, a direct debit will be initiated. This webhook notifies the Platform that the mer…
4 properties
cardDetailsUpdate
object
Information on any metadata changes that occurred for the tokenized card product.
3 properties
AccountId_2
string
Internal account identifier provided by JPMC
adhocRunCompleted
object
Information when Adhoc Report Generation has Completed
1 property
backupWithholdingStarted
object
Notification assigned when Merchant is placed on Backup Withholding
4 properties
responseCode
string
Codifies the Firm's representation of the response code being sent back to the merchant.
directDebitAccountNotification
object
Information regarding Direct Debit Account updates.
3 properties
cardVerification
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
pspSettlementRef
object
Defines an provider settlement reference which is contained in an Allocation Order.
8 properties
acquirerReferenceNumber
string
Identifies a unique number assigned by the payment brand to a credit card transaction for use when it goes from the Firm acting as the acquiring bank through t…
paymentPurpose
object
This is used for specifying the reason for the payment associated with the transaction.
2 properties
amount
string
Specifies the monetary value of the transaction performed.
card
object
Card Details.
3 properties
eCommerceServiceUpdateNotification
object
Information regarding the eCommerce service update notifications.
1 property
payoutRejected
object
Information about payout rejected before posting.
4 properties
paymentApproved
object
Information on transaction that was successfully approved at the payment gateway.
10 properties
directDebitAccountUpdatePending
object
Information when a merchant's attempt to update their DDA is pending.
2 properties
directDebitAccountUpdateSuccess
object
Information when a merchant's attempt to update their DDA succeeded.
2 properties
entityOnboardingReviewInProgress
object
Information sent in the notification when the status of an entity changes during the onboarding process.
4 properties
externalTransactionReferenceNumber
string
External transaction reference number provided by the system.
paymentScore
object
Payment Score information
5 properties
balanceMonitoringNotification
object
Balance Monitoring Notification event data
3 properties
paymentMethodDeleted
object
Information on the removal of a payment method, which was used in the consumer profile system.
1 property
approvalCode
string
An Identifier that an issuer (payment authorizing processor, or Stand-In Processing (STIP)) provides to indicate approval of a Point of Sale transaction. The c…
paymentRoutingInformation
object
Payment Routing Number
4 properties
entityInfo
object
Entity Information
2 properties
decimalCount
string
Number of decimal places allowed for the amount value. For example, if the amount value is 100.00, the decimal count is 2.
payoutCreated
object
Payout Created information
4 properties
tokenTypeCode
string
Tokenization method used in a transaction. Sample values are Network Token, Acquirer Token
notificationDescription
string
Textual information that defines each notification type.
payoutUnderReview
object
Payout Under Review Information
4 properties
refundAmount
object
Return amount
2 properties
Party_2
object
Representation of a party with its role, identity, and verification status.
4 properties
2 required
backupWithholdingPrevented
object
Notification assigned when merchant submits their updated tax form before backup withholding effective date
4 properties
microDepositReadyToValidate
object
A New Notification subtype which will be send to the payer when the microdeposit is ready to validate.
2 properties
externalAccount
object
This object provides external account information.
6 properties
debtorDetails
object
Debtor Details of the person or an entity that pays for the goods or services purchased.
1 property
currency
string
Codifies the monetary unit that was associated with the financial transaction (such as sale, returns, chargebacks etc.).
refundApproved
object
Information regarding the refund approved notification.
4 properties
overdraftStatus
object
Overdraft Status
3 properties
accountUpdateNotification
object
The consumer Account Update information.
18 properties
merchantPerfPlatUpgrade
object
When an SMB merchant upgrades their processing to Payments First
2 properties
bulkConsumerProfileUpdate
object
Information on status of the bulk Consumer Profiles files
7 properties
registeredAccount
object
This object provides registered account information.
4 properties
PhoneInfo
object
Representation of a Phone Number
2 properties
accountOverdrawn
object
Account Overdrawn
4 properties
networkResponse
object
Network Response attributes during account update
3 properties
achStatusNotification
object
ACH transaction lifecycle information.
2 properties
enrollmentSuccess
object
Notification sent when Profile is successfully enrolled
2 properties
disputeType
string
The label given to a current step or stage of the case in the dispute case resolution life cycle.
paymentMethodId
string
Identifies a unique occurrence of the type of payment accepted by a level of the hierarchy of the merchant acquiring account.
AccountDetail
object
Consented accounts details
4 properties
1 required
bulkFileStatus
object
Get notified when Orbital merchants' bulk files are updated.
7 properties
paymentMethodCreated
object
Information on the creation of a new payment method, for use in the consumer profile system.
1 property
tokenProvisionUpdate
object
Information on asynchronously provisioned token for future processing.
6 properties
responseStatus
string
Codifies the general categorization by the Firm of the response code being sent back to the merchant.
pspSettlementTransferUpdate
object
Psp Settlement Transfer Update notification sub-type.
13 properties
dayScore
object
Day Score
4 properties
responseSent
object
(DEPRECATED) Information on response sent for a particular dispute case to the payment brand.
7 properties
last4PaymentAccountNumber
string
This is the last 4 digits Direct Debit Account(DDA) that is credited. The truncated value is used in place of the full number to protect against exposure of co…
notificationType
string
The first level categories of events the firm uses to communicate with the merchant. e.g. "disputeNotification".
individualFirstName
string
That part of an individual's full name considered a personal name or given name and generally positioned before the last name or family name.
backupWithholdingPending
object
Notification assigned when B-Notice is issued to the merchant
4 properties
ConsentLinkWithView
object
Representation of a generated consent link.
tokenExpiry
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
2 properties
recurringProgramPauseInformation
object
Recurring Program Pause Information
6 properties
processingThresholdNotification
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
1 property
allocationOrderSettlementNotification
object
Allocation Order Settlement Notification.
3 properties
firstTimeRegistration
object
Customized registration email details for first-time user registration.
3 properties
disputeClosed
object
Information on the dispute case that was closed on the network side.
6 properties
documentGenerated
object
Generated document details
4 properties
merchantReactivationInProgress
object
Information when merchant reactivation process is in progress.
4 properties
paymentDeclined
object
Information on transaction that was declined at the payment gateway.
9 properties
refundsDetails
object
List of Return of Funds linked to the Payment Request
1 property
entityNetworkRegistrationException
object
Information sent in the notification when an error is encountered during network registration process
8 properties
profileUnFreeze
object
Notification sent when Profile is UnFreezed
1 property
received
object
(DEPRECATED) Information on a new dispute case generation on the network (fetched by CB911).
5 properties
last4CardNumber
string
Identifies the final 4 digits of the 16 digit card number. The truncated value is used in place of the full number to protect against exposure of confidential…
commerceCenterRegistrationUrlText
string
A reference to a web resource on the internet specifying its location on a computer network and a mechanism for retrieving.
merchantAccountPendingForClosure
object
Information regarding merchant status when account is pending closure
3 properties
entityScreening
object
Information sent in the notification when the status of an entity changes during the merchant screening process.
6 properties
achReturnReceived
object
Information about ACH transactions when they are returned by the financial institution.
5 properties
email
object
Email Information
3 properties
correctedValue
object
Corrected Value
2 properties
errorContext
object
Additional context information for the error
3 properties
ConsentBasic
object
Representation of a User's consent details without account information.
13 properties
6 required
key
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
16 properties
accountClosed
object
Account Closed
14 properties
newAccountInformation
object
Information about new card account when available.
4 properties
microDepositInitiated
object
Microdeposits verify the legitimacy and ownership of a bank account, with an amount less than 1 dollar. A microdeposit has been initiated from the sender's acc…
1 property
tokenRequestorIdentifier
string
Identifier for acquirer, merchant or digital wallet provider that will use the payment token to replace the PAN in its transaction processing.
debtor
object
Debtor details of the transaction.
5 properties
transactionDate
string
Designates the hour, minute, seconds and date (if timestamp) or year, month, and date (if date) when the transaction (monetary or non-monetary) occurred.
notificationTypeResponse
object
Notification type supported by firm
1 property
authenticationComplete
object
Information on authentication response received.
8 properties
qrCodeCancelled
object
Information regarding the cancelled state of QR Code
1 property
backupWithholdingPendingTwo
object
Notification assigned when B-Notice is issued to the merchant
5 properties
routingInformation
object
Routing Information
5 properties
qrCodeStatusNotification
object
Information regarding the state of QR Code and Payment life cycle.
7 properties
disputeLiabilityAmount
object
Object containing merchant liability Amount
2 properties
productOnboardingStatus
string
Codifies the current status of the merchant onboarding to the Commerce platform.
paymentMethodType
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
6 properties
communicationPreference
object
Communication Preference
5 properties
FinancialInstitutionId_2
object
Financial Institution Identifier
2 properties
2 required
paymentRequestIdentifier
string
Identifies a unique occurrence of a payment processing request for a sale that is associated with a purchase of goods and/or services. A payment request can co…
payoutIdentifier
string
This is the unique identifier of particular payout for merchant.
payoutStatus
object
(DEPRECATED) Payout Status information
3 properties
contacts
object
This object provides key contact information for the party involed in the transaction.
4 properties
ExternalUserId
string
User Id for tracking the external user
reportStatusNotification
object
Information regarding merchant reports, run by the Firm.
11 properties
ConsentType
string
Type of consent requested, specifying the scope of access to account information | Consent Type | Description | Supported Region | |:-------------------------|…
entityOnboardingDeclined
object
Information sent in the notification when the status of an entity changes during the onboarding process.
4 properties
profileFreeze
object
Notification sent when Profile is Freezed
1 property
callbackURL
string
URL/Endpoint to receive Webhook notifications by merchant.
refundErrored
object
Information regarding the refund errored notification.
4 properties
USABA
object
Account Identifier in US Banking account number format
5 properties
1 required
paymentHold
object
Canadian KYC mandate notification to warn the merchant that if uplift is not completed, their payments will be held.
6 properties
payoutNotification
object
Information regarding the status of a Payout.
11 properties
sourceResponseStatus
string
Response status from source system
qrCodeExpired
object
Information regarding the expired state of QR Code
1 property
ConsentLinkResponse
object
Representation of the details necessary to start and track the consent journey.
accountCreated
object
Account Created
13 properties
scoreByDay
array
Array of Day Score
accountBalance
object
Account Balance Information
4 properties
paymentDetails
object
Payment Details Object
9 properties
recurringProgramBillingScheduleInformation
object
Recurring Program Billing Schedule Information
11 properties
ErrorInfo
object
Error details for consent processing issues
3 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from JPMorgan Chase 12
Other APIs JPMorgan Chase publishes across the network.
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
JPMorgan Chase Account Validation API
#Health Check#Notification#Subscription
Where this information came from
This is an independent, third-party profile of Notifications 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.