v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Interac Endpoints

interac/email

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

get/interac/email

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

Client Account ID

SearchTextstring

A text string to search for in the email addresses

RecipientNamestring

The name of the recipient associated with this email

RecipientEmailAddressstring

The Email address to be associated with the account.

RecipientPhoneNumberstring

The Phone number to be associated with the account.

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.

Limit integer

Limit the number of records that are returned.

Offset integer

Use this parameter to set the starting point in the dataset.

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

Example response

{
  "Success": true,
  "InteracEmails": {
    "0": {
      "ClientAccountID": "ClientAccount1",
      "Currency": "CAD",
      "ClientControlledEmail": "1",
      "RecipientName": "Bob Smith",
      "RecipientEmailAddress": "bob@gmail.com",
      "RecipientPhoneNumber": "123456789",
      "Question": "What color is the sky",
      "Answer": "blue",
      "Language": "en",
      "ClientReferenceNumber": "ABC123",
      "RegisteredName": "Bob Smith",
      "Alias": "bobsmith",
      "AutoDepositEnabled": true,
      "CustomerType": "RETAIL",
      "IsActive": "true",
      "IsDefault": "true",
      "Token": "1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"
    }
  },
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}