Global Payments

Payment parameters

This topic outlines the required fields for making an Interac e-Transfer payment. All required fields must be included for a request to be successful, while optional fields add extra functionality to the 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`	Enter the payment amount using numeric characters only, without a currency symbol. The amount must be greater than 0.01 and can have up to two decimal places. The maximum allowable payment amount is 25,000.00.
`payments.transferType`	All Interac e-Transfer transactions must use `CREDIT`.
`payments.debtor.debtorName`	The sender's name, which will be used in the issuer notifications sent to the recipient.
`payments.debtor.debtorAccount.accountId`	Provide the client's CAD account number with J.P. Morgan. No leading zeros allowed.
`payments.debtorAgent.financialInstitutionId.bic`	Provide the financial institution identifier of the sender. Always use `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's country code.
`payments.creditor.countryOfResidence`	Beneficiary’s country of residence.

Conditional fields

TP3/MSB/OBO fields

The following fields are required when the Interac e-Transfer is made by a third-party payment provider, money service business, or 'on behalf of' another entity.

Conditional fields for third-party payment provider, money service business or ‘on behalf of’
JSON field name	Description
`payments.debtor.ultimateDebtor.ultimateDebtorName`	Name of the ultimate sender.
`payments.debtor.ultimateDebtor.postalAddress.townName`	City or town of the ultimate sender address.
`payments.debtor.ultimateDebtor.postalAddress.country`	ISO 2-digit standard country code of the 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`	Provide a fully formed bank account number in the following format: 3-digit Bank ID, 5-digit Transit ID, and 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}. For example, +1-416-000-0000 String length up to 30 characters. Email: Must correspond to RFC822/2822. For details, see http://www.ietf.org/. Must be at least five characters in length (for example, 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`	Expiration date of the regular payment.
`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 the secureVerification.key field. For more details, see Security Question and Response.
`payments.purpose.code`	Underlying reason for payment. For details, see Purpose Codes.

Including the following fields is beneficial for sanctions and anti-money laundering screening conducted during the Interac e-Transfer payment process.

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 the ultimate sender.
`payments.debtor.ultimateDebtor.postalAddress.streetName`	Street name of the ultimate sender address.
`payments.debtor.ultimateDebtor.postalAddress.buildingNumber`	Building number of the ultimate sender address.
`payments.debtor.ultimateDebtor.postalAddress.postalCode`	ZIP or postal code of the ultimate sender address.
`payments.debtor.ultimateDebtor.postalAddress.countrySubDvsn`	State or province of the recipient's address.

Next steps

Review Interac e-Transfer resources.