VoPay Interac Endpoints API
The Interac Endpoints API from VoPay — 14 operation(s) for interac endpoints.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/vopay-interac-endpoints-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Vopay Interac Endpoints API
version: '2.0'
contact:
name: API Support
email: help@vopay.com
description: 'Operations tagged Interac Endpoints across 2 of this provider''s published API definitions: vopay-payment-method-api-reference.json, vopay-payment-rails-api-reference.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://earthnode-dev.vopay.com/api/v2
tags:
- name: Interac Endpoints
paths:
/interac/email/add:
post:
description: 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.
summary: interac/email/add
tags:
- Interac Endpoints
operationId: EmailAddPOST
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
RecipientName:
description: The name of the recipient associated with this email
type: string
ClientAccountID:
description: Client Account ID
type: string
RecipientEmailAddress:
description: The Email address to be associated with the account.
type: string
RecipientPhoneNumber:
description: The Phone number to be associated with the account.
type: string
Currency:
description: 3 character currency code. If this is not specified the email will use the account's local currency (CAD).
type: string
Question:
description: Security question for this email address.
type: string
Answer:
description: 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.
type: string
Message:
description: An optional message to associate with the email address.
type: string
Language:
description: 'Recipient''s language preference. Accepted values: en (English as the default) or fr (French).'
type: string
ClientReferenceNumber:
description: An optional reference number to associate with the transactions
type: string
ClientControlled:
description: When set to true, the connected email will be linked to your VoPay account. Default is false.
type: boolean
required:
- AccountID
- Key
- Signature
- RecipientName
required: true
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: ''
Token:
type: string
description: The token associated with the email record
example: 1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o
required:
- Success
- ErrorMessage
- Token
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/interac/email/edit:
post:
description: This endpoint allows you to update an Interac email associated with your VoPay account.
summary: interac/email/edit
tags:
- Interac Endpoints
operationId: EmailEditPOST
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
Token:
description: The Token associated with the email record you wish to update.
type: string
ClientAccountID:
description: Client Account ID
type: string
RecipientName:
description: The Email address to be associated with the account.
type: string
RecipientEmailAddress:
description: The Email address to be associated with the account.
type: string
RecipientPhoneNumber:
description: The Phone number to be associated with the account.
type: string
Question:
description: Security question for this email address.
type: string
Answer:
description: 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.
type: string
Message:
description: An optional message to associate with the email address.
type: string
Language:
description: 'Recipient''s language preference. Accepted values: en (English as the default) or fr (French).'
type: string
ClientReferenceNumber:
description: An optional reference number to associate with the transactions
type: string
ClientControlled:
description: When set to true, the connected email will be linked to your VoPay account. Default is false.
type: boolean
required:
- AccountID
- Key
- Signature
- Token
required: true
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: ''
Token:
type: string
description: The token associated with the email record
example: 1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o
required:
- Success
- ErrorMessage
- Token
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/interac/email/delete:
post:
description: This endpoint allows you to delete an Interac email associated with your VoPay account.
summary: interac/email/delete
tags:
- Interac Endpoints
operationId: EmailDeletePOST
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
Token:
description: The Token associated with the email record you wish to update.
type: string
ClientAccountID:
description: Client Account ID
type: string
required:
- AccountID
- Key
- Signature
required: true
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: ''
required:
- Success
- ErrorMessage
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/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
/interac/email/set-my-email:
post:
description: This endpoint allows you to identify an Interac email as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify an Interac email as being the VoPay account holder's default email. Note, a VoPay account can only have one default Interac email.
summary: interac/email/set-my-email
tags:
- Interac Endpoints
operationId: EmailSetMyEmailPOST
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
ClientAccountID:
description: Client Account ID
type: string
Token:
description: The Token associated with the email record you wish to update.
type: string
SetAsDefault:
description: Set the email record as default for this account.
type: boolean
required:
- AccountID
- Key
- Signature
required: true
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: ''
Token:
type: string
description: The token associated with the email record
example: 1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o
IsDefault:
type: boolean
description: The IsDefault status for the udpated record
example: true
required:
- Success
- ErrorMessage
- Token
- IsDefault
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/interac/email/default-email:
get:
description: This endpoint retrieves the default Interac email associated with your VoPay account.
summary: interac/email/default-email
tags:
- Interac Endpoints
operationId: EmailDefaultEmailGET
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: When provided, this endpoint will return the default email associated with this Client Account ID
schema:
type: string
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: ''
DefaultEmail:
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:
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
RecipientPaymentDetails:
type: string
description: The email address or phone number.
example: bob@gmail.com
Type:
type: string
description: 'The type of email record. Accepted values: email, phone'
example: email
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
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
DateAdded:
type: string
format: date-time
description: This timestamp indicates when the email record was added.
example: '2024-05-02 18:28:13'
required:
- Currency
- ClientControlledEmail
- RecipientName
- RecipientPaymentDetails
- Type
- Question
- Answer
- Language
- Message
- ClientReferenceNumber
- IsActive
- IsDefault
- Token
- DateAdded
x-list-of: inline
x-empty-when: no default email
required:
- Success
- ErrorMessage
- DefaultEmail
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/interac/auto-deposit:
get:
description: This endpoint is used to fetch Interac auto-deposit status.
summary: interac/auto-deposit
tags:
- Interac Endpoints
operationId: InteracAutoDepositGET
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: EmailAddress
in: query
required: true
description: The email address to fetch Interac auto-deposit status for.
schema:
type: string
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: ''
AutoDepositEnabled:
type: boolean
description: Whether auto deposits are enabled for the Interac account.
example: true
required:
- Success
- ErrorMessage
- AutoDepositEnabled
servers:
- url: https://earthnode-dev.vopay.com/api/v2
/interac/money-request:
post:
description: "This API endpoint is used to create a new Interac money request transaction.\n\n If a ClientAccountID is provided, the client account's first/last name, and email address will be used for the transaction."
summary: interac/money-request
tags:
- Interac Endpoints
operationId: InteracMoneyRequestPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
ClientAccountID:
description: Client Account ID
type: string
ContactID:
description: The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.
type: string
PhoneNumber:
description: Customer's phone number. (Digits only - no parentheses or dashes allowed.)
type: string
Address1:
description: Customer's address line 1
type: string
Address2:
description: Customer's address line 2
type: string
City:
description: Customer's city
type: string
Province:
description: Customer's province specified using two character abbreviations (eg. BC, AB)
type: string
Country:
description: Customer's country specified using full country name or ISO 3166-1 alpha-2 code.
type: string
PostalCode:
description: Customer's postal code.
type: string
Amount:
description: The amount to debit from the customer's bank account.
type: number
Currency:
description: '3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account''s local currency (generally CAD). NOTE: Currently the eft/fund API endpoint only supports CAD transactions.'
type: string
EmailAddress:
description: Email address the interac money request transaction was sent to.
# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vopay/refs/heads/main/openapi/vopay-interac-endpoints-api-openapi.yml