--- updatedAt: 2026-07-07T16:41:47.000Z agentTools: projectIndex: https://docs.vopay.com/llms.txt --- # interac/email This endpoint retrieves a list of Interac emails associated with your VoPay account. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "2.0", "title": "Payment Methods", "description": "The Payment Methods API allows you to manage your payment methods. You can add, delete, and set default payment methods.", "contact": { "name": "API Support", "email": "help@vopay.com" } }, "paths": { "/interac/email": { "get": { "description": "This endpoint retrieves a list of Interac emails associated with your VoPay account.", "summary": "interac/email", "tags": [ "Interac Endpoints" ], "operationId": "EmailGET", "deprecated": false, "parameters": [ { "name": "AccountID", "in": "query", "required": true, "description": "Your account ID", "schema": { "type": "string" } }, { "name": "Key", "in": "query", "required": true, "description": "API key for the account", "schema": { "type": "string" } }, { "name": "Signature", "in": "query", "required": true, "description": "Hashed signature for the request", "schema": { "type": "string" } }, { "name": "ClientAccountID", "in": "query", "required": false, "description": "Client Account ID", "schema": { "type": "string" } }, { "name": "SearchText", "in": "query", "required": false, "description": "A text string to search for in the email addresses", "schema": { "type": "string" } }, { "name": "RecipientName", "in": "query", "required": false, "description": "The name of the recipient associated with this email", "schema": { "type": "string" } }, { "name": "RecipientEmailAddress", "in": "query", "required": false, "description": "The Email address to be associated with the account.", "schema": { "type": "string" } }, { "name": "RecipientPhoneNumber", "in": "query", "required": false, "description": "The Phone number to be associated with the account.", "schema": { "type": "string" } }, { "name": "ClientReferenceNumber", "in": "query", "required": false, "description": "An optional reference number to associate with the transactions", "schema": { "type": "string" } }, { "name": "ClientControlled", "in": "query", "required": false, "description": "When set to true, the connected email will be linked to your VoPay account. Default is false.", "schema": { "type": "boolean" } }, { "name": "Limit ", "in": "query", "required": false, "description": "Limit the number of records that are returned.", "schema": { "type": "integer" } }, { "name": "Offset ", "in": "query", "required": false, "description": "Use this parameter to set the starting point in the dataset.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "True if the request was successful, false if it failed", "example": true }, "ErrorMessage": { "type": "string", "description": "Contains a description of the error if the request failed", "example": "" }, "InteracEmails": { "type": "object", "description": "Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of email records", "properties": { "0": { "type": "object", "properties": { "ClientAccountID": { "type": "string", "description": "ClientAccountID attached to the email.", "example": "ClientAccount1" }, "Currency": { "type": "string", "description": "Currency associated with the email", "example": "CAD" }, "ClientControlledEmail": { "type": "string", "description": "Set to 1 if the email is linked to your VoPay account.", "example": "1" }, "RecipientName": { "type": "string", "description": "Recipient's name", "example": "Bob Smith" }, "RecipientEmailAddress": { "type": "string", "description": "The email address.", "example": "bob@gmail.com" }, "RecipientPhoneNumber": { "type": "string", "description": "The phone number.", "example": "123456789" }, "Question": { "type": "string", "description": "Security question for the transaction.", "example": "What color is the sky" }, "Answer": { "type": "string", "description": "Answer to the security question", "example": "blue" }, "Language": { "type": "string", "description": "The language preference for the email record. en (English) or fr (French)", "example": "en" }, "Message": { "type": "string", "description": "The message associated with the email address.", "example": "" }, "ClientReferenceNumber": { "type": "string", "description": "An optional reference number which was associated with the transaction.", "example": "ABC123" }, "RegisteredName": { "type": "string", "description": "The registered name for the Interac account. Will return 'N/A' if not available.", "example": "Bob Smith" }, "Alias": { "type": "string", "description": "The alias registered to the Interac account. Will return 'N/A' if not available.", "example": "bobsmith" }, "AutoDepositEnabled": { "type": "boolean", "description": "Determine if auto deposit is enabled or not. Will return 'N/A' if not available.", "example": true }, "CustomerType": { "type": "string", "description": "The customer type for the Interac account. Accepted values: RETAIL or CORPORATION. Will return 'N/A' if not available.", "example": "RETAIL" }, "TransactionLimit": { "type": "number", "description": "The transaction limit for the Interac account. Will return 'N/A' if not available.", "example": "1000.00" }, "IsActive": { "type": "string", "description": "Determine if the email is active or not", "example": "true" }, "IsDefault": { "type": "string", "description": "Determine if this is the default email for the given account or not", "example": "true" }, "Token": { "type": "string", "description": "The token associated with the email record", "example": "1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o" } }, "required": [ "ClientAccountID", "Currency", "ClientControlledEmail", "RecipientName", "RecipientEmailAddress", "RecipientPhoneNumber", "Question", "Answer", "Language", "Message", "ClientReferenceNumber", "RegisteredName", "Alias", "AutoDepositEnabled", "CustomerType", "TransactionLimit", "IsActive", "IsDefault", "Token" ] } }, "x-list-of": "inline", "x-empty-when": "no email records match" }, "Pagination": { "type": "object", "description": "Pagination metadata", "properties": { "TotalRecords": { "type": "string", "description": "Total number of email records in that search range.", "example": "1000" }, "Offset": { "type": "string", "description": "Use this parameter to set the starting point in the dataset.", "example": "1000" }, "Limit": { "type": "string", "description": "Limit the number of records that are returned.", "example": "1000" } }, "x-absent-when": "response uses PaginationMetaData", "required": [ "TotalRecords", "Offset", "Limit" ] } }, "required": [ "Success", "ErrorMessage", "InteracEmails" ] } } } } } } } }, "servers": [ { "url": "https://earthnode-dev.vopay.com/api/v2" } ] } ```