JPMorgan Chase Payment Holds 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 Holds. 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 64 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.5.
Requests are made against 3 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.
The identity and technical contract details declared by the specification.
FailureReason
object
Failure reason details with code and message
2 properties
AdditionalContext
array
Additional details about the error based on a standard (e.g. ISO or Clearing codes)
PaymentHolds
object
List of Payment Holds
2 properties
2 required
UnstructuredAddress
array
Unstructured Addresses
IndividualIdentification
object
Individual Identification Schemes
1 property
1 required
Error
object
Common Error Model
5 properties
1 required
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…
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…
AdditionalInstitutions
array
Additional Institutions
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…
EndToEndId
string
Customer assigned Unique identifier to unambiguously identify the Payment transaction. This identification is passed on, unchanged, throughout the entire end-t…
StreetName
string
Street name
PaymentIdentifiers
object
Identifiers associated with the Payment Instruction throughout its lifecycle.
2 properties
1 required
PaymentType
string
The type of payment being initiated - WIRE for Wire Payments, ACH for ACH Payments, RTP for Real-Time Payments
DecisionBulkResponse
object
Bulk response for multiple payment hold decisions
1 property
FinancialInstitutionIdType
string
Fraud
object
Fraud details associated with a rejected payment hold. Only present when rejectReason is FRAUD.
2 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
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…
IsoCountryCode
string
ISO 3166-1 Alpha-2 Country Code
InitiatingParty
object
The financial institution or agent that initiates the payment or transaction on behalf of the ordering party.
DecisionSubstatus
string
Substatus providing additional detail on the current state of the payment hold. | Enum Value | Description | |------------|-------------| | PENDINGACTIONCLIENT…
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
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
IsoCurrencyCode
string
ISO 4217 Alpha-3 Currency Code
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
OrganizationIdentification
object
Organization Identification Schemes
1 property
1 required
AddressType
string
Type of address
PaymentValue
object
A positive amount of value.
2 properties
2 required
ErrorContext
object
Error Context
5 properties
1 required
DecisionAction
string
Action taken on the payment instruction | Enum Value | Description | |------------|-------------| | APPROVE | Approve the payment hold for processing | | REJEC…
StandardCodeContext
object
Standard Code Context for error codes
3 properties
3 required
Payment
object
Representation of the payment instruction.
10 properties
8 required
CreditorAgent
object
The Bank or financial institution of the creditor (the party receiving the payment).
4 properties
1 required
DecisionStatus
string
Status of the payment hold | Enum Value | Description | |------------|-------------| | PENDING | Payment hold is pending review and decision | | APPROVED | Pay…
IsoCountrySubdivisionCode
string
ISO 3166-2 Alphanumeric Country Subdivision Code
DecisionBulkRequest
object
Bulk request to take action on multiple payment holds
1 property
Debtor
object
The party that owes money and is responsible for repaying the debt.
DecisionResponse
object
Response for a decision action on a payment hold
5 properties
2 required
AdditionalInstitution
object
Additional Institution
4 properties
2 required
Address
object
Information that locates and identifies a specific address
8 properties
PostalCode
string
Postal code
AccountId
string
Account number.
Uuid
string
Unique payment hold identifier generated by JPMC
DecisionRequest
object
Request to take action on a payment hold
4 properties
2 required
Account
object
Representation of a bank account. Features of the model may vary between different account types.
3 properties
1 required
HoldDecisionResult
string
Outcome of the action (Success or Failure)
FinancialInstitutionId
object
Financial Institution Identifier
3 properties
2 required
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
DecisionActionRequest
object
Request to take action on a payment hold
3 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…
PaymentHold
object
Payment Hold Details including the original payment instructions along with the rules or criteria and pending action for the hold.
11 properties
4 required
Source
string
Indicates the source of the decision on the payment hold. | Enum Value | Description | |------------|-------------| | API | Decision made via the API | | JPMCU…
Creditor
object
The creditor (payee) of the payment instruction.
FraudType
string
Type of fraud | Enum Value | Description | |------------|-------------| | BUSINESSEMAILCOMPROMISE | Fraudulent email schemes targeting business transactions |…
Rule
object
Client defined rule
4 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
Pagination
object
Contains the pagination details
4 properties
3 required
Decision
object
Details of how the hold was resolved. Present only for holds that have already been decisioned.
3 properties
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
PartyId
Party Identification
AccountType
string
Account Type
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
