interac/inbound/transaction/simulate

Sandbox only. Simulates an inbound Interac e-Transfer arriving on your account so the inbound flow can be tested end to end: the transaction is created exactly as a real transfer would be, your balance is credited by Amount, the inbound e-Transfer webhook fires and the transaction appears in GET /interac/inbound/transaction. Requires inbound e-Transfers to be enabled on the account. Calling this endpoint in production returns an error and creates nothing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

number
required

The CAD amount of the simulated transfer. Must be positive and at most 25000.00.

string
Defaults to Sandbox Sender

Name of the simulated sender.

string
Defaults to [email protected]

Email address of the simulated sender. When the account does not use client accounts, the transfer is credited to the contact with this email (created when missing), as a real transfer would be.

string

Client account to credit. Defaults to the primary client account when client accounts are enabled, otherwise to the contact resolved from SenderEmail.

string

The message the sender attached to the transfer. Stored as the transaction notes.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json