v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Interac Endpoints

interac/auto-deposit

This endpoint is used to fetch Interac auto-deposit status.

get/interac/auto-deposit

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

EmailAddressstring required

The email address to fetch Interac auto-deposit status for.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

AutoDepositEnabledboolean required

Whether auto deposits are enabled for the Interac account.

Example response

{
  "Success": true,
  "AutoDepositEnabled": true
}