---
title: "interac/email"
method: GET
path: "/interac/email"
tags: ["Interac Endpoints"]
---

# interac/email

`GET /interac/email`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/interac/email`
- Auth: none declared

This endpoint retrieves a list of Interac emails associated with your VoPay account.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ClientAccountID` string
- `SearchText` string
- `RecipientName` string
- `RecipientEmailAddress` string
- `RecipientPhoneNumber` string
- `ClientReferenceNumber` string
- `ClientControlled` boolean
- `Limit ` integer
- `Offset ` integer

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `InteracEmails` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of email records
    - `0` object
      - `ClientAccountID` string, required: ClientAccountID attached to the email.
      - `Currency` string, required: Currency associated with the email
      - `ClientControlledEmail` string, required: Set to 1 if the email is linked to your VoPay account.
      - `RecipientName` string, required: Recipient's name
      - `RecipientEmailAddress` string, required: The email address.
      - `RecipientPhoneNumber` string, required: The phone number.
      - `Question` string, required: Security question for the transaction.
      - `Answer` string, required: Answer to the security question
      - `Language` string, required: The language preference for the email record. en (English) or fr (French)
      - `Message` string, required: The message associated with the email address.
      - `ClientReferenceNumber` string, required: An optional reference number which was associated with the transaction.
      - `RegisteredName` string, required: The registered name for the Interac account. Will return 'N/A' if not available.
      - `Alias` string, required: The alias registered to the Interac account. Will return 'N/A' if not available.
      - `AutoDepositEnabled` boolean, required: Determine if auto deposit is enabled or not. Will return 'N/A' if not available.
      - `CustomerType` string, required: The customer type for the Interac account. Accepted values: RETAIL or CORPORATION. Will return 'N/A' if not available.
      - `TransactionLimit` number, required: The transaction limit for the Interac account. Will return 'N/A' if not available.
      - `IsActive` string, required: Determine if the email is active or not
      - `IsDefault` string, required: Determine if this is the default email for the given account or not
      - `Token` string, required: The token associated with the email record
  - `Pagination` object: Pagination metadata
    - `TotalRecords` string, required: Total number of email records in that search range.
    - `Offset` string, required: Use this parameter to set the starting point in the dataset.
    - `Limit` string, required: Limit the number of records that are returned.

---

[API](https://skmtc.dev/vopay/apis/payment-methods.md) - [All operations](https://skmtc.dev/vopay/apis/payment-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-methods/revisions/b566c8002410?raw)