--- title: "account/subaccount" method: GET path: "/account/subaccount" tags: ["Sub-Account Endpoints"] --- # account/subaccount `GET /account/subaccount` This endpoint will return a list of all of the sub-accounts managed by the main account. ## Query parameters - `AccountID` string, required - `Key` string, required - `Signature` string, required - `Limit ` integer - `Offset ` integer - `IncludeBalances` boolean - `IncludeExtendedInfo` boolean - `IncludeChildAccounts` boolean ## Response `200` - object - `Success` boolean, required — True if the request was successful, false if it failed - `ErrorMessage` string, required — Contains a description of the error if the request failed - `ParentAccount` string, required — Parent account name - `Subaccounts` object, required — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. - `0` object - `LegalBusinessName` string, required — Legal Business Name - `AccountName` string, required — Account name of the sub account - `AccountID` string, required — Account ID of the sub account - `SubAccountType` string, required — Type of sub-account - `OrginatorName` string, required — Short Name of the company to identify themselves in the documents - `OriginatorShortName` string, required — Short Name of the company to identify themselves in the documents (max 15 chars) - `Email` string, email, required — Sub-account email address - `Phone` integer, required — Sub-account's phone number - `Fax` string, required — Sub-account's fax number - `City` string, required — Sub-account's city - `Province` string, required — Sub-account's province specified using two character abbreviation (eg. BC, AB) - `Country` string, required — Sub-account's country specified using full country name or ISO 3166-1 alpha-2 code. - `PostalCode` string, required — Sub-account's postal code. - `Address` string, required — Sub-account's address line - `APISharedSecret` string, required — API Shared Secret - `FlinksUrl` string, required — The Flinks URL - `WebhookUrl` string, required — URL where the users want us to send their notifications. See Webhooks attribute for full list. - `Webhooks` object, required — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. - `0` object - `Event` string, required — The type of webhook notification the users wish to receive. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction. - `Url` string, required — Webhook URL, is the url is not setup it will return empty - `ParentAccounts` object, required — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. - `0` object - `AccountID` string, required — Account ID of the account - `AccountName` string, required — Account name of the account - `ParentAccountID` string, required — The parent account ID of the account - `SubAccounts` object — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. - `0` object - `LegalBusinessName` string, required — Legal Business Name - `DBAName` string, required — Doing Business As Name - `AccountName` string, required — Account name of the account - `ParentAccountName` string, required — Parent account name. This will only be populated if the account is a sub-account - `AccountID` string, required — Account ID of the account - `OrginatorName` string, required — Short Name of the company to identify themselves in the documents - `OriginatorShortName` string, required — Short Name of the company to identify themselves in the documents (max 15 chars) - `Email` string, email, required — Account email address - `Phone` integer, required — Account's phone number - `Fax` string, required — Account's fax number - `City` string, required — Account's city - `Province` string, required — Account's province specified using two character abbreviation (eg. BC, AB) - `Country` string, required — Account's country specified using full country name or ISO 3166-1 alpha-2 code. - `PostalCode` string, required — Account's postal code. - `Address` string, required — Account's address line - `FlinksUrl` string, required — The Flinks URL - `WebhookUrl` string, required — URL where the users want us to send their notifications. See Webhooks attribute for full list. - `Webhooks` object, required — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. - `0` object - … - `IsActive` boolean, required — Is the account active - `GCMEnabled` boolean, required — Permission related to Global cash management - `EFTCollectEnabled` boolean, required — Permission related to EFT Fund - `EFTSendEnabled` boolean, required — Permission related to EFT Withdraw - `USDEFTCollectEnabled` boolean, required — Permission related to EFT Fund using USD currency - `USDEFTSendEnabled` boolean, required — Permission related to EFT Withdraw using USD currency - `RTRWithdrawEnabled` boolean, required — Permission related to VoPay Instant Withdraw - `VisaDirectEnabled` boolean, required — Permission related to Visa Direct - `InteracMoneyRequestEnabled` boolean, required — Permission related to Interac Money request - `InteracBulkPayoutEnabled` boolean, required — Permission related to Interac bulk payout - `PayLinkEnabled` boolean, required — Permission related to Paylink - `PortalViewOnly` boolean, required — 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. - `AddUserEnabled` boolean, required — True if the user wants to enable this feature. This flag allow the user to add users to the accounts - `TransactionApprovalWorkflowEnabled` boolean, required — Permission related to the transaction approval workflows - `AutoBalanceTransferEnabled` boolean, required — True if the user wants to enable this feature. This flag allow the user to set auto transfer balance - `MaxFundEFTAmount` number, required — Maximum amount that the user can transfer using this endpoint - `MaxWithdrawEFTAmount` number, required — Maximum amount that the user can transfer using this endpoint - `MaxGCMAmount` number, required — Maximum amount that the user can transfer using this endpoint - `MaxInteracMoneyAmount` number, required — Maximum amount that the user can transfer using this endpoint - `MaxInteracBulkPayoutAmount` number, required — Maximum amount that the user can transfer using this endpoint - `MaxVisaDirectAmount` number, required — Maximum amount that the user can transfer using this endpoint - `Balances` object — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. - `0` object - … - `ShareHolders` object — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. - `0` object - … - `SigningAuthorities` object — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. - `0` object - … - `IsActive` boolean, required — Determine if the account is active or not - `AccountStatus` string, required — The current status of the account - `AutoUnblockThreshold` number, required — The threshold amount for auto-unblocking the account when the account is blocked (DACA accounts only). Once the account balance reaches this threshold, the account will be automatically unblocked. - `GCMEnabled` boolean, required — Permission related to Global cash management - `EFTCollectEnabled` boolean, required — Permission related to EFT Fund - `EFTSendEnabled` boolean, required — Permission related to EFT Withdraw - `USDEFTCollectEnabled` boolean, required — Permission related to EFT Fund using USD currency - `USDEFTSendEnabled` boolean, required — Permission related to EFT Withdraw using USD currency - `RTRWithdrawEnabled` boolean, required — Permission related to VoPay Instant Withdraw - `VisaDirectEnabled` boolean, required — Permission related to Visa Direct - `InteracMoneyRequestEnabled` boolean, required — Permission related to Interac Money request - `InteracBulkPayoutEnabled` boolean, required — Permission related to Interac bulk payout - `PayLinkEnabled` boolean, required — Permission related to Paylink - `Balances` object — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. - `0` object - `Currency` string, required — 3 character currency code for the balance being returned. - `AccountBalance` number, required — Indicates the total current account balance, including pending funds. - `PendingBalance` number, required — Indicates the portion of the account balance which is pending due to in-progress transactions. - `Reserve` number, required — Indicates the portion of the account balance which is being held as a reserve against negative balances. - `RollingReserveNSF` number, required — Indicates the portion of the account balance which is being held as a reserve against NSF transactions. - `RollingReserveReturns` number, required — Indicates the portion of the account balance which is being held as a reserve against returned transactions. - `AvailableImmediately` number, required — Indicate the portion of the account balance that is available immediately - `AvailableBalance` number, required — 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. - `RollupAvailableBalance` string, required — Represents the aggregated total available balance of all sub-accounts under this account. - `RollupAccountBalance` string, required — Represents the aggregated total account balance of all sub-accounts under this account. - `Pagination` object, required — Pagination metadata - `TotalRecords` string, required — Total number of sub account records in that search range. - `Offset` string, required — Use this parameter to set the starting point in the dataset. - `Limit` string, required — Limit the number of records that are returned. --- [API](https://skmtc.net/vopay/apis/accounts.md) · [All operations](https://skmtc.net/vopay/apis/accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vopay/accounts/revisions/7033bd231ec7/schema)