Skip to main content
Beta version available

The Global Payments 2 API is available in Beta. Please reach-out to our team to begin your integration.

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 the endToEndId 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:

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

Create and send a payment details request

A successful response contains an endToEndId value that can be used to retrieve the status of the payment request. 

Example request using endToEndId
Curl
curl --location 'https://api-mock.payments.jpmorgan.com/tsapi/v1/payments?endToEndId=pl210g9t231r13541130'

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

Example response using endToEndId
Json
{
  "paymentStatus": {
    "createDateTime": "2022-10-15T00:00:12.145",
    "status": "COMPLETED"
  },
  "payments": {
    "paymentIdentifiers": {
      "endToEndId": "pl210g9t231r13541130"
    },
    "requestedExecutionDate": "2022-10-15",
    "transferType": "CREDIT",
    "paymentType": "RTP",
    "paymentCurrency": "USD",
    "paymentAmount": 500,
    "debtor": {
      "debtorName": "Paula Smitty",
      "debtorAccount": {
        "accountId": "000123456789112",
        "accountType": "DDA"
      },
      "ultimateDebtor": {
        "ultimateDebtorName": "Jane Smith",
        "postalAddress": {
          "addressType": "ADDR",
          "streetName": "Hancock Ave",
          "buildingNumber": "121",
          "postalCode": "07302",
          "townName": "Jersey City",
          "country": "US",
          "countrySubDvsn": "Hudson"
        },
        "dateAndPlaceOfBirth": {
          "birthDate": "1984-01-01",
          "cityOfBirth": "Hull city",
          "countryOfBirth": "BR"
        },
        "individualId": {
          "id": "001"
        }
      }
    },
    "debtorAgent": {
      "financialInstitutionId": {
        "clearingSystemId": {
          "id": "021000021",
          "idType": "USABA"
        }
      }
    },
    "creditorAgent": {
      "financialInstitutionId": {
        "clearingSystemId": {
          "id": "071000013",
          "idType": "USABA"
        }
      }
    },
    "creditor": {
      "creditorName": "Jane Smithy",
      "postalAddress": {
        "addressType": "ADDR",
        "streetName": "Cow Hollow",
        "buildingNumber": "65",
        "postalCode": "05483",
        "townName": "San Francisco",
        "country": "US",
        "countrySubDvsn": "SFO"
      },
      "dateAndPlaceOfBirth": {
        "birthDate": "2001-01-12",
        "cityOfBirth": "London",
        "countryOfBirth": "UK"
      },
      "creditorAccount": {
        "accountId": "000000033255284"
      },
      "ultimateCreditor": {
        "ultimateCreditorName": "Paula Smitty",
        "postalAddress": {
          "addressType": "ADDR",
          "streetName": "Flint Ave",
          "buildingNumber": "89",
          "postalCode": "88793",
          "townName": "Los Angeles",
          "country": "US",
          "countrySubDvsn": "LAX"
        },
        "dateAndPlaceOfBirth": {
          "birthDate": "1999-04-01",
          "cityOfBirth": "Rio",
          "countryOfBirth": "BR"
        },
        "organizationId": {
          "id": "003"
        }
      }
    },
    "remittanceInformation": {
      "unstructuredInformation": [
        "Payment for rustic vintage furniture"
      ]
    }
  },
  "firmRootId": "98275a2d-1e88-beed-6938-0521a7e0aesf"
}

Next steps