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. 

Payment parameters

Disclaimer

These payment parameters are subject to change as we test the beta release of Global Payments 2 API. 

This page provides information about the fields to initiate an Interac e-Transfer® payment request. You must include all required fields to initiate a successful payment. The conditional and optional fields provide additional functionality, and aren't required to initiate a successful payment. 

Tip

This page serves as an overview of required fields. For all available fields including every conditional and optional field, refer to the API specification.

Required

The following table contains the required payment parameters to initiate an Interac e-Transfer payment:

Required payment parameters to initiate an Interac e-Transfer payment
Field
 Description
 Minimum
 Maximum
 Notes
requestedExecutionDate The requested execution date. 10
 10
  • Must be formatted as YYYY-MM-DD. 
  • Can be dated from one day in the past to five days in the future based on the current day and Eastern Time zone.
paymentIdentifiers.endToEndId
 The payment’s unique end-to-end ID that's assigned by the sender. 1
 35 
  
value.currency
 The value's currency. 3 3 Must be CAD.
value.amount The value's amount. 1 8
  • Numeric characters only.
  • Maximum of two decimal points.
  • Must be a value from 0.01 to 25000.00.
transferType
 The transfer type. 6
 6
 Must be CREDIT.
paymentType
 The payment type.

7

7

 Must be INTERAC.

debtor.account.accountNumber

The debtor's account number.

1

19

debtor.name

The debtor's name.

1

30

debtorAgent.financialInstitutionIds[].id

 The debtor agent's financial institution ID.

8

8

Must be CHASCATT.
debtorAgent.financialInstitutionIds[].idType
 The debtor agent's financial institution ID type.

3

3

 Must be BIC.

creditor.name

The creditor's name.

1

30

creditor.postalAddress.country

The creditor's country.

2

2

Must be CA.
creditor.countryOfResidence The creditor's country of residence. 2 2 Must be CA.
paymentPurpose.purpose.code The payment's purpose code.

4

4

 For supported values, see Purpose codes.

Conditional

The following table contains the conditional payment parameters to initiate an Interac e-Transfer payment:

Conditional payment parameters to initiate an Interac e-Transfer payment
Field Description Minimum Maximum Notes
creditor.account.accountNumber The creditor's account number. 10 35
  • Must be formatted as aaa-bbbbb-cccccccccccccccccccccccc where aaa is the three-digit bank ID, bbbbb is the five-digit transit number, and cccccccccccccccccccccccc is the account number up to 24 digits.
  • If the account number contains leading zeros, they must be removed.
creditor.account.alternateAccountIdentifiers.identifier The creditor's alternate account ID. 10 256 RegEx
creditor.account.alternateAccountIdentifiers.proprietarySchemeName The type of proxy account.  4 35
  • If account.alternateAccountIdentifiers.[].idType is set to PROPRIETARY, this field is required.
  • Must be EMAL or TELI.
additionalParties.ultimateDebtor.name

The ultimate debtor's name.

1

140

  
additionalParties.ultimateDebtor.postalAddress.type The ultimate debtor's postal address type. 4 4

Must be one of the following:

  • ADDR for a complete postal address
  • BIZZ for a business address
  • DLVY for a DeliveryTo address 
  • HOME for a residential address
  • MLTO for a MailTo address
  • PBOX for a PO box address

additionalParties.ultimateDebtor.postalAddress.buildingNumber

The ultimate debtor's building number.

1

16

  

additionalParties.ultimateDebtor.postalAddress.streetName

The ultimate debtor's street name.

1

70

  

additionalParties.ultimateDebtor.postalAddress.countrySubDivision

 The ultimate debtor's country subdivision. 0 35 Can't contain special characters.
additionalParties.ultimateDebtor.postalAddress.country The ultimate debtor's country. 2 2
  
secureVerification.key The secure verification key. 1 40
  • The sender can identify the challenge question and response for the beneficiary to authenticate and claim payments.
  • The security question can be sent as clear text, but the response needs to follow a pseudocode.
secureVerification.secret The secure verification key answer. 1 64

If a security question is provided, the appropriate hashed response must be provided. For example: "key": "what is your policy number?"; "secret": "UrWh9hQ3Ng68IY="
paymentExpiresAt The payment's expiration date. 24 24
  • If provided, must be from the next calendar day to 30 calendar days from the current date.
  • If not provided, defaults to 30 calendar days from the current date.
  • Must be formatted as YYYY-MM-DDThh:mm:ss+/-time offset to UTC.

Optional

The following table contains an optional payment parameter to initiate an Interac e-Transfer payment:

Optional payment parameters to initiate an Interac e-Transfer payment
Field Description Minimum Maximum Notes
creditor.postalAddress.type The creditor's postal address type. 4 4

Must be one of the following:

  • ADDR for a complete postal address
  • BIZZ for a business address
  • DLVY for a DeliveryTo address 
  • HOME for a residential address
  • MLTO for a MailTo address
  • PBOX for a PO box address
creditor.postalAddress.buildingNumber  The creditor's building number. 1 16  
creditor.postalAddress.streetName The creditor's street name. 1 70  
creditor.postaladdress.postalCode The creditor's postal code. 1 16  
creditor.postalAddress.countrySubDivision The creditor's country subdivision. 1 35  
remittanceInformation.unstructuredInformation.text Unstructured information 1 140  

For more information about Interac e-Transfer, see Overview.

Next steps

Learn about the supported values and resources for Interac e-Transfer payment parameters.