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 Push to Card payment

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

Tip

The Global Payments API supports callbacks for automatic status updates. 

Before you begin

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

  • A registered and fully onboarded Developer Account on the J.P. Morgan Payments Developer Portal.
  • An active project that provides you with the credentials to make a request.
  • A paymentId provided in a successful Push to Card payment response.

Send a request

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

The following example shows how to send a GET request to retrieve the status or full details of a Push to Card payment.

Retrieve Push to Card 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 of a request to get the SUMMARY status or details of a Push to Card payment
Curl
curl \
  --request GET \
  --url https://api.payments.jpmorgan.com/payment/v2/payments/{98275a2d-1e88-beed-6938-0521a7e0uptc} \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1121a3m5o6p'

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

Example of a Push to Card payment response (SUMMARY)
Json
{
  "paymentId": "98275a2d-1e88-beed-6938-0521a7e0uptc ",
  "paymentStatus": "PROCESSING",
  "statusUpdatedAt": "2024-10-30T14:15:22Z",
  "requestedExecutionDate": "2024-10-30",
  "paymentIdentifiers": {
    "endToEndId": "1lv9t9e02zg113154100"
  },
  "transferType": "CREDIT",
  "paymentType": "CARD"
}

Retrieve Push to Card payment details (FULL view)

To get the full details of a Push to Card payment, send a GET request to the /payments/{paymentId} endpoint and specify view=FULL:

Example of a request to get the FULL status or details of a Push to Card payment
Curl
curl \
  --request GET \
  --url https://api.payments.jpmorgan.com/payment/v2/payments/{98275a2d-1e88-beed-6938-0521a7e0uptc?view=FULL } \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1121a3m5o6p'

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

Example of a Push to Card payment response (FULL)
Json
{
  "paymentId": "98275a2d-1e88-beed-6938-0521a7e0uptc",
  "paymentStatus": "PROCESSING",
  "statusUpdatedAt": "2024-10-30T14:15:22Z",
  "requestedExecutionDate": "2024-10-30",
  "paymentIdentifiers": {
    "endToEndId": "1lv9t9e02zg113154100"
  },
  "transferType": "CREDIT",
  "value": {
    "currency": "USD",
    "amount": "750"
  },
  "paymentType": "CARD",
  "debtor": {
    "name": "John Doe",
    "account": {
      "alternateAccountIdentifiers": [
        {
          "identifier": "TESTIUS",
          "idType": "PROGRAM_ID"
        }
      ]
    }
  },
  "debtorAgent": {
    "financialInstitutionIds": [
      {
        "id": "CHASUS33",
        "idType": "BIC"
      }
    ]
  },
  "creditor": {
    "name": "Jane Doe",
    "account": {
      "card": {
        "pan": "4037110019999999",
        "expiryDate": "2207"
      }
    }
  },
  "remittanceInformation": {
    "unstructuredInformation": [
      {
        "text": "Invoice#012345"
      }
    ]
  }
}