Skip to main content
Beta version available

Discover the Global Payments 2 API, now available in beta!

Get the details of an Interac e-Transfer payment request

In this tutorial, you will learn how to use the Global Payments API to retrieve the payment details of an Interac e-Transfer 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 a an Interac e-Transfer 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": "2023-01-01T00:00:12.145",
    "status": "COMPLETED"
  },
    "payments": {
        "requestedExecutionDate": "2023-01-01",
        "paymentIdentifiers": {
            "endToEndId": "QA03132368A",
        },
        "paymentCurrency": "CAD",
        "paymentAmount": 5.06,
        "transferType": "CREDIT",
        "debtor": {
            "debtorName": "Paula Smitty",
           "debtorAccount": {
                "accountId": "4000011117"
            },
        },
        "debtorAgent": {
            "financialInstitutionId": {
                "bic": "CHASCATT"
            }
        },
        "creditor": {
            "creditorName": "Jane Smith",
            "creditorAccount": {
                "accountType": "INTERAC",
                                         "alternateAccountIdentifier": "+1-905-454-1234",
                                         "schemeName": {
                                                "proprietary": "TELI"
                                         }
            },
            "postalAddress": {
                "addressType": "ADDR",
                "streetName": "Blue Jays Street",
                "buildingNumber": "12",
                "postalCode": "11298",
                "townName": "Toronto",
                "countrySubDvsn": "Ontario",
                "country": "CA"
            },
            "countryOfResidence": "CA",
        },
        "remittanceInformation": {
            "unstructuredInformation": [
                "Payment for Invoice 123"
            ]
        },
        "purpose": {
            "code": "XXXX"
        },
        "secureVerification": [
            {
                "key": "what is your policy number?",
                "secret": "UrWh9hQ3Ng6U2+ZLJXfDI4fQbs6Ob3Cc5lf1zb3u8IY="
            }
        ],
        "paymentExpiryDate": "2023-01-20T20:32:36.611317600Z"
    },
                  "firmRootId": "98275a2d-1e88-beed-6938-0521a7e0aesf"
}

Next steps

Review the Interac e-Transfer payment parameters.