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 an ACH payment

In this tutorial, you learn how to get the status of an ACH payment.

Tip

The Global Payments API supports callbacks for automatic status updates. 

Before you begin

To get the status of an ACH 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 the ACH payment information.

The following example shows how to send a GET request to the /payments endpoint with your paymentId to retrieve the status or full details of an ACH payment.

Retrieve RTP payment status

To get the status of an ACH payment, simply 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 status of an ACH payment in the United States
Curl
curl \
  --request GET \
  --url 'https://api.payments.jpmorgan.com/payment/v2/payments/{ ce445df7-d1af-4782-9144-2fcf04c944d8}' \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1121a3m5o6p'

The following response will include the current status of your RTP payment:

Example response to a successful request to get the status of an ACH payment in the United States
Json
{
  "paymentId": "ce445df7-d1af-4782-9144-2fcf04c944d8",
  "paymentStatus": "PROCESSING",
  "statusUpdatedAt": "2024-10-01T14:15:22Z",
  "requestedExecutionDate": "2024-10-01",
  "paymentIdentifiers": {
    "endToEndId": "E2E3000112CENDXX"
  },
  "transferType": "CREDIT",
  "paymentType": "ACH"
}

Retrieve ACH payment details (FULL view)

To get the full details of an ACH payment, send a GET request to the /payments endpoint and specify view=FULL.

Example of a request to get the FULL status or details of an ACH payment
Curl
curl \
  --request GET \
  --url  https://api.payments.jpmorgan.com/payment/v2/payments/{ ce445df7-d1af-4782-9144-2fcf04c944d8?view=FULL } \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1121a3m5o6p'

The following response will include all available details for your ACH payment:

Example of an RTP payment response (FULL)
Curl
{
  "paymentId": "c0d45df7-d1af-4782-9144-2fcf04c944d8",
  "paymentStatus": "PROCESSING",
  "statusUpdatedAt": "2024-10-01T14:15:22Z",
  "requestedExecutionDate": "2024-10-01",
  "paymentIdentifiers": {
    "endToEndId": "E2E3000112CCDXX"
  },
  "value": {
    "currency": "USD",
    "amount": "101.50"
  },
  "transferType": "CREDIT",
  "paymentType": "ACH",
  "paymentTypeInformation": {
    "serviceLevelCode": "NURG",
    "localInstrumentCode": {
      "code": "CCD"
    }
  },
  "debtor": {
    "name": "John Doe",
    "account": {
      "accountNumber": "123456789",
      "accountCurrency": "USD"
    },
    "postalAddress": {
      "country": "US"
    },
    "partyId": {
      "organizationIds": [
        {
          "organizationId": "1234567000",
          "schemeName": {
            "proprietary": "JPMCOID"
          }
        }
      ]
    }
  },
  "debtorAgent": {
    "financialInstitutionIds": [
      {
        "id": "021000021",
        "idType": "USABA"
      }
    ],
    "postalAddress": {
      "country": "US"
    }
  },
  "creditorAgent": {
    "financialInstitutionIds": [
      {
        "id": "021000021",
        "idType": "USABA"
      }
    ],
    "postalAddress": {
      "country": "US"
    }
  },
  "creditor": {
    "name": "Jane Doe",
    "account": {
      "accountNumber": "98765432"
    },
    "postalAddress": {
      "country": "US"
    }
  },
  "paymentPurpose": {
    "categoryPurpose": {
      "proprietary": "PAYROLL"
    }
  }
}