SupportDashboard
HomeGet StartedPaymentsCryptoComplianceChangelog

List Interac auto-deposit emails

List live registrations owned by your business, including registrations from the dashboard and the API. The API returns 10 records per page, ordered by last update time from newest to oldest. Deleted records are excluded. The response has a data array, links, and pagination metadata in meta. An empty result returns data: [] and meta.total: 0. API services must be enabled.

GETapi-prod.blaaiz.com/api/external/interac-auto-deposit-email

Authorization

oauth2ClientCredentials interac-auto-deposit-email:read
AuthorizationBearer <token>

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

In: header

Scope: interac-auto-deposit-email:read

Query Parameters

status?string

Filter by registration status.

Value in

  • "PENDING"
  • "PROCESSING"
  • "ACTIVE"
  • "BLOCKED"
search_term?string

Filter by email search text.

Lengthlength <= 255
page?integer

Page number. Each page contains at most 10 records.

Range1 <= value
Default1

Response Body

application/json

application/json

application/json

application/json

application/json

List Interac auto-deposit emails
curl --request GET \  --url 'https://example.com/api/external/interac-auto-deposit-email'
{  "data": [    {      "id": "01994c21-a4d0-7000-8000-123456789abc",      "email": "payments@example.com",      "status": "PENDING",      "created_at": "2026-09-16T10:00:00.000000Z",      "updated_at": "2026-09-16T10:00:00.000000Z"    }  ],  "links": {    "first": "https://api-prod.blaaiz.com/api/external/interac-auto-deposit-email?page=1",    "last": "https://api-prod.blaaiz.com/api/external/interac-auto-deposit-email?page=1",    "prev": null,    "next": null  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "links": [      {        "url": null,        "label": "&laquo; Previous",        "active": false      },      {        "url": "https://api-prod.blaaiz.com/api/external/interac-auto-deposit-email?page=1",        "label": "1",        "active": true      },      {        "url": null,        "label": "Next &raquo;",        "active": false      }    ],    "path": "https://api-prod.blaaiz.com/api/external/interac-auto-deposit-email",    "per_page": 10,    "to": 1,    "total": 1  }}

POSTRegister an Interac auto-deposit email

Submit an email for external setup by Blaaiz. API services must be enabled and your business must have a CAD wallet. The email must pass the same uniqueness checks as dashboard registration. A deleted business Interac registration does not reserve its email. This endpoint creates a PENDING request; it does not activate the email. The response contains the registration ID. You cannot set the status or register for another business. A repeated request with the same live email returns 422. Use the list endpoint to check the registration after an uncertain response. See [Interac Auto Deposits](/docs/guides/interac-auto-deposits) for setup and status webhooks.

GETGet an Interac auto-deposit email

Read one live registration owned by your business. Use the ID returned when you created or listed the registration. The response reflects the latest admin status update. An unknown ID, deleted record, or another business's record returns 404. API services must be enabled.