Beta version available

The Global Payments 2 API is currently available in beta. Contact our team to start your integration process.

Global Payments

Get the status of a Real-Time Payments request

In this tutorial, you'll learn how to use the Global Payments API to retrieve the status of an RTP request. By the end of this tutorial, you'll know how to use an endToEndId to manually check and confirm the status of your request.

Tip

The Global Payments API supports webhooks for automatic status updates.

Before you begin

To retrieve the status of an RTP request, you'll need an endToEndId from your payment request. This value is included in the successful payment response.

Create and send a status request

A successful response includes an endToEndId value, which you can use to get details about your payment request. To retrieve this information, send a GET request to the /payments/status endpoint and add your unique endToEndId at the end of the URL.

Example GET /payments/status request

Curl

curl --location 'https://api-mock.payments.jpmorgan.com/tsapi/v1/payments/status?endToEndId=pl210g9t231r13541130'

The following example shows a status response for a pending transaction:

Example transaction status response: PENDING

Json

{
    "paymentStatus": {
        "createDateTime": "2022-10-15T00:00:12.145",
        "status": "PENDING"
    }
}

For a full list of supported status response types, see Webhooks.

Next steps

Learn how to retrieve the payment details of your RTP request.