Get the status of a Kinexys Digital Payments request

In this tutorial, you will learn how to use the Global Payments API to retrieve a Kinexys Digital Payments status. The Global Payments API supports automatic status updates using webhooks, but there may be instances where you need to manually check the status of a request. By the end of this tutorial, you will know how to:

Use the endToEndId or firmRootId to check and confirm the status of your payment.

Before you begin

To retrieve a Kinexys Digital Payments status, you need:

A registered and fully onboarded Developer Account on the J.P. Morgan Payments Developer Portal.
An active project that provides you with the credentials used to make a request.
A J.P. Morgan Blockchain Deposit Accounts (BDA) opened at J.P. Morgan Chase Bank, N.A.
A Demand Deposit Account (DDA) opened in an approved funding location in which you want to perform a Kinexys Digital Payments transaction.

Get Kinexys Digital Payments status

Request payloads for the Global Payments API have optional and required fields. Use one of the following values to retrieve the Kinexys Digital Payments request status.

firmRootId
endToEndId

The Kinexys Digital Payments supports multiple response types, including PENDING, PENDING_POSTING, COMPLETED, and REJECTED. For more information, see Response types.

Kinexys Digital Payments firmRootId status requests

To obtain the payment status send a GET HTTP request to the applicable URL, using the firmRootId.

Example of a CAT GET HTTP using the firmRootId:

Kinexys Digital Payments firmRootId Status Request

Curl

curl --request GET \ --url https://api-mock.payments.jpmorgan.com/tsapi/v1/payments?firmRootId=98275a2d-1e88-beed-6938-0521a7e0oinc' \ --header 'Accept: application/json'

Confirm firmRootId response

A successful response contains a paymentStatus object. The successful response below represents a request that is COMPLETE.

Kinexys Digital Payments firmRootId Status Response

Json

{
  "paymentStatus": {
    "createDateTime": "2023-06-10T00:00:01.000",
    "status": "COMPLETED"
  }
}

Kinexys Digital Payments endToEndId status requests

To obtain the payment status send a GET HTTP request to the applicable URL, using the endToEndId.

Example of a CAT GET HTTP using the endToEndID:

Kinexys Digital Payments endToEndId Status Request

Curl

curl --request GET \ --url https://api-mock.payments.jpmorgan.com/tsapi/v1/payments/status?endToEndId=XR20210920231135 \ --header 'Accept: application/json'

Confirm endToEndId response

A successful response contains a paymentStatus object. The successful response below represents a request that is PENDING_POSTING.

Kinexys Digital Payments endToEndId status request response