Payment parameters

This page provides information on the required fields for making an Interac e-Transfer payment. All required fields must be included for a request to be successful, and optional (or non-required) fields add extra functionality to a request.

Tip

This page serves as an overview of required, optional and conditional fields. For detailed JSON specifications when constructing a request, refer to the API specification.

Required fields

Required fields for Interac e-Transfer payment initiation
JSON field name	Description
`payments.requestedExecutionDate`	The transaction execution date in ISO date format (YYYY-MM-DD). This value must be the current day based on the EST time zone.
`payments.paymentIdentifiers.endToEndId`	The unique payment identifier assigned by the client.
`payments.paymentCurrency`	The currency in which the client wants to make the payment (always in `CAD`).
`payments.paymentAmount`	The amount of the payment. Numeric characters only, no currency symbol. The amount must be greater than 0.01, with a maximum of two decimal places. The maximum payment amount is 25000.00.
`payments.transferType`	All Interac e-Transfer transactions must use `CREDIT`.
`payments.debtor.debtorName`	The sender name. This value will be used as the sender name in the issuer notifications sent to the recipient.
`payments.debtor.debtorAccount.accountId`	Client CAD account number with J.P. Morgan. No leading zeros.
`payments.debtorAgent.financialInstitutionId.bic`	The financial institution identifier of sender. Always send `CHASCATT`.
`payments.creditor.creditorName`	The name of the recipient. No special characters are allowed.
`payments.creditor.creditorAccount.accountType`	All Interac e-Transfer payments must use `INTERAC`.
`payments.creditor.postalAddress.country`	Beneficiary country code.
`payments.creditor.countryOfResidence`	Beneficiary’s country of residence.

Conditional fields

TP3/MSB/OBO fields

These fields are required when the Interac e-Transfer is made by a third-party payment provider, money service business or ‘on behalf of’.

Conditional fields for third-party payment provider, money service business or ‘on behalf of’
JSON field name	Description
`payments.debtor.ultimateDebtor.ultimateDebtorName`	Name of ultimate sender.
`payments.debtor.ultimateDebtor.postalAddress.townName`	City or town of ultimate sender address.
`payments.debtor.ultimateDebtor.postalAddress.country`	ISO 2-digit standard country code of ultimate sender.

Payment/creditor fields

Requests must include either Account Number Routing (ANR) or Alias fields.

ANR

Account Number Routing (ANR) conditional fields
JSON field name	Description
`payments.creditor.creditorAccount.accountID`	Fully formed bank account number: 3 digit Bank ID-5 digit Transit ID- Account Number. Must use ‘-‘ to separate out 3 values. No spaces. Leading zeros should be removed from the bank account.

Alias

Conditional fields for Alias fields
JSON field name	Description
`payments.creditor.creditorAccount.alternateAccountIdentifier`	The alternate account identifier is the creditor's email or mobile phone number used for alias based payments: Mobile phone: numbers should be in following format- pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} Ex +1-416-000-0000 String, length up to 30 characters. Email: Must correspond to RFC822/2822. See http://www.ietf.org/ for details. Must be at least five characters in length, i.e., a@b.c. Must have only one @ symbol. Must have at least one . symbol. Must have at least one alphanumeric. character on each side of the @ symbol. Must have at least one alphanumeric character on each side of each . symbol. French characters are not permitted.
`payments.creditor.creditorAccount.schemeName.proprietary`	Type of alias: `EMAL` or `TELI`.

Optional fields

Interac e-Transfer optional fields
JSON field name	Description
`payments.paymentExpiryDate`	Date when regular payment will expire.
`payments.remittanceInformation.unstructuredInformation`	Unstructured remittance information for the payment.
`payments.secureVerification.key`	Security question for alias-based payment. Must include `payments.secureVerification.secret` field if including in payment request. See Security Question and Response for more details.
`payments.secureVerification.secret`	Hashed response to security question. Must accompany secureVerification.key field See Security Question and Response for more details.
`payments.purpose.code`	Underlying reason for payment. See Purpose Codes.

These fields are optional when the Interac e-Transfer is made by a third-party payment provider, money service business or ‘on behalf of’.

Tip

These fields are beneficial to include for Sanctions and Anti-Money Laundering screening performed throughout the Interac e-Transfer payment.

Optional for third-party payment provider, money service business or ‘on behalf of’
JSON field name	Description
`payments.debtor.ultimateDebtor.postalAddress.addressType`	Type of address for ultimate sender.
`payments.debtor.ultimateDebtor.postalAddress.streetName`	Street name of ultimate sender address.
`payments.debtor.ultimateDebtor.postalAddress.buildingNumber`	Building number of ultimate sender address.
`payments.debtor.ultimateDebtor.postalAddress.postalCode`	ZIP or postal code of ultimate sender address.
`payments.debtor.ultimateDebtor.postalAddress.countrySubDvsn`	State or province of recipient address.

Next steps

Review Interac e-Transfer resources.