interac/email/add

post

https://earthnode-dev.vopay.com/api/v2/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.

Form Data

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

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200