Beta version

Welcome to the beta version of the Global Payments 2 API! For the generally available Global Payments API, refer to Global Payments.

Resources

This page contains many of the supported values and resources for Interac e-Transfer® payment parameters.

Back-dated and future-dated transactions

Interac e-Transfer supports back-dated and future-dated transactions. Future-dated transactions are marked as SCHEDULED until the requested execution date and then released for continued processing.

The following table contains the supported past and future execution date ranges for Interac e-Transfer:

Past and future date ranges for *Interac* e-Transfer
Region	Country	Past date range	Future date range
North America (NA)	Canada	One calendar day	Five calendar days

Currency codes

A currency code identifies a payment’s currency.

The following table contains the supported currency code for Interac e-Transfer:

Currency codes for *Interac* e-Transfer
Region	Country	Currency code
NA	Canada	`CAD`

Duplicate logic

An Interac e-Transfer payment is irrevocable. If the same payment is sent twice, the status of the duplicate payment is rejected. To confirm the status of any payment, get the status of a Interac e-Transfer payment.

Duplicate transactions

The Global Payments API supports the ability for idempotent calls, which is useful when you initiate a payment, create a client, make a change, or retry a failed request for some reason, such as a network issue.

If an Interac e-Transfer payment has the same  endToEndId  and debtor.account.accountNumber as another Interac e-Transfer payment within the last 30 days, the Global Payments API deems it duplicative.

Payment options

Interac e-Transfer payments can be sent to a beneficiary's fully formed bank account number, email address, or Canadian mobile phone number.

The following table provides more information about each of these options:

Payment options for *Interac* e-Transfer
Payment option	Notes
Canadian bank account number	Available if beneficiary's bank participates in account number-based routing. Otherwise, the payment is rejected. Should include a bank ID, transit number, and account number. Account number shouldn't include leading zeroes.
Email address or Canadian mobile phone number	If a beneficiary didn't register an alias for Autodeposit, Interac e-Transfer requires the beneficiary to correctly answer a payment verification question and then select a financial institution to receive the deposit. The payment verification question and encrypted answer must be provided to J.P. Morgan in the payment request so that Interac can validate the response. In the meantime, the funds are deducted from your account. If the beneficiary correctly answers the question, a callback notification is sent to you. If the beneficiary incorrectly responds to the question, declines the payment, or lets the payment expire, the funds are restored to your account with a rejected callback. For more information, see Global Payments 2 status responses and error codes. If a beneficiary registered an alias for Autodeposit, Interac e-Transfer payments are directly deposited into the designated account. If a payment is sent to an invalid alias schema, the payment is rejected.

Payment validation question and response

You define the payment validation question and response when you send a payment to the beneficiary’s email address or Canadian mobile phone number. The question can be sent as clear text, but the response needs to follow the following pseudocode:

Answer to the security question (as provided by the customer) with leading and trailing whitespace trimmed, uppercased, postfixed with hashSalt, if present.
- Hashed using the algorithm identified by hashType and then Base64 encoded.
ISO-8859-1 encoding to be used when the hash is generated. A string up to 64 characters.
Original input (the answer) is a string up to 25 characters.
Single word with a minimum size of 3 characters. May include letters, digits, and/or hyphens, French characters.
Allowed characters in plain text answer: 0-9, a-z, hyphen.
- Both lower- and upper-case letters are allowed.
- Ensure a single word answer is created.
Following characters are not allowed:
- Characters that are not letters or digits, or hyphens. For example, http:, https:, JavaScript, function, return, any form of the string www.
Hashtype: Secure Hash Algorithm (SHA2)
Hashsalt: Contact your implementation manager. J.P. Morgan will provide the salt. As Hash salt can change over time period, please create provision to make the required change.
Security answer should be sent in the following way:
- Base 64(Sha-256(ISO-8859-1(Uppercase(answer))+Hashsalt))

Example

Question: What is your policy number?
- Answer: ABC123
Hash salt: 98765421
- Answer (encrypted): l88fqsH39/P2m7NaRZRB/Ko6DHXP2f24oNoFrBPhHyk=

Sample code for security responses

The following sample Java code illustrates the use of SHA2. The sample isn't created by J.P. Morgan and without warranty, doesn't include validation and exception handling that would be expected in production.

Sample Java code to generate and encode the password using SHA2 algorithm

Java

package com.acxsys.emt.interacServices;

import org.apache.commons.codec.binary.Base64; 
import java.io.UnsupportedEncodingException; 
import java.nio.charset.Charset; 
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException; 
import java.security.SecureRandom; 

/* * This is a sample Java code to generate password (such as Answer) using SHA2 */ 
public class SHA2Encoder {
private final static int SALT_BYTE_SIZE = 32; 

public static void main(String args[]){
String pwd = "testPwd";
String salt = null;
String encodedPwd = null;
Charset = Charset.defaultCharset();
System.out.println(" def charset:"+ charset.name());
try {
 salt = getSalt();
 encodedPwd = encodeSHA2(pwd.toUpperCase(), salt); 
              }
catch(Exception e){
 System.out.println(" Exception encoding pwd." +e.getMessage()); e.printStackTrace(); }
 System.out.println("encodedPwd: "+ encodedPwd); 
     } 
/* * This method will encode the password using SHA2 algorithm. The hash is encoded using charset ISO-8859-1 * */ 
public static String encodeSHA2(String password, String saltString) throws NoSuchAlgorithmException, UnsupportedEncodingException { 
MessageDigest md = MessageDigest.getInstance("SHA-256"); System.out.println("using salt: "+saltString); 
String encodedPwd= null;
encodedPwd = new String( Base64.encodeBase64( md.digest( (password+saltString).getBytes("ISO-8859-1") ) ) ,"ISO-8859-1"); 
System.out.println("encodedPwd: "+ encodedPwd); return encodedPwd;

Purpose codes

A purpose code identifies a payment's purpose and ensures compliance with regulatory requirements.

The following table contains the supported purpose codes for Interac e-Transfer:

Purpose codes for *Interac* e-Transfer
Region	Country	Purpose code	Name	Description
NA	Canada	`BONU`	BonusPayment	Payment of a bonus.
		`CASH`	CashManagementTransfer	General cash-management instruction.
		`CBLK`	CardBulkClearing	Bulk settlement of card transactions that refers to a specific transaction file or other information, like a terminal ID, card acceptor ID, or other transaction details.
		`CCRD`	CreditCardPayment	Payment of a credit card.
		`CORT`	TradeSettlementPayment	Trade settlement, such as a foreign exchange deal or a securities transaction.
		`DCRD`	DebitCardPayment	Payment of a debit card.
		`DIVI`	Dividend	Payment of a dividend.
		`DVPM`	DeliverAgainstPayment	Notice to account servicer of forthcoming delivery against payment instruction.
		`EPAY`	Epayment	ePayment.
		`FCIN`	FeeCollectionAndInterest	Payment of fees and interest.
		`FCOL`	FeeCollection	Settlement of card transaction fees between two parties.
		`GP2P`	PersontoPersonPayment	Person-to-person (P2P) payment in which the sender and beneficiary are natural persons.
		`GOVT`	GovernmentPayment	Payment to or from a government department.
		`HEDG`	Hedging	Payment of a hedging operation.
		`ICCP`	IrrevocableCreditCardPayment	Reimbursement of a credit-card payment.
		`IDCP`	IrrevocableDebitCardPayment	Reimbursement of a debit-card payment.
		`INTC`	IntraCompanyPayment	Intra-company payment, or a payment between two companies that belong to the same group.
		`INTE`	Interest	Payment of interest.
		`LBOX`	LockboxTransactions	Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store.
		`LOAN`	Loan	Transfer of a loan to a borrower.
		`MP2B`	Commercial	Mobile person-to-business (P2B) payment.
		`MP2P`	Consumer	Mobile P2P payment.
		`OTHR`	OtherPayment	Other payment purpose.
		`PENS`	PensionPayment	Payment of a pension.
		`RPRE`	Represented	Collection used to represent previously reversed or returned direct debit transactions.
		`RRCT`	ReimbursementReceivedCreditTransfer	Reimbursement of a correctly received credit transfer for commercial reasons.
		`RVPM`	ReceiveAgainstPayment	Notice to account servicer of forthcoming reception against payment instruction.
		`SALA`	SalaryPayment	Payment of salaries.
		`SECU`	Securities	Payment of securities.
		`SSBE`	SocialSecurityBenefit	Payment of a Social Security benefit.
		`SUPP`	SupplierPayment	Payment to a supplier.
		`TAXS`	TaxPayment	Payment of taxes.
		`TRAD`	Trade	Payment of a trade finance transaction.
		`TREA`	TreasuryPayment	Payment related to treasury operations, such as a financial contract settlement.
		`VATX`	ValueAddedTaxPayment	Payment of value added tax.
		`WHLD`	WithHolding	Payment of withholding tax.
		`TAXR`	TaxRefund	Refund of a tax payment or obligation.
		`B112`	TrailerFeePayment	Payment of a United States mutual fund trailer fee (12b-1).
		`BR12`	TrailerFeeRebate	Payment of a United States mutual fund trailer fee (12b-1) rebate.
		`TLRF`	NonUSMutualFundTrailerFeePayment	Payment of any non-United States mutual fund trailer fee (retrocession). Use ISIN to determine onshore versus offshore designation.
		`TLRR`	NonUSMutualFundTrailerFeeRebatePayment	Payment of any non-United States mutual fund trailer fee (retrocession) rebate. Use ISIN to determine onshore versus offshore designation.
		`AIRB`	Air	Payment for air transport-related business.
		`BUSB`	Bus	Payment for bus transport-related business.
		`FERB`	Ferry	Payment for ferry-related business.
		`RLWY`	Railway	Payment for railway transport-related business.
		`TRPT`	RoadPricing	Payment to top-up prepaid card and electronic road pricing for the purpose of transportation.
		`CBTV`	CableTVBill	Payment of cable TV bill.
		`ELEC`	ElectricityBill	Payment of electricity bill.
		`ENRG`	Energies	Payment related to a utility operation.
		`GASB`	GasBill	Payment of gas bill.
		`NWCH`	NetworkCharge	Payment of network charges.
		`NWCM`	NetworkCommunication	Payment of network communication.
		`OTLC`	OtherTelecomRelatedBill	Payment of other telecom-related bill.
		`PHON`	TelephoneBill	Payment of telephone bill.
		`UBIL`	Utilities	Payment to common utility provider that provides gas, water, and/or electricity.
		`WTER`	WaterBill	Payment of water bill.
		`BOND`	Bonds	Securities Lending-Settlement of Bond.
		`CABD`	CorporateActions-Bonds	Securities Lending-Settlement of Corporate Actions: Bonds.
		`CAEQ`	CorporateActions-Equities	Securities Lending-Settlement of Corporate Actions: Equities.
		`CBCR`	CreditCard	Card Settlement-Settlement of Credit Card.
		`DBCR`	DebitCard	Card Settlement-Settlement of Debit Card.
		`DICL`	Diners	Card Settlement-Settlement of Diners.
		`EQTS`	Equities	Securities Lending-Settlement of Equities.
		`FLCR`	FleetCard	Card Settlement-Settlement of Fleet.
`EFTC`	LowValueCredit	Utilities-Settlement of Low-value Credit.
`EFTD`	LowValueDebit	Utilities-Settlement of Low-value Debit.
`MOMA`	MoneyMarket	Securities Lending-settlement of Money Market PCH.
`RAPI`	RapidPaymentInstruction	Instant Payments-Settlement of Rapid Payment Instruction (RPI).
`GAMB`	GamblingOrWageringPayment	General-Payment toward a purchase or winnings received from gambling, betting, or other wagering activities.
`LOTT`	LotteryPayment	General-Payment toward a purchase or winnings received from lottery activities.
`GAFA`	GovernmentFamilyAllowance	Salary and benefits allowance from government to support family.
`GAHO`	GovernmentHousingAllowance	Salary and benefits allowance from government to individuals to support housing.
`AMEX`	Amex	Card Settlement-Settlement of American Express transactions.
`SASW`	ATM	Card Settlement-Settlement of ATM transactions.
`AUCO`	AuthenticatedCollections	Utilities-Settlement of Authenticated Collections transactions.
`PCOM`	PropertyCompletionPayment	Final payment to complete the purchase of a property.
`PDEP`	PropertyDeposit	Payment of the deposit required toward the purchase of a property.
`PLDS`	PropertyLoanDisbursement	Payment of funds from a lender as part of the issuance of a property loan.
`PLRF`	PropertyLoanRefinancing	Transfer or extension of a property financing arrangement to a new deal or loan provider without a change in ownership of the property.
`COLL`	CollateralManagement	Relates to collateral management.
`SECL`	SecuritiesLending	Relates to securities lending.
`STMT`	Settlements	Relates to settlements.
`240`	ANN/REN Annuity
`260`	INV/PLA Investment
`308`	CCB/ACE Canada Child Benefit
`311`	OAS/SV Old Age Security
`318`	EI/AE Employment Insurance
`330`	INS/ASS Insurance
`370`	MTG/HYP Mortgage
`400`	RLS/LOY Rent/Leases
`430`	BPY/FAC Bill Payment
`452`	EXP/RDD Expense Payment
`460`	AP/CC Accounts Payable
`480`	DON/DON Donations

Sanctions screening

J.P. Morgan screens the remittance information and ultimate debtor information to comply with United States Office of Foreign Assets Control (OFAC) regulations, applicable non-United States sanctions, and national and international anti-terrorism laws.

Status responses

A status response identifies a payment’s status. A status response includes one or more sub-status responses that provide more information about a payment's status.

The following table provides the statuses, sub-statuses, and their descriptions for Interac e-Transfer:

Status responses for *Interac* e-Transfer
Status	Sub-status	Description
`Processing`	`Processing by J.P. Morgan`	The payment is being processed by J.P. Morgan.
`Processing`	`Scheduled`	The payment is scheduled for future execution.
`Rejected`	`Rejected`	The payment was rejected.
`Completed`	`Completed by J.P. Morgan`	The payment was fully processed.

Value-amount limits

A value-amount limit identifies the maximum amount of money permitted in a payment.

The following table contains each country’s supported value-amount limits for Interac e-Transfer:

Value-amount limits for *Interac* e-Transfer
Region	Country	Value-amount limit
NA	Canada	25000

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

Next steps

Learn how to initiate an Interac e-Transfer payment.