Skip to main content
Beta version available

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

Get the status of a Push to Wallet payment request

In this tutorial, you'll learn how to use the Global Payments API to retrieve the status of a Push to Wallet payment request.

By the end of this tutorial, you'll know how to:

  • Use the mandatory endToEndId and optional firmRootId to verify the status of your request.
  • Interpret Push to Wallet response types.

Before you begin

To retrieve the status of a Push to Wallet payment request, you'll need the endToEndId, which is provided in a successful payment response. 

Create and send a status request

A successful response include an endToEndId value, which you can use to retrieve the status of the payment request. To do this, make a GET request to the /payments/status endpoint, appending your unique endToEndId to the end of the call:

Example transaction status request
Curl
curl --request GET \
          https://api-mock.payments.jpmorgan.com/tsapi/v1/payments/status?endToEndId= DJ937HJ4L5S0

The following response shows a payment in the PENDING status:

Example transaction status response: PENDING
Json
{
  "paymentStatus": {
    "createDateTime": "2023-06-13T00:00:12.145",
    "status": "PENDING"
  }
}

A rejected response contains an error code value, description, and a rule definition that can help determine the reason for the request failure. The following response shows a payment in the REJECTED status, along with an additional field, externalCode.

Example transaction status response: REJECTED
Json
{
  "paymentStatus": {
    "createDateTime": "2023-06-13T00:00:12.145",
    "status": "REJECTED",
	"exception": [
		{
		"errorCode": "10005",
		"errorDescription": "Error occurred on paymentAmount", 
		"ruleDefinition": "Transaction Amount exceeds the limit setup for the payment flow",
		"externalCode": "AM13"
		}
	]
		
  }
}

Push to Wallet supported response types

Push to Wallet supports multiple response types. The following table provides a detailed explanation of these response types:

Push to Wallet supported response types

Status

Description

PENDING

The request was initiated successfully and is being processed by J.P. Morgan. The status will remain as PENDING until further updates are triggered. 
PENDING_POSTING PayPal has successfully received the instruction, but the funds have not yet been deposited into the recipient's account because the payment is pending PayPal's review and processing.

REJECTED

The request failed our controls, such as sanctions, funds control, or qualification, or was rejected due to issues like recipient account problems, incorrect instructions, or an unverified recipient.

WAREHOUSED

We received the instruction and warehoused the payment until the requested execution date.

COMPLETED

The funds were successfully credited to the recipient’s payment method.
RETURNED The funds were returned and successfully credited back to your account.
BLOCKED PayPal's sanction screening controls blocked the request, and the payout was not made to the recipient.

Learn how to initiate a payment request.

Next steps