Skip to main content

Get the status of a Real-Time Payments request

In this tutorial, you will learn how to use the Global Payments API to retrieve the status of an RTP request. By the end of this tutorial, you will know how to:

Use an endToEndId to manually check and confirm the status of your request.

Tip

The Global Payments API supports callbacks for automatic status updates.

Before you begin

To retrieve the status of an RTP request, you will need the following:

An endToEndId value for your payment request, which is provided in a successful payment response. 

Create and send a status request

A successful response contains an endToEndId value that can be used to retrieve the details of the payment request. To do this, call a GET request to the /payments/status endpoint, appending your unique endToEndId to the end of the call:

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.