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. 

Initiate an Interac e-Transfer payment

In this tutorial, you learn how to initiate an Interac e-Transfer® payment.

Before you begin

To initiate an Interac e-Transfer 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 bank account in the country from which you want to initiate a payment.

Send a request

From your command line, send a POST request to the /payments endpoint.

For example, the following code snippet contains a cURL command that initiates an Interac e-Transfer payment that uses an email address. It also contains the command's payload formatted in JSON so that it's easier to see.

Example of a request to initiate an Interac e-Transfer payment that uses an email address
curl --request POST \
  --url https://api-mock.payments.jpmorgan.com/payment/v2/payments \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 1b036f9c-8c84-4ce6-b1dd-5979472945a1' \
  --header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p' \
  --data '{
  "requestedExecutionDate": "2024-10-01",
  "paymentIdentifiers": {
    "endToEndId": "1lv0t92e023g11354102"
  },
  "transferType": "CREDIT",
  "value": {
    "currency": "CAD",
    "amount": "100"
  },
  "paymentType": "INTERAC",
  "debtor": {
    "name": "Karuppan Musics Ltd",
    "account": {
      "accountNumber": "012345678"
    }
  },
  "debtorAgent": {
    "financialInstitutionIds": [
      {
        "id": "CHASCATT",
        "idType": "BIC"
      }
    ]
  },
  "creditor": {
    "name": "Eva M",
    "account": {
      "alternateAccountIdentifiers": [
        {
          "identifier": "evamo@yahoo.ca",
          "idType": "PROPRIETARY",
          "proprietarySchemeName": "EMAL"
        }
      ]
    },
    "postalAddress": {
      "country": "CA"
    }
  },
  "paymentPurpose": {
    "purpose": {
      "code": "EPAY"
    }
  },
  "remittanceInformation": {
    "unstructuredInformation": [
      {
        "text": "Payment for Musical instrument Invoice 113390C-FF2"
      }
    ]
  }
}'

Confirm the response

Confirm that you receive a response that contains an endToEndId and a paymentId. You can use these values later to get the status and details of an Interac e-Transfer payment. 

For example, the following code snippet contains a response to the previous cURL command to initiate an Interac e-Transfer payment that uses an email address. It's formatted in JSON so that it's easier to see.

Example of a response to a successful request to initiate an Interac e-Transfer payment that uses an email address
Json
{
  "endToEndId": "1lv0t92e023g11354102",
  "paymentId": "98275a2d-1e88-beed-6938-0521a7e0cptc"
}

Next steps

Learn how to get the status of an Interac e-Transfer payment.