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 a Zelle® Disbursement

In this tutorial, you will learn how to use the Global Payments API to retrieve the status of a Zelle® Disbursement.

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

  • Use the endToEndId to check and confirm the status of your request.
  • Interpret Zelle® Disbursements response types.

Before you begin

To retrieve the status of a Zelle® Disbursement 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 --location 'https://api-mock.payments.jpmorgan.com/tsapi/v1/payments/status?endToEndId=1lv0t92e023g11354100'

The following response shows a payment in the PENDING status:

Example transaction status response: PENDING
Json
{
    "paymentStatus": {
        "createDateTime": "2023-10-18T01:52:35.000",
        "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, applicable only to rejections at the Clearing level.

Transaction status response: REJECTED
Json
{
    "paymentStatus": {
        "createDateTime": "2023-10-04T03:27:22.000",
        "status": "REJECTED",
        "exception": [
            {
                "errorCode": "11000",
                "errorDescription": "Amount of funds available to cover specified message amount is insufficient",
                "ruleDefinition": "Clearing/Regulatory failure",
                "externalCode": "AM04"
            }
        ]
    }
}

We recommend viewing the error codes section to understand supported responses. If you need additional support, contact your Client Service Account Manager.

Zelle® Disbursements supports multiple response types, including PENDING, REJECTED, and COMPLETED. For more information, see Response types.