Beta version

Welcome to the beta version of the Global Payments 2 API! For the generally available Global Payments API, refer to Global Payments.

Get the status of a JPM Coin System payment request

In this tutorial, you will learn how to use the Global Payments API to retrieve a JPM Coin System payment 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 paymentId to check and confirm the status of your payment.

Before you begin

To retrieve a JPM Coin System payment 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 JPM Coin System transaction.

Send a request

Request payloads for the Global Payments API have optional and required fields. Use the paymentId to retrieve the JPM Coin System payment request status.

The JPM Coin System supports multiple response types, including: RECEIVED, ACCEPTED, PROCESSING, CANCELED, REJECTED, COMPLETED, and RETURNED. For more information, see Response types.

JPM Coin System payment status requests

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

Example of a CAT GET HTTP using the paymentId:

Example of a JPM Coin System status request

Curl

curl --request GET \
  --url https://api-mock-payments.aws.jpmchase.net/payment/v2/payments/989a066e-2947-4fa9-9ec7-5d09b1917c11/status \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p'

Confirm the response

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

Example of a JPM Coin System status response

Json

{
  "paymentId": "f0e5486f-898a-406c-9c1f-63a0789fd961",
  "paymentStatus": "PROCESSING",
  "statusUpdatedAt": "2024-10-30T14:15:22Z",
  "requestedExecutionDate": "2024-10-30",
  "paymentIdentifiers": {
    "endToEndId": "COIN20230125_081"
  },
  "transferType": "CREDIT",
  "paymentType": "BLOCKCHAIN"
}

For more information about JPM Coin payment parameters, see Payment parameters.
For more information about status responses and error codes supported by the Global Payments API, see Global Payments 2 status responses and error codes.

Next steps

Get the details of a JPM Coin System payment.