Skip to main content
Beta version available

The Global Payments 2 API is available in Beta. Please reach-out to our team to begin your integration.

Get the status of an Interac e-Transfer payment request

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

  • Use the endToEndId (Mandatory) and firmRootId (optional) to check and confirm the status of your request.
  • Interpret Interac e-Transfer response types.

Before you begin

To retrieve the status of an Interac e-Transfer 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-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 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 REJECTED status with an additional field, externalCode, applicable only to rejections 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 multiple response types, including PENDING, REJECTED, WAREHOUSED, COMPLETED, and RETURNED. The below table explains these response types in more detail:

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 (e.g., 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