openapi: 3.2.0 info: version: '2.0' title: Accounts Partner Endpoints API description: The Account API defines endpoints for managing VoPay accounts and sub-accounts. These endpoints allow partners to create and manage accounts, set permissions, handle transactions, schedule transfers, retrieve account information, and manage onboarding processes, ensuring secure and efficient account and transaction management. contact: name: API Support email: help@vopay.com servers: - url: https://earthnode-dev.vopay.com/api/v2 tags: - name: Partner Endpoints paths: /partner/account: post: description: This endpoint is used to create a VoPay account. You will need to sign-up as a partner account in order to use this endpoint and start creating VoPay accounts for your users. summary: partner/account tags: - Partner Endpoints operationId: AccountPOST 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 Name: description: Name of the person/company you are going to create an account for type: string EmailAddress: description: Email address of the person/company you are creating an account for type: string format: email Country: description: This is an opetional parameter specifying the country of the account. ISO abbreviation or full country name. If not provided, the account will inherit the country of the partner account. type: string ClientAccountsEnabled: description: This is an optional parameter to enable client accounts type: boolean ParentAccountID: description: Specify the parent account ID to create a sub account under this parent account type: string CreateVirtualAccount: description: It is a flag to allow user to decide if he wants to create a virtual account for the subaccount. By default this value is set as false. Must have VirtualAccounts enabled to use this parameter. type: boolean VopayAccountID: description: Optional custom account ID to assign to the new account being created type: string PrimaryContactName: description: Full name of the primary contact for the account type: string Address1: description: Street address line 1 for the account type: string Address2: description: Street address line 2 for the account type: string City: description: City of the account address type: string Province: description: Province or state of the account address type: string PostalCode: description: Postal or ZIP code of the account address type: string required: - AccountID - Key - Signature - Name - EmailAddress required: true responses: '200': description: '' 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: '' Message: type: string description: Contains a description of the successful message example: '' AccountID: type: string description: Account Name of the new user created in the endpoint example: AccountTest1 APISharedSecret: type: string description: API Shared Secret example: AbcDefGi+KlmnopQRSTu183== APIKey: type: string description: The API key for the sub account example: eddc0f5e37d20f98b486daf842447ec1f225f859 ApplicationID: type: string description: The onboarding application ID. Only applicable if the account is created in 'Application Pending' status example: '213086325897' Link: type: string description: The onboarding application link. Only applicable if the account is created in 'Application Pending' status example: https://onboarding-app-dev.vopay.com required: - Success - ErrorMessage - Message - AccountID - APISharedSecret - APIKey - ApplicationID - Link get: description: This endpoint is used to get a list of accounts created using a partner account. It will return the accounts data including shareholder, signing authority and balance information summary: partner/account tags: - Partner Endpoints operationId: AccountGET 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: '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 - name: IncludeBalances in: query required: false description: When true, includes balance data for each account. Defaults to true. schema: type: boolean - name: IncludeExtendedInfo in: query required: false description: When true, includes signing authorities, beneficial owners, and other KYC fields for each account. Defaults to true. schema: type: boolean - name: IncludeChildAccounts in: query required: false description: When true, includes nested sub-accounts for each account. Defaults to true. schema: type: boolean responses: '200': description: '' 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: '' PartnerAccount: type: string description: Partner account name example: ParentAccount1 Accounts: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: LegalBusinessName: type: string description: Legal Business Name example: Company Legal Business Name DBAName: type: string description: Doing Business As Name example: Doing Business As Name AccountName: type: string description: Account name of the account example: SubaccountName1 ParentAccountName: type: string description: Parent account name. This will only be populated if the account is a sub-account example: ParentAccount1 AccountID: type: string description: Account ID of the account example: Subaccount1 OrginatorName: type: string description: Short Name of the company to identify themselves in the documents example: '' OriginatorShortName: type: string description: Short Name of the company to identify themselves in the documents (max 15 chars) example: '' Email: type: string format: email description: Account email address example: subaccount.mail@email.com Phone: type: integer description: Account's phone number example: 604556**** Fax: type: string description: Account's fax number example: 604556**** City: type: string description: Account's city example: Vancouver Province: type: string description: Account's province specified using two character abbreviation (eg. BC, AB) example: BC Country: type: string description: Account's country specified using full country name or ISO 3166-1 alpha-2 code. example: Canada PostalCode: type: string description: Account's postal code. example: V2W 4V6 Address: type: string description: Account's address line example: 112 Bentall Street FlinksUrl: type: string description: The Flinks URL example: https://www.mycompany.com/flinks-url WebhookUrl: type: string description: URL where the users want us to send their notifications. See Webhooks attribute for full list. example: https://www.mycompany.com/webhook-listener Webhooks: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: Event: type: string description: 'The type of webhook notification the users wish to receive. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction.' example: '' Url: type: string description: Webhook URL, is the url is not setup it will return empty example: '' required: - Event - Url x-list-of: inline x-empty-when: no items ParentAccounts: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: AccountID: type: string description: Account ID of the account example: acme_inc AccountName: type: string description: Account name of the account example: ACME Inc. ParentAccountID: type: string description: The parent account ID of the account example: acme_llc required: - AccountID - AccountName - ParentAccountID x-list-of: inline x-empty-when: no items SubAccounts: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: LegalBusinessName: type: string description: Legal Business Name example: Company Legal Business Name DBAName: type: string description: Doing Business As Name example: Doing Business As Name AccountName: type: string description: Account name of the account example: SubaccountName1 ParentAccountName: type: string description: Parent account name. This will only be populated if the account is a sub-account example: ParentAccount1 AccountID: type: string description: Account ID of the account example: Subaccount1 OrginatorName: type: string description: Short Name of the company to identify themselves in the documents example: '' OriginatorShortName: type: string description: Short Name of the company to identify themselves in the documents (max 15 chars) example: '' Email: type: string format: email description: Account email address example: subaccount.mail@email.com Phone: type: integer description: Account's phone number example: 604556**** Fax: type: string description: Account's fax number example: 604556**** City: type: string description: Account's city example: Vancouver Province: type: string description: Account's province specified using two character abbreviation (eg. BC, AB) example: BC Country: type: string description: Account's country specified using full country name or ISO 3166-1 alpha-2 code. example: Canada PostalCode: type: string description: Account's postal code. example: V2W 4V6 Address: type: string description: Account's address line example: 112 Bentall Street FlinksUrl: type: string description: The Flinks URL example: https://www.mycompany.com/flinks-url WebhookUrl: type: string description: URL where the users want us to send their notifications. See Webhooks attribute for full list. example: https://www.mycompany.com/webhook-listener Webhooks: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: Event: type: string description: 'The type of webhook notification the users wish to receive. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction.' example: '' Url: type: string description: Webhook URL, is the url is not setup it will return empty example: '' required: - Event - Url x-list-of: inline x-empty-when: no items IsActive: type: boolean description: Is the account active example: true GCMEnabled: type: boolean description: Permission related to Global cash management example: true EFTCollectEnabled: type: boolean description: Permission related to EFT Fund example: true EFTSendEnabled: type: boolean description: Permission related to EFT Withdraw example: true USDEFTCollectEnabled: type: boolean description: Permission related to EFT Fund using USD currency example: true USDEFTSendEnabled: type: boolean description: Permission related to EFT Withdraw using USD currency example: true RTRWithdrawEnabled: type: boolean description: Permission related to VoPay Instant Withdraw example: true VisaDirectEnabled: type: boolean description: Permission related to Visa Direct example: true InteracMoneyRequestEnabled: type: boolean description: Permission related to Interac Money request example: true InteracBulkPayoutEnabled: type: boolean description: Permission related to Interac bulk payout example: true PayLinkEnabled: type: boolean description: Permission related to Paylink example: true PortalViewOnly: type: boolean description: This flag will change the user permission to the admin portal. When true, the user will have 'Read Only' permission and when false, the user will be able to create transactions using the admin portal. example: true AddUserEnabled: type: boolean description: True if the user wants to enable this feature. This flag allow the user to add users to the accounts example: true TransactionApprovalWorkflowEnabled: type: boolean description: Permission related to the transaction approval workflows example: true AutoBalanceTransferEnabled: type: boolean description: True if the user wants to enable this feature. This flag allow the user to set auto transfer balance example: true MaxFundEFTAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxWithdrawEFTAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxGCMAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxInteracMoneyAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxInteracBulkPayoutAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxVisaDirectAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 Balances: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: Currency: type: string description: 3 character currency code for the balance being returned. example: CAD AccountBalance: type: number description: Indicates the total current account balance, including pending funds. example: '20000.00' PendingBalance: type: number description: Indicates the portion of the account balance which is pending due to in-progress transactions. example: '5540.24' Reserve: type: number description: Indicates the portion of the account balance which is being held as a reserve against negative balances. example: '50000.00' RollingReserveNSF: type: number description: Indicates the portion of the account balance which is being held as a reserve against NSF transactions. example: '10000.00' RollingReserveReturns: type: number description: Indicates the portion of the account balance which is being held as a reserve against returned transactions. example: '1000.00' AvailableImmediately: type: number description: Indicate the portion of the account balance that is available immediately example: '0.00' AvailableBalance: type: number description: Indicates the portion of the account balance which is currently available for use. This is calculated by taking the AccountBalance and subtracting the PendingFunds, Reserve, RollingReserveNSF, and RollingReserveReturns amounts. example: '18000.00' required: - Currency - AccountBalance - PendingBalance - Reserve - RollingReserveNSF - RollingReserveReturns - AvailableImmediately - AvailableBalance x-absent-when: IncludeBalances=false x-list-of: inline x-empty-when: no items ShareHolders: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: ID: type: integer description: Shareholder ID example: '' FullName: type: string description: Shareholder First name and last name example: Share holder name Ownership: type: string description: Percentage of ownership only if is greater than 20% example: '20' Occupation: type: string description: Shareholder's occupation example: '' HomeAddress: type: string description: Shareholder's home address example: 123 address st, Vancouver DateAdded: type: string format: date description: '' example: '2019-11-03 01:00:00' required: - ID - FullName - Ownership - Occupation - HomeAddress - DateAdded x-absent-when: IncludeExtendedInfo=false x-list-of: inline x-empty-when: no items SigningAuthorities: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: ID: type: integer description: Signing Authority ID example: '' FullName: type: string description: Signing Authority First name and last name example: Signing Authority name Occupation: type: string description: Signing Authority's occupation example: '' EmailAddress: type: string description: Signing Authority's email address example: signingauthority@gmail.com HomeAddress: type: string description: Signing Authority's home address example: 123 address st, Vancouver DateAdded: type: string format: date description: '' example: '2019-11-03 01:00:00' required: - ID - FullName - Occupation - EmailAddress - HomeAddress - DateAdded x-absent-when: IncludeExtendedInfo=false x-list-of: inline x-empty-when: no items required: - LegalBusinessName - DBAName - AccountName - ParentAccountName - AccountID - OrginatorName - OriginatorShortName - Email - Phone - Fax - City - Province - Country - PostalCode - Address - FlinksUrl - WebhookUrl - Webhooks - IsActive - GCMEnabled - EFTCollectEnabled - EFTSendEnabled - USDEFTCollectEnabled - USDEFTSendEnabled - RTRWithdrawEnabled - VisaDirectEnabled - InteracMoneyRequestEnabled - InteracBulkPayoutEnabled - PayLinkEnabled - PortalViewOnly - AddUserEnabled - TransactionApprovalWorkflowEnabled - AutoBalanceTransferEnabled - MaxFundEFTAmount - MaxWithdrawEFTAmount - MaxGCMAmount - MaxInteracMoneyAmount - MaxInteracBulkPayoutAmount - MaxVisaDirectAmount x-absent-when: IncludeChildAccounts=false x-list-of: inline x-empty-when: no items IsActive: type: boolean description: Is the account active example: true GCMEnabled: type: boolean description: Permission related to Global cash management example: true EFTCollectEnabled: type: boolean description: Permission related to EFT Fund example: true EFTSendEnabled: type: boolean description: Permission related to EFT Withdraw example: true USDEFTCollectEnabled: type: boolean description: Permission related to EFT Fund using USD currency example: true USDEFTSendEnabled: type: boolean description: Permission related to EFT Withdraw using USD currency example: true RTRWithdrawEnabled: type: boolean description: Permission related to VoPay Instant Withdraw example: true VisaDirectEnabled: type: boolean description: Permission related to Visa Direct example: true InteracMoneyRequestEnabled: type: boolean description: Permission related to Interac Money request example: true InteracBulkPayoutEnabled: type: boolean description: Permission related to Interac bulk payout example: true PayLinkEnabled: type: boolean description: Permission related to Paylink example: true PortalViewOnly: type: boolean description: This flag will change the user permission to the admin portal. When true, the user will have 'Read Only' permission and when false, the user will be able to create transactions using the admin portal. example: true AddUserEnabled: type: boolean description: True if the user wants to enable this feature. This flag allow the user to add users to the accounts example: true TransactionApprovalWorkflowEnabled: type: boolean description: Permission related to the transaction approval workflows example: true AutoBalanceTransferEnabled: type: boolean description: True if the user wants to enable this feature. This flag allow the user to set auto transfer balance example: true MaxFundEFTAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxWithdrawEFTAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxGCMAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxInteracMoneyAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxInteracBulkPayoutAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 MaxVisaDirectAmount: type: number description: Maximum amount that the user can transfer using this endpoint example: 4500 Balances: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: Currency: type: string description: 3 character currency code for the balance being returned. example: CAD AccountBalance: type: number description: Indicates the total current account balance, including pending funds. example: '20000.00' PendingBalance: type: number description: Indicates the portion of the account balance which is pending due to in-progress transactions. example: '5540.24' Reserve: type: number description: Indicates the portion of the account balance which is being held as a reserve against negative balances. example: '50000.00' RollingReserveNSF: type: number description: Indicates the portion of the account balance which is being held as a reserve against NSF transactions. example: '10000.00' RollingReserveReturns: type: number description: Indicates the portion of the account balance which is being held as a reserve against returned transactions. example: '1000.00' AvailableImmediately: type: number description: Indicate the portion of the account balance that is available immediately example: '0.00' AvailableBalance: type: number description: Indicates the portion of the account balance which is currently available for use. This is calculated by taking the AccountBalance and subtracting the PendingFunds, Reserve, RollingReserveNSF, and RollingReserveReturns amounts. example: '18000.00' required: - Currency - AccountBalance - PendingBalance - Reserve - RollingReserveNSF - RollingReserveReturns - AvailableImmediately - AvailableBalance x-absent-when: IncludeBalances=false x-list-of: inline x-empty-when: no items ShareHolders: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: ID: type: integer description: Shareholder ID example: '' FullName: type: string description: Shareholder First name and last name example: Share holder name Ownership: type: string description: Percentage of ownership only if is greater than 20% example: '20' Occupation: type: string description: Shareholder's occupation example: '' HomeAddress: type: string description: Shareholder's home address example: 123 address st, Vancouver DateAdded: type: string format: date description: '' example: '2019-11-03 01:00:00' required: - ID - FullName - Ownership - Occupation - HomeAddress - DateAdded x-absent-when: IncludeExtendedInfo=false x-list-of: inline x-empty-when: no items SigningAuthorities: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object properties: ID: type: integer description: Signing Authority ID example: '' FullName: type: string description: Signing Authority First name and last name example: Signing Authority name Occupation: type: string description: Signing Authority's occupation example: '' EmailAddress: type: string description: Signing Authority's email address example: signingauthority@gmail.com HomeAddress: type: string description: Signing Authority's home address example: 123 address st, Vancouver DateAdded: type: string format: date description: '' example: '2019-11-03 01:00:00' required: - ID - FullName - Occupation - EmailAddress - HomeAddress - DateAdded x-absent-when: IncludeExtendedInfo=false x-list-of: inline x-empty-when: no items required: - LegalBusinessName - DBAName - AccountName - ParentAccountName - AccountID - OrginatorName - OriginatorShortName - Email - Phone - Fax - City - Province - Country - PostalCode - Address - FlinksUrl - WebhookUrl - Webhooks - ParentAccounts - IsActive - GCMEnabled - EFTCollectEnabled - EFTSendEnabled - USDEFTCollectEnabled - USDEFTSendEnabled - RTRWithdrawEnabled - VisaDirectEnabled - InteracMoneyRequestEnabled - InteracBulkPayoutEnabled - PayLinkEnabled - PortalViewOnly - AddUserEnabled - TransactionApprovalWorkflowEnabled - AutoBalanceTransferEnabled - MaxFundEFTAmount - MaxWithdrawEFTAmount - MaxGCMAmount - MaxInteracMoneyAmount - MaxInteracBulkPayoutAmount - MaxVisaDirectAmount x-absent-when: ExportCSV requested x-list-of: inline x-empty-when: no items Pagination: type: object description: Pagination metadata properties: TotalRecords: type: string description: Total number of account 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' required: - TotalRecords - Offset - Limit required: - Success - ErrorMessage - PartnerAccount - Pagination /partner/account/business-case: post: description: This endpoint is used to provide the use cases for the VoPay account you are onboarding. summary: partner/account/business-case tags: - Partner Endpoints operationId: AccountBusinessCasePOST 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 VopayAccountID: description: The account ID for whom you are provding the business case info. type: string BusinessName: description: Name of the company for whom you are providing the business case info type: string BusinessEmail: description: Name of the company for whom you are providing the business case info type: string DoingBusinessAs: description: A brief description of the business activities of the VoPay account type: string WebsiteURL: description: Website URL type: string BusinessModel: description: Describe the current product or services you offer type: string MSB: description: Are you a Medium Small Business? type: boolean NumberofYearsInBusiness: description: Number of Years in Business type: number InteracETransferCurrent: description: Do you currently have Interac E-Transfer service type: boolean VisaMastercardProcessingCurrent: description: Do you currently have Visa Mastercard Processing service type: boolean VisaDirectMCSendCurrent: description: Do you currently have Visa Direct Mastercard Send service type: boolean EFTCurrent: description: Do you currently have EFT service type: boolean VirtualAccountsCurrent: description: Do you currently have Virtual Accounts type: boolean NoneOfTheAboveCurrent: description: You don't have any of the services mentioned above type: boolean EFTiQ11Required: description: Will the VoPay account require the IQ11 service. type: boolean EFTRequired: description: Will the VoPay account require the EFT service. type: boolean ETransferBulkPayoutRequired: description: Will the VoPay account require the Interac payout service. type: boolean ETransferMoneyRequestRequired: description: Will the VoPay account require the Interac money request service. type: boolean VisaDirectMCSendRequired: description: Will the VoPay account require the Visa Direct service. type: boolean VisaMastercardProcessingRequired: description: Will the VoPay account require the Visa Mastercard Processing service. type: boolean InboundEtransferRequired: description: Will the VoPay account require the Inbound E-transfer service. type: boolean VirtualAccountsRequired: description: Will the VoPay account require Virtual Account service. type: boolean OtherRequired: description: Will the VoPay account require other services not listed. type: boolean OtherRequiredServies: description: Please specify the service required. type: string EFTPushTotalTransactionCount: description: What is the daily estimated EFT Push Transactions to be executed by this VoPay account type: number EFTPushTotalTransactionAmount: description: What is the daily estimated average EFT Push Total Transaction Amount to be executed by this VoPay account type: number EFTPushTransactionAverage: description: What is the daily estimated EFT Push Transaction Average Amount to be executed by this VoPay account type: number EFTPushMinimumTransactionAmount: description: What is the daily estimated EFT Push Minimum Transaction Amount to be executed by this VoPay account type: number EFTPushMaximumTransactionAmount: description: What is the daily estimated EFT Push Maximum Transaction Amount to be executed by this VoPay account type: number EFTPullTotalTransactionCount: description: What is the daily estimated EFT Pull Total Transactions to be executed by this VoPay account type: number EFTPullTotalTransactionAmount: description: What is the daily estimated EFT Pull Total Transaction Amount to be executed by this VoPay account type: number EFTPullAverageTransactionAmount: description: What is the daily estimated EFT Pull Average Transaction Amount to be executed by this VoPay account type: number EFTPullMinimumTransactionAmount: description: What is the daily estimated EFT Pull Minimum Transaction Amount to be executed by this VoPay account type: number EFTPullMaximumTransactionAmount: description: What is the daily estimated EFT Pull Maximum Transaction Amount to be executed by this VoPay account type: number ETransferSendTotalTransactionCount: description: What is the daily estimated E-Transfer (Send) Total Transactions to be executed by this VoPay account type: number ETransferSendTotalTransactionAmount: description: What is the daily estimated E-Transfer (Send) Total Transaction Amount to be executed by this VoPay account type: number ETransferSendAverageTransactionAmount: description: What is the daily estimated E-Transfer (Send) Average Transaction Amount to be executed by this VoPay account type: number ETransferSendMinimumTransactionAmount: description: What is the daily estimated E-Transfer (Send) Minimum Transaction Amount to be executed by this VoPay account type: number ETransferSendMaximumTransactionAmount: description: What is the daily estimated E-Transfer (Send) Maximum Transaction Amount to be executed by this VoPay account type: number ETransferRequestDailyTransactionCount: description: What is the daily estimated E-Transfer (Request) Total Transactions to be executed by this VoPay account type: number ETransferRequestDailyTransactionTotal: description: What is the daily estimated E-Transfer (Request) Total Transaction Amount to be executed by this VoPay account type: number ETransferRequestAverageTransactionAmount: description: What is the daily estimated E-Transfer (Request) Average Transaction Amount to be executed by this VoPay account type: number ETransferRequestMinimumTransactionAmount: description: What is the daily estimated E-Transfer (Request) Minimum Transaction Amount to be executed by this VoPay account type: number ETransferRequestMaximumTransactionAmount: description: What is the daily estimated E-Transfer (Request) Maximum Transaction Amount to be executed by this VoPay account type: number DomesticDebitPayoutAnnualTransactionCount: description: What is the estimated Domestic Payout Annual Transactions via Visa Direct / Mastercard to be executed by this VoPay account type: number DomesticDebitPayoutAnnualTransactionAmountTotal: description: What is the estimated Domestic Payout Annual Transaction Amount Total via Visa Direct / Mastercard to be executed by this VoPay account type: number DomesticDebitPayoutAnnualAverageTransactionAmount: description: What is the estimated Domestic Payout Annual Average Transaction Amount via Visa Direct / Mastercard to be executed by this VoPay account type: number DomesticDebitPayoutAnnualMaximumTransactionAmount: description: What is the estimated Domestic Payout Annual Maximum Transaction Amount via Visa Direct / Mastercard to be executed by this VoPay account type: number DomesticDebitPayInsAnnualTransactionCount: description: What is the estimated Domestic Pay-Ins Annual Transactions via Visa Direct / Mastercard to be executed by this VoPay account type: number DomesticDebitPayInsAnnualTransactionAmountTotal: description: What is the estimated annual Domestic Pay-Ins Annual Transaction Amount Total via Visa Direct / Mastercard to be executed by this VoPay account type: number DomesticDebitPayInsAnnualAverageTransactionAmount: description: What is the estimated annual Domestic Pay-Ins Annual Average Transaction Amount via Visa Direct / Mastercard to be executed by this VoPay account type: number DomesticDebitPayInsAnnualMaximumTransactionAmount: description: What is the estimated annual Domestic Pay-Ins Annual Maximum Transaction Amount via Visa Direct / Mastercard to be executed by this VoPay account type: number RegisteredISO: description: Are you a registered ISO? type: boolean NumberOfMerchant: description: If you are a registered ISO, please provide the number of merchants you work with type: number CardProcessingAnnualTransactionCount: description: What is the estimated annual Card Processing Annual Transactions to be executed by this VoPay account type: number CardProcessingAnnualTransactionAmount: description: What is the estimated annual Card Processing Annual Transaction Amount to be executed by this VoPay account type: number CardProcessingAverageTransactionAmount: description: What is the estimated annual Card Processing Average Transaction Amount to be executed by this VoPay account type: number NumberofVirtualAccounts: description: Number of Virtual Accounts required type: number NumberofDebitorCreditTransactionsPerAccount: description: What is the estimated annual Number of Debit or Credit Transactions per account to be executed by this VoPay account type: number required: - AccountID - Key - Signature - VopayAccountID - BusinessName - BusinessEmail - DoingBusinessAs - WebsiteURL - BusinessModel - MSB - NumberofYearsInBusiness required: true responses: '200': description: '' 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 /partner/account/set-permissions: post: description: This endpoint will allow a partner to modify the permissions and the maximum amounts for their accounts. summary: partner/account/set-permissions tags: - Partner Endpoints operationId: AccountSetPermissionsPOST 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 VopayAccountID: description: This field is to apply the permissions to only one account. type: string ApplyToAll: description: This flag will allow the Main account to modify the permissions of all their sub-accounts at once, no matter if the sub account is active or inactive. This field only accepts true as a value type: boolean GCMEnabled: description: Permission related to Global cash management, True if the user wants to enable this feature type: boolean EFTCollectEnabled: description: Permission related to EFT Fund, True if the user wants to enable this feature type: boolean EFTSendEnabled: description: Permission related to EFT Withdraw, True if the user wants to enable this feature type: boolean USDEFTCollectEnabled: description: Permission related to EFT Fund using USD currency with a Canadian bank account, True if the user wants to enable this feature type: boolean USDEFTSendEnabled: description: Permission related to EFT Withdraw using USD currency with a Canadian bank account, True if the user wants to enable this feature type: boolean RTRWithdrawEnabled: description: Permission related to VoPay Instant Withdraw, True if the user wants to enable this feature type: boolean PushToCardEnabled: description: Permission related to Push to Card service. True if the user wants to enable this feature to send funds directly to debit cards type: boolean AFTEnabled: description: Permission related to Automated Funds Transfer. True if the user wants to enable debti card funding transactions type: boolean InteracMoneyRequestEnabled: description: Permission related to Interac Money request, True if the user wants to enable this feature type: boolean TransactionApprovalWorkflowEnabled: description: True if the user wants to enable this feature. This flag enables transaction approval workflows requiring approvals before transactions are processed type: boolean IQ11Enabled: description: True if the user wants to enable this feature. This flag allow the user to activate IQ11 functionality type: boolean IQ11StandardEnabled: description: Permission related to IQ11 Boost tier. True if the user wants to enable this enhanced level of bank account verification service type: boolean IQ11BoostEnabled: description: Permission related to IQ11 Boost tier. True if the user wants to enable this enhanced level of bank account verification service type: boolean IQ11PlusEnabled: description: Permission related to IQ11 Plus tier. True if the user wants to enable this premium level of bank account verification service type: boolean IQ11AdvantageEnabled: description: Permission related to IQ11 Advantage tier. True if the user wants to enable this enterprise level of bank account verification service type: boolean DebitAuthorityAgreementsRequired: description: True if debit authority agreements are required before processing transactions. This adds an additional verification step for compliance purposes type: boolean InteracBulkPayoutEnabled: description: Permission related to Interac bulk payout, True if the user wants to enable this feature type: boolean TransactionLabelOverrideEnabled: description: True if the user wants to enable this feature. This flag allows customization of transaction labels that appear on bank statements type: boolean AutoBalanceTransferEnabled: description: True if the user wants to enable this feature. This flag allow the user to set auto transfer balance type: boolean PayLinkEnabled: description: True if the user wants to enable this feature. This flag allow the user to activate PayLink functionality type: boolean MicroDepositBankAccountVerificationEnabled: description: True if the user wants to enable this feature. This flag activates additional verification to confirm bank account ownership type: boolean InteracBasicVerificationEnabled: description: True if the user wants to enable this feature. This flag activates additional verification to confirm basic Interac registration info type: boolean InteracEnhancedVerificationEnabled: description: True if the user wants to enable this feature. This flag activates additional verification to confirm enhanced Interac registration info type: boolean CardBasicVerificationEnabled: description: True if the user wants to enable this feature. This flag activates additional verification to confirm basic card ownership type: boolean CardEnhancedVerificationEnabled: description: True if the user wants to enable this feature. This flag activates additional verification to confirm enhanced card ownership type: boolean ClientAccountsEnabled: description: True if the user wants to enable this feature. This flag allows the creation and management of client accounts type: boolean ThirdPartyClientAccountTransactionsEnabled: description: True if the user wants to enable this feature. This flag allows transactions to be processed for third-party client accounts type: boolean AccountTransferEnabled: description: True if the user wants to enable this feature. This flag allows transferring funds between accounts within the system type: boolean FailNSFTransactions: description: True if the user wants to enable this feature. This flag automatically fails transactions if insufficient funds are detected type: boolean FlagDuplicateTransactions: description: True if the user wants to enable this feature. This flag marks potentially duplicate transactions for review type: boolean CreditCardEnabled: description: Permission related to Credit Cards, True if the user wants to enable this feature type: boolean ACHFundEnabled: type: boolean ACHWithdrawEnabled: type: boolean SameDayACHFundEnabled: type: boolean SameDayACHWithdrawEnabled: type: boolean FedwireFundEnabled: type: boolean FedwireWithdrawEnabled: type: boolean CPAFileGenerationEnabled: type: boolean UniversalClientAccountsEnabled: type: boolean MoneyRequestGenerateUrlEnabled: type: boolean AccountingSoftwareIntegrationEnabled: type: boolean AutoRecoverNSFEnabled: type: boolean VirtualAccountsEnabled: description: True if the user wants to enable this feature. This flag allows the user to create and manage virtual accounts type: boolean InboundEtransferEnabled: description: Permission related to Inbound E-transfer service. True if the user wants to enable receiving funds via email money transfers type: boolean ACHHoldReleaseIQ11: type: boolean ACHHoldRelease: type: boolean RTPWithdrawEnabled: type: boolean FednowWithdrawEnabled: type: boolean CrossborderInclusive: type: boolean BrandingEmailEnabled: type: boolean BrandingELinxEnabled: type: boolean BrandingPortalEnabled: type: boolean BrandingOnboardingEnabled: type: boolean FlagHighRiskIp: type: boolean LowBalanceAlertEnabled: type: boolean JournalEntryEnabled: type: boolean InterestAccountEnabled: type: boolean MaxFundEFTAmount: description: Maximum amount that the user can transfer using this endpoint (EFT fund) type: number MaxWithdrawEFTAmount: description: Maximum amount that the user can transfer using this endpoint (EFT withdraw) type: number MaxACHFundAmount: type: number MaxACHWithdrawAmount: type: number SameDayMaxACHFundAmount: type: number SameDayMaxACHWithdrawAmount: type: number MaxFedwireFundAmount: type: number MaxFedwireWithdrawAmount: type: number MaxGCMAmount: description: Maximum amount that the user can transfer using this endpoint (GMC) type: number MaxInteracMoneyAmount: description: Maximum amount that the user can transfer using this endpoint (Interac Money request) type: number MaxInteracBulkPayoutAmount: description: Maximum amount that the user can transfer using this endpoint (Interac bulk payout) type: number MaxPushToCardAmount: type: number MaxAFTAmount: type: number MaxFundMyAccountAmount: type: number MaxWithdrawMyAccountAmount: description: Maximum amount that the user can transfer to their own bank account type: number MaxRTRWithdrawAmount: description: Maximum amount that the user can transfer using this endpoint (VoPay Instant withdraw) type: number MaxRTPWithdrawAmount: type: number MaxFednowWithdrawAmount: type: number AutoBalanceTransferAmount: type: number EFTHoldReleaseNonIQ11: type: number BusinessAccountTransactionLimit: type: number IndividualAccountTransactionLimit: type: number ReceiveOnlyAccountTransactionLimit: type: number StandardAccountTransactionLimit: type: number InteracHoldRelease: type: number MaxCrossborderWithdrawAmount: type: number DailyLimitInboundBankAccount: type: number DailyLimitAmountInboundBankAccount: type: number WeeklyLimitInboundBankAccount: type: number WeeklyLimitAmountInboundBankAccount: type: number MonthlyLimitInboundBankAccount: type: number MonthlyLimitAmountInboundBankAccount: type: number DailyLimitInboundEmailAddress: type: number DailyLimitAmountInboundEmailAddress: type: number WeeklyLimitInboundEmailAddress: type: number WeeklyLimitAmountInboundEmailAddress: type: number MonthlyLimitInboundEmailAddress: type: number MonthlyLimitAmountInboundEmailAddress: type: number DailyLimitInboundDebitCard: type: number DailyLimitAmountInboundDebitCard: type: number WeeklyLimitInboundDebitCard: type: number WeeklyLimitAmountInboundDebitCard: type: number MonthlyLimitInboundDebitCard: type: number MonthlyLimitAmountInboundDebitCard: type: number DailyLimitInboundCreditCard: type: number DailyLimitAmountInboundCreditCard: type: number WeeklyLimitInboundCreditCard: type: number WeeklyLimitAmountInboundCreditCard: type: number MonthlyLimitInboundCreditCard: type: number MonthlyLimitAmountInboundCreditCard: type: number DailyLimitOutboundBankAccount: type: number DailyLimitAmountOutboundBankAccount: type: number WeeklyLimitOutboundBankAccount: type: number WeeklyLimitAmountOutboundBankAccount: type: number MonthlyLimitOutboundBankAccount: type: number MonthlyLimitAmountOutboundBankAccount: type: number DailyLimitOutboundEmailAddress: type: number DailyLimitAmountOutboundEmailAddress: type: number WeeklyLimitOutboundEmailAddress: type: number WeeklyLimitAmountOutboundEmailAddress: type: number MonthlyLimitOutboundEmailAddress: type: number MonthlyLimitAmountOutboundEmailAddress: type: number DailyLimitOutboundDebitCard: type: number DailyLimitAmountOutboundDebitCard: type: number WeeklyLimitOutboundDebitCard: type: number WeeklyLimitAmountOutboundDebitCard: type: number MonthlyLimitOutboundDebitCard: type: number MonthlyLimitAmountOutboundDebitCard: type: number DailyLimitInboundAmount: type: number WeeklyLimitInboundAmount: type: number MonthlyLimitInboundAmount: type: number MonthlyInboundTransactionLimit: type: number DailyLimitOutboundAmount: type: number WeeklyLimitOutboundAmount: type: number MonthlyLimitOutboundAmount: type: number MonthlyOutboundTransactionLimit: type: number 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 /partner/billing-packages: get: description: This endpoint is used to retrieve the list of billing packages that you can assign to an account. summary: partner/billing-packages tags: - Partner Endpoints operationId: PartnerBillingPackagesGET 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 responses: '200': description: '' 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: '' BillingPackages: type: object description: 'Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys ''0'',''1'',... Empty {} when no items.' properties: '0': type: object description: Billing package info properties: PackageID: type: number description: Unique ID of the billing package example: '1234' PackageName: type: string description: Name of the billing package example: Enterprise Billing Package DateAdded: type: string format: date description: Date the bank account was added example: '2019-11-03 01:00:00' CreatedBy: type: string description: Creator of the billing package (either VoPay or Partner name) example: ABC Partner Currency: type: string description: 3 character currency code for the billing package example: CAD required: - PackageID - PackageName - DateAdded - CreatedBy - Currency x-list-of: inline x-empty-when: no items required: - Success - ErrorMessage - BillingPackages /partner/invoice-details: get: description: This endpoint is used to retrieve the invoice-details (number of transactions, rates, etc) for a given billing cycle. If no month/year is provided, the current month/year is used. summary: partner/invoice-details tags: - Partner Endpoints operationId: PartnerInvoiceDetailsGET 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: VopayAccountID in: query required: false description: Only returns billing info for this VoPay account schema: type: string - name: month in: query required: false description: 'Billing cycle month (eg: 03). Defaults to current month' schema: type: string - name: year in: query required: false description: 'Billing cycle year (eg: 2021). Defaults to current year' schema: type: string responses: '200': description: '' 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: '' InvoicePeriod: type: object description: Invoice Period properties: FromDate: type: string description: Invoice Start Date example: '2021-10-01' ToDate: type: string description: Invoice End Date example: '2021-10-31' required: - FromDate - ToDate InvoiceDetails: type: object description: Invoice Details for for each account for the invoice period properties: AccountID: type: object description: Invoice details for the Account ID properties: Currency: type: object description: '3 character currency code of the invoice; ex: CAD' properties: Service: type: object description: 'Service being billed; ex: EFTFunding' properties: description: type: string description: Description of the service being billed example: EFT Funding Transaction fee quantity: type: integer description: Number of transactions example: '50' rate: type: number description: Cost per transaction example: '1.50' amount: type: number description: Total cost of service (quantity x rate) example: '75' required: - description - quantity - rate - amount required: - Service required: - Currency required: - AccountID required: - Success - ErrorMessage - InvoicePeriod - InvoiceDetails /partner/account/transactions: get: description: This endpoint is used to fetch all the transactions belonging to your accounts summary: partner/account/transactions tags: - Partner Endpoints operationId: PartnerAccountTransactionsURLGET 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: VopayAccountID in: query required: false description: Your VoPay account ID schema: type: string - name: TransactionType in: query required: false description: The transaction type for the account schema: type: string - name: FromDate in: query required: false description: Transaction start date schema: type: string - name: ToDate in: query required: false description: Transaction end date schema: type: string - name: SettlementDate in: query required: false description: Transaction settlement date schema: type: string - name: Status in: query required: false description: The transaction status. schema: type: string - name: Currency in: query required: false description: The transaction currency. schema: type: string - name: TransactionID in: query required: false description: The transaction ID schema: type: string - name: Limit in: query required: false description: Limit the number of records that are returned. Use the off-set parameter to set the starting point in the data-set. schema: type: integer - name: Offset in: query required: false description: Use this parameter to set the starting point in the dataset. schema: type: integer - name: IncludeSubaccountTransactions in: query required: false description: Fetch transactions for subaccounts as well. schema: type: boolean 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: '' TransactionsCount: type: number description: Total number of all the transactions example: '' x-absent-when: ExportCSV requested Transactions: type: string description: JSON object containing all the transactions example: '{''TransactionID'': ''TransactionID'', ''TransactionType'': ''TransactionType''}' x-absent-when: ExportCSV requested Pagination: type: object description: Pagination metadata properties: TotalRecords: type: string description: Total number of sub account 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' required: - TotalRecords - Offset - Limit required: - Success - ErrorMessage - Pagination /partner/account/transfer: post: description: This endpoint allows you to transfer funds between VoPay accounts. summary: partner/account/transfer tags: - Partner Endpoints operationId: PartnerAccountTransferPost 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 DebitorAccountID: description: ID of the account transferring the funds type: string RecipientAccountID: description: ID of the account receiving the funds type: string Amount: description: The transfer amount. 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). type: string ClientReferenceNumber: description: An optional reference number to associate with the transfer type: string Notes: description: An optional note to associate with the transaction. type: string IdempotencyKey: description: A unique key which the server can use to recognize and reject subsequent retries of the same request. type: string required: - AccountID - Key - Signature - DebitorAccountID - RecipientAccountID - Amount 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: '' TransactionID: type: integer description: The unique ID of the debit transaction associated with this transfer. example: '11223344' required: - Success - ErrorMessage - TransactionID /partner/account/fund-transfer: post: description: 'This endpoint will fund the Debitor account using their default bank account, and then trigger an account transfer to the recipient account once the funds have been cleared. To set a default bank account, please use the /bank-account/set-my-bank-account endpoint.' summary: partner/account/fund-transfer tags: - Partner Endpoints operationId: PartnerAccountFundTransferPost deprecated: false requestBody: $ref: '#/components/requestBodies/PartnerAccountFundTransferPost' 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: '' TransactionID: type: integer description: The unique ID of the debit transaction associated with this transfer. example: '11223344' required: - Success - ErrorMessage - TransactionID /partner/account/transfer-withdraw: post: description: 'This endpoint will transfer money from the debitor account to the recipient account, and then immediately withdraw the money from the recipient account into their default bank account. To set a default bank account, please use the /bank-account/set-my-bank-account endpoint.' summary: partner/account/transfer-withdraw tags: - Partner Endpoints operationId: PartnerAccountTransferWithdrawPost deprecated: false requestBody: $ref: '#/components/requestBodies/PartnerAccountFundTransferPost' 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: '' TransactionID: type: integer description: The unique ID of the debit transaction associated with this transfer. example: '11223344' required: - Success - ErrorMessage - TransactionID /partner/account/fund-transfer-withdraw: post: description: 'This endpoint will fund the debitor account using their default bank account, and then transfer the money to the recipient account once the funds have been cleared. Once the funds are transferred, a withdraw transaction will be triggered to send the funds to the recipient account''s default bank account. To set a default bank account, please use the /bank-account/set-my-bank-account endpoint.' summary: partner/account/fund-transfer-withdraw tags: - Partner Endpoints operationId: PartnerAccountFundTransferWithdrawPost deprecated: false requestBody: $ref: '#/components/requestBodies/PartnerAccountFundTransferPost' 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: '' TransactionID: type: integer description: The unique ID of the debit transaction associated with this transfer. example: '11223344' required: - Success - ErrorMessage - TransactionID /partner/account/onboarding-url: get: description: This endpoint is used to fetch the onboarding URL for an account in the Application Pending stage summary: partner/account/onboarding-url tags: - Partner Endpoints operationId: PartnerAccountOnboardingURLGET 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: VopayAccountID in: query required: true description: The account ID for whom you are requesting the onboarding URL 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: '' OnboardingURL: type: string description: The onboarding URL for the VoPay account example: '' required: - Success - ErrorMessage - OnboardingURL /partner/create-partner: post: description: This endpoint allows Technology partner accounts to create new partner accounts. Only partner accounts with PartnerCreationEnabled and a Technology account type can use this endpoint. summary: partner/create-partner tags: - Partner Endpoints operationId: PartnerCreatePartnerPost 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 Name: description: Name of the partner account to create type: string EmailAddress: description: Email address for the new partner account type: string format: email Country: description: Country for the new partner account. ISO abbreviation or full country name type: string PartnerAccountID: description: The ID of the partner account to create. If not specified, the system will generate a random unique ID for the new partner account. type: string required: - AccountID - Key - Signature - Name - EmailAddress - Country required: true responses: '200': description: '' 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: '' PartnerAccountID: type: string description: The unique ID for the newly created partner account example: PartnerAccount123 APIKey: type: string description: The API key for the new partner account example: eddc0f5e37d20f98b486daf842447ec1f225f859 APISharedSecret: type: string description: API Shared Secret for the new partner account example: AbcDefGi+KlmnopQRSTu183== required: - Success - ErrorMessage - PartnerAccountID - APIKey - APISharedSecret /partner/account/edit: post: description: This endpoint is used to edit a VoPay account that belongs to your partner account. summary: partner/account/edit tags: - Partner Endpoints operationId: PartnerAccountEditPOST 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 VopayAccountID: description: The VoPay account ID of the account you want to edit type: string LegalBusinessName: description: Updated legal business name for the account type: string EmailAddress: description: Updated email address for the account type: string format: email required: - AccountID - Key - Signature - VopayAccountID required: true responses: '200': description: '' 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 /partner/account/deactivate: post: description: This endpoint is used to deactivate a VoPay account that belongs to your partner account. summary: partner/account/deactivate tags: - Partner Endpoints operationId: PartnerAccountDeactivatePOST 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 VopayAccountID: description: The VoPay account ID of the account you want to deactivate type: string required: - AccountID - Key - Signature - VopayAccountID required: true responses: '200': description: '' 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 components: requestBodies: PartnerAccountFundTransferPost: 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 DebitorAccountID: description: ID of the account transferring the funds type: string RecipientAccountID: description: ID of the account receiving the funds 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. If this is not specified the transaction will use the account's local currency. type: string ClientReferenceNumber: description: An optional reference number to associate with the transfer type: string Notes: description: An optional note to associate with the transaction. type: string IdempotencyKey: description: A unique key which the server can use to recognize and reject subsequent retries of the same request. type: string required: - AccountID - Key - Signature - DebitorAccountID - RecipientAccountID - Amount - Currency required: true