Webhooks API
Set up and manage webhook subscriptions to receive real-time notifications about key events, like transactions, account changes, or client onboarding, directly to your platform, so you can automate workflows and respond instantly as events happen. This API lets you create, update, and monitor your webhook endpoints, giving you fine-grained control over which events you track and how you handle them.
Webhooks 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 Webhook. 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 79 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.55.
Requests are made against 3 base URLs: https://api.payments.jpmorgan.com/embedded/v1, https://api-mock.payments.jpmorgan.com/embedded/v1, https://api-sandbox.payments.jpmorgan.com/embedded/v1.
The identity and technical contract details declared by the specification.
RestrictionsCallbackEvent
TransactionCounterPartyContactDetailsV3
object
Contact details of the counterparty.
4 properties
TransactionCounterPartyAddressDetailsV3
object
The address details of the counterparty.
7 properties
2 required
TransactionCounterPartyExternalAccountV3
object
The external account of the counterparty
2 properties
2 required
TransactionCounterPartyCardAccountDetailsV3
object
The card details of the counterparty account.
3 properties
CorrectedValue
object
2 properties
2 required
RestrictionsCallbackResource
object
10 properties
ClientCallbackResource
object
7 properties
TransactionCounterPartyDetailsV3
object
The party details of the counterparty.
5 properties
WebhookCallbackEventBase
object
5 properties
3 required
RemittanceCallbackResource
object
5 properties
DocumentCallbackResource
object
3 properties
TransactionCounterPartyAccountV3
The account details of the counterparty.
ResourceObjectType
string
AccountTypeForNotification
string
Category of the account
OverdraftStatus
object
Details related to the account overdraft status. This is only used when eventType is ACCOUNTOVERDRAWN.
3 properties
PartyCallbackResource
object
3 properties
PaymentRoutingInformation
object
2 properties
TransactionCounterPartyCardAccountV3
object
The card account of the counterparty
2 properties
2 required
RestrictionStatus
string
Status of the restriction
HoldAmount
string
Amount to hold
StatusDetails
object
StatusDetails
5 properties
AggregateOverdrawn
object
7 properties
TransactionCounterPartyIdentityDetailsV3
object
Identity details for the counterparty.
2 properties
SigningKey
object
This returns the public key details used to decrypt the webhooks payload
3 properties
EventTypeEnum
string
The event types to be notified of.
PageMetaData
object
3 properties
RoutingInformationV3
object
Routing information for the account.
3 properties
AccountCallbackResource
object
10 properties
RestrictionReasonV2
string
Reason for the restriction
AccountStateForNotification
string
State of the account. An account in a state of OPEN can be used for any enabled transactions. An account in PENDINGCLOSE can be used for all transactions suppo…
WebhookResponse
object
7 properties
5 required
RecipientStatus
string
Callback event type needs to send to notsub for correct status.
ApiErrorReasonV2
object
Schema representing detailed reasons for an API error, including code, location, and message.
4 properties
1 required
TransactionPaymentPurpose
object
The purpose of the payment
2 properties
ChangeDetails
object
Details describing changes required to the recipient. This is only used when eventType is TRANSACTIONCHANGEREQUESTED.
2 properties
2 required
WebhookCallbackEventType
string
Master list of all webhook callback event types. Resource-specific callback events override this with a narrowed enum.
WebhookUpdateRequest
object
Update a webhook - add, remove subscriptions or change the status of your webhook
4 properties
2 required
RestrictionReason
string
Reason for the restriction
ApiError
object
5 properties
3 required
RecipientAccount
object
Bank account details of the recipient.
5 properties
2 required
RoutingInformationItem
object
3 properties
2 required
Context
object
3 properties
WebhookRequest
object
Create a webhook
3 properties
1 required
CurrencyCode
string
Three letter currency code based on ISO 4217 standard
SecurityPreferences
object
Parent Object which holds information on security preferences for sending Webhook Notifications.
2 properties
RoutingInformation
object
3 properties
3 required
ListWebhookResponse
object
2 properties
2 required
RestrictionType
string
Restriction type
Timestamp
string
Date and time
GetTransactionCounterPartyV3
object
5 properties
AuthorizationDetails
object
This object holds additional authorization details to apply when sending webhook notifications.
3 properties
RestrictionStatusV2
string
Status of the restriction. Can be 'ACTIVE' or 'INACTIVE'
RoutingCodeType
string
Type of routing code.
Restrictions
object
7 properties
CountryCode
string
Two letter country code based on ISO 3166 standard
TransactionCounterPartyExternalAccountDetailsV3
object
The external account details of the counterparty.
6 properties
AccountNumber
string
Demand Deposit Account number or International Account Number (IBAN).
RoutingNumber
string
Routing number corresponding to the routing code type
Subscription
object
The webhooks you are subscribed to. Each subscription contains events about which you are notified via HTTPS request to your pre-configured server URL.
1 property
1 required
RestrictionTypeV2
string
The type of restriction to apply to the account, Can be 'DEBITS', 'CREDITS', 'DEBITCREDIT', 'DIRECTDEBIT' or 'HOLD'
RecipientsCallbackResource
object
9 properties
TransactionCallbackResource
object
26 properties
PaymentTypeResponseV3
string
The transaction type indicates the nature of the transaction. Certain types cannot be initiated through the API and, as a result, are excluded from the transac…
ApiErrorV2
object
Schema representing a version 2 API error, including title, HTTP status, and additional context.
5 properties
1 required
OriginatingTransactionV3
object
Details of the originating transaction for fees, returns, or linked transactions.
2 properties
TransactionCounterPartyRegisteredAccountV3
object
The registered account of the counterparty
2 properties
2 required
AccountType
string
Type of bank account.
TransactionCounterPartyRegisteredAccountDetailsV3
object
The registered account details of the counterparty.
5 properties
RoutingInformationTransactionType
string
Type of transaction.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
