Skip to main content
Global Payments

Get the status of a Push to Wallet payment

In this tutorial, you learn how to get the status of a Push to Wallet payment.

Tip

The Global Payments API supports callbacks for automatic status updates. 

Before you begin

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

Send a request

Request payloads for the Global Payments API have optional and required fields. Use the paymentId to retrieve Push to Wallet payment information.

The following example shows how to send a GET request to retrieve the information for a Push to Wallet payment that uses a PayPal email address.

Retrieve Push to Wallet payment status (SUMMARY view)

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 of a request to get the SUMMARY status or details of a Push to Wallet payment
Curl
curl \
  --request GET \
  --url https://api.payments.jpmorgan.com/payment/v2/payments/{ b887bcaf-16b2-4e90-ace1-e54386cf4bd3 } \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1121a3m5o6p'

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

Example of a Push to Wallet payment response (SUMMARY)
Json
{
  "paymentId": " b887bcaf-16b2-4e90-ace1-e54386cf4bd3",
  "paymentStatus": "PROCESSING",
  "statusUpdatedAt": "2024-10-01T14:15:22Z",
  "requestedExecutionDate": "2024-10-01",
  "paymentIdentifiers": {
    "endToEndId": " PY202109022311354152"
  },
  "transferType": "CREDIT",
  "paymentType": "PAYPAL"
}

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 Push to Wallet payment
Curl
curl \
  --request GET \
  --url https://api.payments.jpmorgan.com/payment/v2/payments/{ b887bcaf-16b2-4e90-ace1-e54386cf4bd3?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 Push to Wallet payment response (FULL)
Json
{
  "paymentId": "b887bcaf-16b2-4e90-ace1-e54386cf4bd3",
  "paymentStatus": "PROCESSING",
  "statusUpdatedAt": "2024-10-01T14:15:22Z",
  "requestedExecutionDate": "2024-10-01",
  "paymentIdentifiers": {
    "endToEndId": "PY202109022311354152"
  },
  "transferType": "CREDIT",
  "value": {
    "currency": "USD",
    "amount": "10"
  },
  "paymentType": "PAYPAL",
  "debtor": {
    "name": "John Doe",
    "account": {
      "accountNumber": "123456789",
      "accountType": "DDA"
    }
  },
  "debtorAgent": {
    "financialInstitutionIds": [
      {
        "id": "CHASUS33",
        "idType": "BIC"
      }
    ]
  },
  "creditor": {
    "name": "Jane Doe",
    "account": {
      "alternateAccountIdentifiers": [
        {
          "identifier": "jane.doe@example.com",
          "idType": "PROPRIETARY",
          "proprietarySchemeName": "EMAIL"
        }
      ]
    },
    "postalAddress": {
      "postalCode": "67890",
      "country": "US"
    }
  },
  "paymentPurpose": {
   "purpose": {
     "proprietary": "GOODS"
   }
 },
 "remittanceInformation": {
   "unstructuredInformation": [
     {
       "text": "Payment - INVC009100"
     }
    ]
  }
}