Partner Endpoints

partner/account/set-permissions

Changed on

This endpoint will allow a partner to modify the permissions and the maximum amounts for their accounts.

post/partner/account/set-permissions

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

VopayAccountIDstring

This field is to apply the permissions to only one account.

ApplyToAllboolean

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

GCMEnabledboolean

Permission related to Global cash management, True if the user wants to enable this feature

EFTCollectEnabledboolean

Permission related to EFT Fund, True if the user wants to enable this feature

EFTSendEnabledboolean

Permission related to EFT Withdraw, True if the user wants to enable this feature

USDEFTCollectEnabledboolean

Permission related to EFT Fund using USD currency with a Canadian bank account, True if the user wants to enable this feature

USDEFTSendEnabledboolean

Permission related to EFT Withdraw using USD currency with a Canadian bank account, True if the user wants to enable this feature

RTRWithdrawEnabledboolean

Permission related to VoPay Instant Withdraw, True if the user wants to enable this feature

PushToCardEnabledboolean

Permission related to Push to Card service. True if the user wants to enable this feature to send funds directly to debit cards

AFTEnabledboolean

Permission related to Automated Funds Transfer. True if the user wants to enable debti card funding transactions

InteracMoneyRequestEnabledboolean

Permission related to Interac Money request, True if the user wants to enable this feature

TransactionApprovalWorkflowEnabledboolean

True if the user wants to enable this feature. This flag enables transaction approval workflows requiring approvals before transactions are processed

IQ11Enabledboolean

True if the user wants to enable this feature. This flag allow the user to activate IQ11 functionality

IQ11StandardEnabledboolean

Permission related to IQ11 Boost tier. True if the user wants to enable this enhanced level of bank account verification service

IQ11BoostEnabledboolean

Permission related to IQ11 Boost tier. True if the user wants to enable this enhanced level of bank account verification service

IQ11PlusEnabledboolean

Permission related to IQ11 Plus tier. True if the user wants to enable this premium level of bank account verification service

IQ11AdvantageEnabledboolean

Permission related to IQ11 Advantage tier. True if the user wants to enable this enterprise level of bank account verification service

DebitAuthorityAgreementsRequiredboolean

True if debit authority agreements are required before processing transactions. This adds an additional verification step for compliance purposes

InteracBulkPayoutEnabledboolean

Permission related to Interac bulk payout, True if the user wants to enable this feature

TransactionLabelOverrideEnabledboolean

True if the user wants to enable this feature. This flag allows customization of transaction labels that appear on bank statements

AutoBalanceTransferEnabledboolean

True if the user wants to enable this feature. This flag allow the user to set auto transfer balance

PayLinkEnabledboolean

True if the user wants to enable this feature. This flag allow the user to activate PayLink functionality

MicroDepositBankAccountVerificationEnabledboolean

True if the user wants to enable this feature. This flag activates additional verification to confirm bank account ownership

InteracBasicVerificationEnabledboolean

True if the user wants to enable this feature. This flag activates additional verification to confirm basic Interac registration info

InteracEnhancedVerificationEnabledboolean

True if the user wants to enable this feature. This flag activates additional verification to confirm enhanced Interac registration info

CardBasicVerificationEnabledboolean

True if the user wants to enable this feature. This flag activates additional verification to confirm basic card ownership

CardEnhancedVerificationEnabledboolean

True if the user wants to enable this feature. This flag activates additional verification to confirm enhanced card ownership

ClientAccountsEnabledboolean

True if the user wants to enable this feature. This flag allows the creation and management of client accounts

ThirdPartyClientAccountTransactionsEnabledboolean

True if the user wants to enable this feature. This flag allows transactions to be processed for third-party client accounts

AccountTransferEnabledboolean

True if the user wants to enable this feature. This flag allows transferring funds between accounts within the system

FailNSFTransactionsboolean

True if the user wants to enable this feature. This flag automatically fails transactions if insufficient funds are detected

FlagDuplicateTransactionsboolean

True if the user wants to enable this feature. This flag marks potentially duplicate transactions for review

CreditCardEnabledboolean

Permission related to Credit Cards, True if the user wants to enable this feature

ACHFundEnabledboolean
ACHWithdrawEnabledboolean
SameDayACHFundEnabledboolean
SameDayACHWithdrawEnabledboolean
WireEnabledboolean
CPAFileGenerationEnabledboolean
UniversalClientAccountsEnabledboolean
MoneyRequestGenerateUrlEnabledboolean
AccountingSoftwareIntegrationEnabledboolean
AutoRecoverNSFEnabledboolean
VirtualAccountsEnabledboolean

True if the user wants to enable this feature. This flag allows the user to create and manage virtual accounts

InboundEtransferEnabledboolean

Permission related to Inbound E-transfer service. True if the user wants to enable receiving funds via email money transfers

ACHHoldReleaseIQ11boolean
ACHHoldReleaseboolean
RTPWithdrawEnabledboolean
FednowWithdrawEnabledboolean
CrossborderInclusiveboolean
BrandingEmailEnabledboolean
BrandingELinxEnabledboolean
BrandingPortalEnabledboolean
BrandingOnboardingEnabledboolean
FlagHighRiskIpboolean
LowBalanceAlertEnabledboolean
JournalEntryEnabledboolean
InterestAccountEnabledboolean
MaxFundEFTAmountnumber

Maximum amount that the user can transfer using this endpoint (EFT fund)

MaxWithdrawEFTAmountnumber

Maximum amount that the user can transfer using this endpoint (EFT withdraw)

MaxACHFundAmountnumber
MaxACHWithdrawAmountnumber
SameDayMaxACHFundAmountnumber
SameDayMaxACHWithdrawAmountnumber
MaxWireAmountnumber
MaxGCMAmountnumber

Maximum amount that the user can transfer using this endpoint (GMC)

MaxInteracMoneyAmountnumber

Maximum amount that the user can transfer using this endpoint (Interac Money request)

MaxInteracBulkPayoutAmountnumber

Maximum amount that the user can transfer using this endpoint (Interac bulk payout)

MaxPushToCardAmountnumber
MaxAFTAmountnumber
MaxFundMyAccountAmountnumber
MaxWithdrawMyAccountAmountnumber

Maximum amount that the user can transfer to their own bank account

MaxRTRWithdrawAmountnumber

Maximum amount that the user can transfer using this endpoint (VoPay Instant withdraw)

MaxRTPWithdrawAmountnumber
MaxFednowWithdrawAmountnumber
AutoBalanceTransferAmountnumber
EFTHoldReleaseNonIQ11number
BusinessAccountTransactionLimitnumber
IndividualAccountTransactionLimitnumber
ReceiveOnlyAccountTransactionLimitnumber
StandardAccountTransactionLimitnumber
InteracHoldReleasenumber
MaxCrossborderWithdrawAmountnumber
DailyLimitInboundBankAccountnumber
DailyLimitAmountInboundBankAccountnumber
WeeklyLimitInboundBankAccountnumber
WeeklyLimitAmountInboundBankAccountnumber
MonthlyLimitInboundBankAccountnumber
MonthlyLimitAmountInboundBankAccountnumber
DailyLimitInboundEmailAddressnumber
DailyLimitAmountInboundEmailAddressnumber
WeeklyLimitInboundEmailAddressnumber
WeeklyLimitAmountInboundEmailAddressnumber
MonthlyLimitInboundEmailAddressnumber
MonthlyLimitAmountInboundEmailAddressnumber
DailyLimitInboundDebitCardnumber
DailyLimitAmountInboundDebitCardnumber
WeeklyLimitInboundDebitCardnumber
WeeklyLimitAmountInboundDebitCardnumber
MonthlyLimitInboundDebitCardnumber
MonthlyLimitAmountInboundDebitCardnumber
DailyLimitInboundCreditCardnumber
DailyLimitAmountInboundCreditCardnumber
WeeklyLimitInboundCreditCardnumber
WeeklyLimitAmountInboundCreditCardnumber
MonthlyLimitInboundCreditCardnumber
MonthlyLimitAmountInboundCreditCardnumber
DailyLimitOutboundBankAccountnumber
DailyLimitAmountOutboundBankAccountnumber
WeeklyLimitOutboundBankAccountnumber
WeeklyLimitAmountOutboundBankAccountnumber
MonthlyLimitOutboundBankAccountnumber
MonthlyLimitAmountOutboundBankAccountnumber
DailyLimitOutboundEmailAddressnumber
DailyLimitAmountOutboundEmailAddressnumber
WeeklyLimitOutboundEmailAddressnumber
WeeklyLimitAmountOutboundEmailAddressnumber
MonthlyLimitOutboundEmailAddressnumber
MonthlyLimitAmountOutboundEmailAddressnumber
DailyLimitOutboundDebitCardnumber
DailyLimitAmountOutboundDebitCardnumber
WeeklyLimitOutboundDebitCardnumber
WeeklyLimitAmountOutboundDebitCardnumber
MonthlyLimitOutboundDebitCardnumber
MonthlyLimitAmountOutboundDebitCardnumber
DailyLimitInboundAmountnumber
WeeklyLimitInboundAmountnumber
MonthlyLimitInboundAmountnumber
MonthlyInboundTransactionLimitnumber
DailyLimitOutboundAmountnumber
WeeklyLimitOutboundAmountnumber
MonthlyLimitOutboundAmountnumber
MonthlyOutboundTransactionLimitnumber

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true
}

Changes

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property