API Reference

Supported Operations

Money Request (request funds from a customer)
Bulk Payout (send funds to a recipient)
Cancellation requests
Inbound e-Transfer retrieval
Auto-deposit status

Endpoints

Create Money Request

POST /api/v2/interac/money-request

Sends an Interac e-Transfer money request to a customer's email address. The customer receives an email and can choose to accept or decline.

Request Parameters

Parameter	Type	Required	Description
Amount	decimal	Yes	Request amount in CAD
Currency	string	Yes	Must be `CAD`
RecipientName	string	Yes	Name of the person being requested to send funds
EmailAddress	string	Conditional	Recipient's email address. Required if no token is provided
Token	string	Conditional	Tokenized contact with pre-filled banking/email info
FirstName	string	Optional	Customer's first name
LastName	string	Optional	Customer's last name
DOB	string	Optional	Customer's date of birth (YYYY-MM-DD)
PhoneNumber	string	Optional	Customer's phone number
Address1	string	Optional	Customer's street address
Address2	string	Optional	Address line 2
City	string	Optional	Customer's city
Province	string	Optional	Customer's province
Country	string	Optional	Customer's country
PostalCode	string	Optional	Customer's postal code
IPAddress	string	Optional	Customer's IP address
MessageForRecipient	string	Optional	Message shown to the recipient in the e-Transfer email
GenerateURL	boolean	Optional	If true, returns a URL the customer can use to complete the transfer
ClientAccountID	string	Optional	Link transaction to a sub-account
ContactID	string	Optional	Link transaction to a contact
WalletID	string	Optional	Destination wallet ID
ClientReferenceNumber	string	Optional	Your internal reference number
TransactionTypeCode	string	Optional	Transaction type code
GLCode	string	Optional	General ledger code
Notes	string	Optional	Internal notes
IdempotencyKey	string	Optional	Unique key to prevent duplicate transactions
KYCPerformed	boolean	Optional	Indicates KYC was performed externally
KYCReferenceNumber	string	Optional	Reference number from external KYC

Get Money Request Transaction

GET /api/v2/interac/money-request/transaction

Returns details of a single Interac money request transaction.

Request Parameters

Parameter	Type	Required	Description
TransactionID	string	Yes	The transaction ID returned from `/interac/money-request`

Cancel Money Request

POST /api/v2/interac/money-request/transaction/request-cancellation

Requests cancellation of a pending Interac money request.

Request Parameters

Parameter	Type	Required	Description
TransactionID	string	Yes	The transaction ID to cancel

Create Bulk Payout

POST /api/v2/interac/bulk-payout

Sends funds to a recipient via Interac e-Transfer. The recipient receives an email or SMS notification and must accept the transfer.

Request Parameters

Parameter	Type	Required	Description
Amount	decimal	Yes	Payout amount in CAD
Currency	string	Yes	Must be `CAD`
RecipientName	string	Yes	Name of the person receiving funds
EmailAddress	string	Conditional	Recipient's email address. Required if `PhoneNumber` is not provided
PhoneNumber	string	Conditional	Recipient's phone number. Required if `EmailAddress` is not provided. Cannot be used together with `EmailAddress`
Question	string	Conditional	Security question the recipient must answer. Required if auto-deposit is not enabled for the recipient
Answer	string	Conditional	Answer to the security question. Required if `Question` is provided
FirstName	string	Optional	Recipient's first name
LastName	string	Optional	Recipient's last name
DOB	string	Optional	Recipient's date of birth (YYYY-MM-DD)
Address1	string	Optional	Recipient's street address
Address2	string	Optional	Address line 2
City	string	Optional	Recipient's city
Province	string	Optional	Recipient's province
Country	string	Optional	Recipient's country
PostalCode	string	Optional	Recipient's postal code
IPAddress	string	Optional	Recipient's IP address
SenderName	string	Optional	Name displayed as the sender
Language	string	Optional	Language for the e-Transfer notification (`en` or `fr`)
Memo	string	Optional	Memo shown to the recipient
HashSalt	string	Optional	Custom salt for answer hashing
CancellationPeriod	integer	Optional	Number of days before the transfer auto-cancels if unclaimed
GenerateURL	boolean	Optional	If true, returns a URL the recipient can use to accept the transfer
Token	string	Optional	Tokenized contact
ClientAccountID	string	Optional	Link transaction to a sub-account
ContactID	string	Optional	Link transaction to a contact
WalletID	string	Optional	Source wallet ID
ClientReferenceNumber	string	Optional	Your internal reference number
TransactionTypeCode	string	Optional	Transaction type code
GLCode	string	Optional	General ledger code
Notes	string	Optional	Internal notes
IdempotencyKey	string	Optional	Unique key to prevent duplicate transactions
ParentTransactionID	string	Optional	ID of a parent transaction to link this to
KYCPerformed	boolean	Optional	Indicates KYC was performed externally
KYCReferenceNumber	string	Optional	Reference number from external KYC

Get Bulk Payout Transaction

GET /api/v2/interac/bulk-payout/transaction

Returns details of a single Interac bulk payout transaction.

Request Parameters

Parameter	Type	Required	Description
TransactionID	string	Yes	The transaction ID returned from `/interac/bulk-payout`

Cancel Bulk Payout

POST /api/v2/interac/bulk-payout/transaction/request-cancellation

Requests cancellation of a pending Interac bulk payout.

Request Parameters

Parameter	Type	Required	Description
TransactionID	string	Yes	The transaction ID to cancel

Get Inbound Transactions

GET /api/v2/interac/inbound/transaction

Returns a list of inbound Interac e-Transfers received by the account.

Request Parameters

Parameter	Type	Required	Description
StartDate	string	Optional	Filter by start date (YYYY-MM-DD)
EndDate	string	Optional	Filter by end date (YYYY-MM-DD)

Get Auto-Deposit Status

GET /api/v2/interac/auto-deposit

Returns the current auto-deposit configuration for the account.

No additional parameters required.