Sub-Account Endpoints

account/subaccount/set-permissions

This endpoint will allow the user to modify the permissions and the maximum amounts to their sub-accounts in the API.

The main account will be able to only modify the permission that he has, For Example, if the user does not have ETCCollect permission, the account won't be able to assign that permission to their sub-account.

post/account/subaccount/set-permissions

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/subaccount/set-permissions
  • 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

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

SubaccountIDstring

This field is to apply the permissions to only one sub-account. The option ApplyToAll will not work.

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

InteracMoneyRequestEnabledboolean

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

InteracBulkPayoutEnabledboolean

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

GCMEnabledboolean

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

VisaDirectEnabledboolean

Permission related to Visa Direct, True if the user wants to enable this feature

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)

MaxRTRWithdrawAmountnumber

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

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)

MaxGCMAmountnumber

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

MaxVisaDirectAmountnumber

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

PortalTransactionCreationboolean

True if the user wants to enable this feature. This flag will change the user permission to the admin portal. When disabled, the user will have 'Read Only' permission and when enabled, the user will be able to create transactions using the admin portal.

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

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

No recorded changes to this operation across all 2 revisions of this API.