Skip to main content
Global Payments

Get the status of an Interac e-Transfer payment request

In this tutorial, you'll learn how to use the Global Payments API to retrieve the status of an Interac e-Transfer payment request.

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

  • Use the endToEndId (mandatory) and firmRootId (optional) to verify and confirm the status of your request.
  • Understand the different Interac e-Transfer response types.

Before you begin

To retrieve the status of an Interac e-Transfer payment request, you'll need an endToEndId value for your payment request, which is provided in a successful payment response. 

Create and send a status request

A successful response includes an endToEndId value, which you can use to check the status of the payment request. To retrieve the status, make a GET request to the /payments/status endpoint, and append your unique endToEndId to the end of the URL.

Example transaction status request
Curl
curl --request GET \
https://api-payments.J.P. Morganorgan.com/tsapi/v1/payments/status?endToEndId=QA03132368A

The following response shows a payment in PENDING status:

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

A rejected response includes an error code, a description, and a rule definition to help identify the reason for the request failure. The example below illustrates a payment with a REJECTED status. It also features an additional field, externalCode, which is relevant only for rejections occurring at the clearing level.

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

Interac e-Transfer supports the following response types:

Interac e-Transfer 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.

REJECTED

The request failed J.P. Morgan controls (for example, sanctions, funds control, qualification), or the request was rejected by the Interac Network 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.

Learn how to initiate a payment request.

Next steps