Skip to main content
Beta version

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

Get the status of a wire payment request

In this tutorial, you will learn how to use the Global Payments API to retrieve the status of an Wire payment request. By the end of this tutorial, you will know how to use an endToEndId to manually check and confirm the status of your request.

Tip

The Global Payments API supports callbacks for automatic status updates.

Before you begin

To retrieve the status of an Wire request, you will need the following:

An endToEndId value for your payment request, which is provided in a successful payment response. 

Send a 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 endpoint, appending your unique endToEndId to the query parameter of the call:

Example of a wire payment status request
Curl
curl --request GET \
  --url 'https://api-mock.payments.jpmorgan.com/payment/v2/payments?endToEndId=WUSFIT3000117&view=FULL&paymentType=WIRE' \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p'

Confirm the response

The following example shows a status response for a received transaction:

Example of a wire payment status response
Json
{
  "paymentId": "f672146b-d35d-4216-9d1e-08ad7e8019d1",
  "paymentStatus": "COMPLETED",
  "statusUpdatedAt": "2024-10-01T14:15:22Z",
  "requestedExecutionDate": "2024-10-01",
  "paymentIdentifiers": {
    "endToEndId": "WUSFIT3000117",
    "otherPaymentReferences": {
      "relatedReferenceId": "25725457",
      "uetr": "39d69da1-515d-48a2-b889-9baa75c32288"
    }
  },
  "transferType": "CREDIT",
  "paymentTypeInformation": {
    "serviceLevelCode": "URGP",
    "paymentContext": "FI"
  },
  "paymentType": "WIRE",
  "value": {
    "currency": "USD",
    "amount": "105000.80"
  },
  "debtor": {
    "name": "People's FinCorp, Inc",
    "account": {
      "accountNumber": "90009888765"
    }
  },
  "debtorAgent": {
    "financialInstitutionIds": [
      {
        "id": "021000021",
        "idType": "USABA"
      }
    ]
  },
  "creditorAgent": {
    "financialInstitutionIds": [
      {
        "id": "HSBCUS88XXX",
        "idType": "BIC"
      }
    ]
  },
  "creditor": {
    "account": {
      "accountNumber": "778000987786"
    },
    "name": "Wells Fargo",
    "partyId": {
      "organizationIds": [
        {
          "organizationId": "WLF890000",
          "bic": "WLUS9877"
        }
      ]
    }
  },
  "additionalParties": {
    "initiatingParty": {
      "organizationIds": [
        {
          "organizationId": "B8909997"
        }
      ]
    },
    "instructedAgent": {
      "id": "021000021",
      "idType": "USABA"
    }
  },
  "settlementInformation": {
    "settlementAccount": {
      "accountNumber": "115680009"
    }
  }
}

For a full list of supported status response types, see Global Payments 2 status responses and error codes.

Next steps

Learn how to initiate a payment request.