JPMorgan Chase Payment Request - Bulk 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 Request - Bulk. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
3 operations
across 2 paths,
and defines 44 schemas.
It is described by OpenAPI 3.2.0, at version 1.4.4.
Requests are made against 3 base URLs: https://api.payments.jpmorgan.com/receivables/request-to-pay/v1, https://api-cat.payments.jpmorgan.com/receivables/request-to-pay/v1, https://api-mock.payments.jpmorgan.com/receivables/request-to-pay/v1.
The identity and technical contract details declared by the specification.
ExpirationType
string
Payment request expiration type |Markets |Description | |:--------------------------|:------------------------------------------------------------------| |Braz…
Email
object
Representation of an email
2 properties
QRCodeGenerationStatus
object
Representation of QR Code generation status
3 properties
PaymentRequestBulk
object
Bulk Payment Request
2 properties
ISOCountryCode
string
ISO 3166-1 Alpha-2 country code |Markets |Country ISO Code |Description | |:----------|:--------------------|:-------------------------------------------------…
Percentage
string
The value representation of a percentage. The percentage value should be between 0.01 and 99.99 with maximum of two decimal places allowed
SchemeName
object
Specifies the type of Proxy account. Mandatory if alternateAccountIdentifier is present
1 property
Reference
string
Text to be presented to the payer so that payer can enter related information in free format, to be sent to the recipient. |Markets |Description | |:----------…
BulkPaymentRequestBasic
object
Bulk Payment Request basic details
4 properties
AlternateAccountDetails
object
Alternate account details
2 properties
Debtor
object
The person or an entity that pays for the goods or services purchased
4 properties
Error
object
Common error model
5 properties
1 required
BulkStatus
object
Bulk Request Status
2 properties
QRCodeRequest
object
Representation of QR Code request
5 properties
Creditor
object
Creditor details
5 properties
PaymentRequestId
string
Unique transaction identifier provided by client or identifier generated by JPM |Market |Description | |:--------------------------|:--------------------------…
Address
object
Representation of an address
6 properties
PaymentRequest
object
Payment Request details
20 properties
1 required
RequestMethodType
string
Payment Request method type | Value | Description | |:----- |:-----------------------------------------------| |NONE |QR code not required | |QRCODE |Generate…
CreditorTaxInformation
object
Creditor tax details |Markets |Description | |:--------------------------|:------------------------------------------------------------------| |Brazil |Applica…
2 properties
CutOffItem
object
Cutoff limit to calculate discount, expressed as a date and applicable discount in percentage or fixed amount
3 properties
IdempotencyKey
string
A unique string that enables API support idempotency by safely retrying requests without accidentally performing the same operation twice
PaymentRequestBulkItem
object
Payment Request
5 properties
3 required
Duration
integer
Specify how long (in seconds) the request is valid. ISO 8601 compliant duration. E.g., a validity of 5 minutes will be represented as 300. If duration unspecif…
Discount
object
Parameters to calculate discount based on actual payments |Markets |Description | |:--------------------------|:-----------------------------------------------…
4 properties
PaymentRequestBulkUpdateItem
object
Payment Request Bulk Update Item
4 properties
3 required
UnstructuredInformation
object
Unstructured information about request
2 properties
Penalty
object
Penalty details expressed as a fixed value or percentage of payment amount |Markets |Description | |:--------------------------|:------------------------------…
2 properties
ISOCurrencyCode
string
ISO 4217 Alpha-3 Currency Code |Markets |Currency ISO Code |Description | |:----------|:--------------------|:-------------------------------------------------…
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.
PaymentRequestBulkId
string
Unique Bulk Payment Requests identifier generated by JPM
ValueType
string
Value type either as fixed amount or percentage of original amount |Markets |Description | |:--------------------------|:--------------------------------------…
PaymentRequestBulkUpdate
object
Bulk Update Payment Requests |Market |Description | |:--------------------------|:------------------------------------------------------------------| |Singapor…
2 properties
UnstructuredAddress
array
Unstructured Address |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil | De…
Reduction
object
Reduction details expressed either as a fixed value or percentage of payment amount |Markets |Description | |:--------------------------|:---------------------…
2 properties
InterestType
string
Interest type |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil |Applicable…
BulkPaymentRequest
Bulk Payment Request details
ETag
string
Entity tag that uniquely represents the requested resource represented as string of ASCII characters placed between double quotes e.g., "675af34563dc-tr34". Wi…
AlternateAccountIdentifier
string
Alternate account identifier based on the scheme |Markets |Description | |:--------------------------|:--------------------------------------------------------…
DiscountType
string
Discount type |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil |Applicable…
ExpiresAt
string
Specify a datetime stamp in valid RFC 3339 section 5.6, ISO 8601 compliant format for expiration. E.g., YYYY-MM-DDThh:mm:ss+/-time offset to UTC |Markets |Desc…
Interest
object
Parameters to calculate interest for the payments overdue |Markets |Description | |:--------------------------|:-----------------------------------------------…
3 properties
DebtorTaxInformation
object
Debtor tax details |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil |Appli…
2 properties
ErrorContext
object
Error Context
4 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.