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 details of a Real-Time Payments request

In this tutorial, you will learn how to use the Global Payments API to retrieve the payment details of an RTP payment request. By the end of this tutorial, you will know how to use a paymentId to retrieve the transaction details of your payment request.

Before you begin

To retrieve the details of an RTP request, you will need the following:

A paymentId value for your payment request, which is provided in a successful payment response. 

Send a request

A successful response contains an paymentId value that can be used to retrieve the payment details of the payment request.  To do this, call a GET request to the /payments/paymentId endpoint.

Example of a RTP payment details request
Curl
curl --request GET \
  --url https://api-mock-payments.aws.jpmchase.net/payment/v2/payments/98275a2d-1e88-beed-6938-0521a7e0aesf \
  --header 'Accept: application/json' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p'

Confirm the response

A successful response contains the transaction details for your payment request:

Example of a successful RTP payment details response
Json
{
  "paymentId": "98275a2d-1e88-beed-6938-0521a7e0aesf",
  "paymentStatus": "COMPLETED",
  "paymentSubStatus": "COMPLETED",
  "statusUpdatedAt": "2024-10-15T14:15:22Z",
  "requestedExecutionDate": "2024-10-15",
  "paymentIdentifiers": {
    "endToEndId": "pl210g9t231r13541130"
  },
  "transferType": "CREDIT",
  "value": {
    "currency": "USD",
    "amount": "500"
  },
  "paymentType": "RTP",
  "debtor": {
    "name": "Paula Smitty",
    "account": {
      "accountNumber": "000678901234567",
      "accountType": "DDA"
    }
  },
  "debtorAgent": {
    "financialInstitutionIds": [
      {
        "id": "021000021",
        "idType": "USABA"
      }
    ]
  },
  "creditor": {
    "account": {
      "accountNumber": "000000034257284"
    },
    "name": "Clint Davos",
    "postalAddress": {
      "addressType": "ADDR",
      "streetName": "Cow Hollow",
      "buildingNumber": "65",
      "postalCode": "05483",
      "city": "San Francisco",
      "country": "US",
      "countrySubDivision": "SFO"
    }
  },
  "creditorAgent": {
    "financialInstitutionIds": [
      {
        "id": "071000013",
        "idType": "USABA"
      }
    ]
  },
  "additionalParties": {
    "ultimateDebtor": {
      "name": "Raj Patel",
      "individualIds": [
        {
          "individualId": "001"
        }
      ],
      "postalAddress": {
        "addressType": "ADDR",
        "streetName": "Hancock Ave",
        "buildingNumber": "121",
        "city": "Jersey City",
        "postalCode": "07302",
        "country": "US"
      },
      "dateAndPlaceOfBirth": {
        "birthDate": "1984-01-01",
        "city": "Hull",
        "country": "GB"
      }
    }
  },
  "remittanceInformation": {
    "unstructuredInformation": [
      {
        "text": "Payment for rustic vintage furniture"
      }
    ]
  }
}