Skip to main content
Note

CBPR+ fields are available in mock responses for select endpoints. Preview supported scenarios in the API specification for Global Payments 2. Learn more in our blog.

Get the details of a Zelle® Disbursement

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

Before you begin

To get the details of a Zelle® Disbursement request, you need the following:

Send a request

From your command line, send a GET request to the /payments/{paymentId} endpoint.

For example, the following code snippet contains a cURL command that gets the details of a Zelle® Disbursement.

Example of a request to get the details of a Zelle® Disbursements payment that uses an email address
curl --request GET \
  --url https://api-mock.payments.jpmorgan.com/payment/v2/payments/7a20f818-2144-4f76-919a-256d54b608e  \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p'

A successful response contains the payment's status. 

For example, the following code snippet contains a response to the previous cURL command to get the details of a Zelle® Disbursement request. It's formatted in JSON so that it's easier to see.

Example of a response to a successful request to get the details of a Zelle® Disbursements payment that uses an email address
{
    "payments": [
        {
            "requestedExecutionDate": "2024-10-01",
            "paymentIdentifiers": {
                "endToEndId": "pflypSXGOjCVejwf"
            },
            "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-256d54b608e7",
            "paymentSubStatus": "PROCESSING_BY_JPM",
            "statusUpdatedAt": "2025-03-21T15:38:32Z"
        }
    ]
}