Payment Intents

Get payment intent

Returns details for a specific payment intent using its unique identifier.

get/payment-intents/{id}

Request

  • Base URL: https://apigateway.jpmorgan.com/tsapi/ef/v1
  • URL: https://apigateway.jpmorgan.com/tsapi/ef/v1/payment-intents/{id}
  • Auth: none declared

Path parameters

idstring required

Unique identifier for a payment intent.

Headers

tokenstring

JWT Client token

Response

Successful

idstring

Payable ID

amountnumber
expirationDatestring date

ISO date format - yyyy-MM-dd. If no date provided, value should be set to 30 days from the current date.

recipientIdstring

Recipient ID

debtorAccountIdstring

ID of the account to make the payment from.

debtorAccountNumberstring

The last 4 digits of the debtor account number. The digits are preceded by ... to show that the account number has been masked.

debtorNamestring

The name of the account holder making the payment. This is either the name of the account holder?s business or their first and last name.

creditorNamestring

The name of the account holder receiving the payment. This is either the name of the account holder?s business or their first and last name.

creditorEmailstring

Creditor's email

type'PAYABLE'

Payment intent status

status'PENDING' | 'COMPLETED' | 'CANCELED' | 'REJECTED' | 'EXPIRED' | 'SCHEDULED'

Payment intent status

balanceHoldIdstring

Generated balance hold Id of payable

currencystring

The currency of the check, in three-character ISO currency code.

transactionIdstring

Generated transaction Id of payable

createdAtstring date-time

Date the payment intent was created.

Example response

{
  "id": "a8eb71c9-7bbb-41f2-8d9e-b0f52d1ecd71",
  "amount": 100,
  "expirationDate": "2022-12-31",
  "recipientId": "a8eb71c9-7bbb-41f2-8d9e-b0f52d1ecd71",
  "debtorAccountId": "511935fceffb482389371d525c835875",
  "debtorAccountNumber": "...6044",
  "debtorName": "Monica Gellar",
  "creditorName": "Emily Thorne",
  "creditorEmail": "emily@hhbakery.com",
  "type": "PAYABLE",
  "status": "PENDING",
  "currency": "USD",
  "createdAt": "2021-11-17T10:04:37.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.