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

# interac/email/add

`POST /interac/email/add`

## Request

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

This endpoint allows you to add an Interac email to your VoPay account. Optionally, you can use this enpoint to also set the email as default for the VoPay account.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `RecipientName` string, required: The name of the recipient associated with this email
  - `ClientAccountID` string: Client Account ID
  - `RecipientEmailAddress` string: The Email address to be associated with the account.
  - `RecipientPhoneNumber` string: The Phone number to be associated with the account.
  - `Currency` string: 3 character currency code. If this is not specified the email will use the account's local currency (CAD).
  - `Question` string: Security question for this email address.
  - `Answer` string: Answer to the security question. This can be either a plain text answer or a hashed answer. Hashed answers must have leading and trailing whitespace trimmed, be SHA2 hashed and Base64 encoded. If a hashed answer is provided, the HashSalt input is mandatory.
  - `Message` string: An optional message to associate with the email address.
  - `Language` string: Recipient's language preference. Accepted values: en (English as the default) or fr (French).
  - `ClientReferenceNumber` string: An optional reference number to associate with the transactions
  - `ClientControlled` boolean: When set to true, the connected email will be linked to your VoPay account. Default is false.

## 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
  - `Token` string, required: The token associated with the email record

---

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