Get the status of a Push to Wallet payment request

In this tutorial, you will 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 will know how to:

Use the endToEndId (mandatory) and firmRootId (optional) to check and confirm 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 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 status 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 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 be used to determine the request failure. The following response shows a payment in the REJECTED status 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 supports multiple response types, including PENDING, PENDING_POSTING, REJECTED, WAREHOUSED, COMPLETED, RETURNED, and BLOCKED. The below table explains these response types in more detail:

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 an event occurs to change the status.
`PENDING_POSTING`	The instruction was successfully received by PayPal but funds have not yet been deposited into the recipient’s account because the payment is pending PayPal’s reviewing/processing.
`REJECTED`	The request failed J.P. Morgan controls (e.g., sanctions, funds control, qualification), or the request was rejected by Push to Wallet due to recipient account issues, incorrect instruction, or an unverified recipient.
`WAREHOUSED`	J.P. Morgan has received the instruction and has warehoused the payment until the requested execution date.
`COMPLETED`	The funds were successfully credited to the recipient’s payment method.
`RETURNED`	A return of funds has been successfully credited back to the client’s account.
`BLOCKED`	The request was blocked by PayPal sanction screening controls and the payout was not made to the recipient.

Learn how to initiate a payment request.

Next steps

Learn how to get the details of your Push to Wallet payment request.
Review payment/creditor options.
Understand the required payment parameters for your region.

Get the status of a Push to Wallet payment request

Before you begin

Create and send a status request

Related

Next steps