Skip to main content
Beta version

Welcome to the beta version of the Global Payments 2 API. For the generally available Global Payments API, see Global Payments

Global Payments

Get the status of a Zelle® Disbursement

In this tutorial, you learn how to get the status of a Zelle® Disbursement.

Before you begin

To get the status of a payment, you need the following:

Send a request

Request payloads for the Global Payments API contain optional and required fields. Use the paymentId to retrieve Zelle® payment information.

The following example shows how to send a GET request to retrieve the status or full details of a Zelle® Disbursement payment that uses an email address.

Retrieve Push to Wallet payment status

To get the status of a payment, send a GET request to the /payments endpoint with your paymentId. The response will be in SUMMARY view by default, though you may specify view=SUMMARY if preferred.

Example: request to get the SUMMARY status or details of a Zelle® Disbursement payment
Curl
curl \
  --request GET \
  --url https://api.payments.jpmorgan.com/payment/v2/payments/{7a20f818-2144-4f76-919a-25d645b608e7 } \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1121a3m5o6p'

The response will include the current status of your Push to Wallet payment:

Example of a Zelle® Disbursement response (SUMMARY)
Json
{
  "paymentId": "7a20f818-2144-4f76-919a-25d645b608e7",
  "paymentStatus": "PROCESSING",
  "paymentSubStatus": "PROCESSING_BY_JPM",
  "statusUpdatedAt": "2025-03-21T15:38:22Z",
  "requestedExecutionDate": "2024-10-01",
  "paymentIdentifiers": {
    "endToEndId": " PfJLyx5XG0jcvejwF "
  },
  "transferType": "CREDIT",
  "paymentType": "ZELLE"
}

Retrieve Push to Wallet payment details (FULL view)

To get the full details of a Push to Wallet payment, send a GET request to the same endpoint and specify view=FULL.

Example of a request to get the FULL status or details of a Zelle® Disbursement payment
Curl
curl \
  --request GET \
  --url https://api.payments.jpmorgan.com/payment/v2/payments/{7a20f818-2144-4f76-919a-25d645b608e7?view=FULL } \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1121a3m5o6p'

The response will include all available details for your Push to Wallet payment:

Example of a Zelle® Disbursement response (FULL)
Json
{
  "payments": [
    {
      "requestedExecutionDate": "2024-10-01",
      "paymentIdentifiers": {
        "endToEndId": "PfJLyx5XG0jcvejwF"
      },
      "value": {
        "currency": "USD",
        "amount": "10"
      },
      "transferType": "CREDIT",
      "paymentType": "ZELLE",
      "debtor": {
        "account": {
          "accountNumber": "123456789"
        },
        "name": "Alvin Chang"
      },
      "debtorAgent": {
        "financialInstitutionIds": [
          {
            "id": "CHASUS33",
            "idType": "BIC"
          }
        ]
      },
      "creditor": {
        "account": {
          "alternateAccountIdentifiers": [
            {
              "identifier": "Robert.brown@example.com",
              "idType": "EMAIL"
            }
          ]
        },
        "name": "Robert Brown",
        "postalAddress": {
          "addressLines": [
            "address line1",
            "address line2",
            "address line3",
            "address line4"
          ],
          "buildingNumber": "000",
          "streetName": "creditor street name",
          "postalCode": "60603",
          "city": "Creditor City Name",
          "countrySubdivision": "IL",
          "country": "US"
        }
      },
      "remittanceInformation": {
        "unstructuredInformation": [
          {
            "text": "Payment for catering facilities - INVC009887"
          }
        ]
      },
      "paymentStatus": "PROCESSING",
      "paymentId": "7a20f818-2144-4f76-919a-25d645b608e7",
      "paymentSubStatus": "PROCESSING_BY_JPM",
      "statusUpdatedAt": "2025-03-21T15:38:32Z"
    }
  ]
}