VOvopay
Interac Endpoints

interac/email/add

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.

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

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

RecipientNamestring required

The name of the recipient associated with this email

ClientAccountIDstring

Client Account ID

RecipientEmailAddressstring

The Email address to be associated with the account.

RecipientPhoneNumberstring

The Phone number to be associated with the account.

Currencystring

3 character currency code. If this is not specified the email will use the account's local currency (CAD).

Questionstring

Security question for this email address.

Answerstring

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.

Messagestring

An optional message to associate with the email address.

Languagestring

Recipient's language preference. Accepted values: en (English as the default) or fr (French).

ClientReferenceNumberstring

An optional reference number to associate with the transactions

ClientControlledboolean

When set to true, the connected email will be linked to your VoPay account. Default is false.

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

Tokenstring required

The token associated with the email record

Example response

{
  "Success": true,
  "Token": "1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"
}

Changes

No recorded changes to this operation across all 1 revision of this API.