v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Interac Endpoints

interac/email/default-email

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

get/interac/email/default-email

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

When provided, this endpoint will return the default email associated with this Client Account ID

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,
  "DefaultEmail": {
    "0": {
      "Currency": "CAD",
      "ClientControlledEmail": "1",
      "RecipientName": "Bob",
      "RecipientPaymentDetails": "bob@gmail.com",
      "Type": "email",
      "Question": "What color is the sky",
      "Answer": "blue",
      "Language": "en",
      "ClientReferenceNumber": "ABC123",
      "IsActive": "true",
      "IsDefault": "true",
      "Token": "1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o",
      "DateAdded": "2024-05-02 18:28:13"
    }
  }
}