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

# interac/email/default-email

`GET /interac/email/default-email`

## Request

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

This endpoint retrieves the default Interac email associated with your VoPay account.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ClientAccountID` string

## 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
  - `DefaultEmail` 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
      - `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
      - `RecipientPaymentDetails` string, required: The email address or phone number.
      - `Type` string, required: The type of email record. Accepted values: email, phone
      - `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.
      - `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
      - `DateAdded` string, date-time, required: This timestamp indicates when the email record was added.

---

[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)