Accounts & Subaccounts
Learn how to create and management sub-accounts
Once you sign up on VeendHQ Business, you automatically have an account created for you.
What is a Sub-account
Each user on VeendHQ can have multiple Sub-accounts for different use cases.
Create a Sub-account
Create a new sub-account.
POST
{{BASE_URL}}/v1/accounts/{{ACCOUNT_ID}}/subaccount?accountId={{ID}}
Query Parameters
Request Body
Get Sub-account Details
Returns details about a sub-account
GET
{{BASE_URL}}/v1/accounts/{{ACCOUNT_ID}}?accountId={{ACCOUNT_ID}}&populate=users
Query Parameters
Get Account Statements
Get the statement of a sub-account which returns information about all transactions on that sub-account.
Returns sub-account statement
GET
{{BASE_URL}}/payments?accountId={{ACCOUNT_ID}}&populate=Purchases&desc=true&limit=5&sort=-_id
Query Parameters
Update sub account detail
Update details of a sub-account
PATCH
{{BASE_URL}}/v1/accounts/{{ACCOUNT_ID}}?accountId={{ACCOUNT_ID}}
Request Body
Transfer funds between Sub-accounts
You can send fund from one sub-account to another on VeendHQ Business Account.
Transfer fund to a subaccount
POST
{{BASE_URL}}/v1/accounts/{{SENDER_ACCOUNT_ID}}/transfer/{{RECEIVER_ACCOUNT_ID}}?accountId={{ID}}
Request Body
Lock and Unlock Sub-account Balance
A sub-account balance can be locked or unlocked. Locking a sub-account will prevent disbursement of funds from that sub-account.
BALANCE_ID
The BALANCE_ID can be gotten from the response to a GET call for a sub-account detail.
Lock and Unlock SubAccount Balance
PATCH
https://test.veendhq.com/v1/balances/{{BALANCE_ID}}?accountId={{ACCOUNT_ID}}
Set blocked on the body of the request to true to lock the subaccount balance, otherwise set to false to unblock the account balance.
Query Parameters
Request Body
Get Balance
Get balance for an account or a sub-account.
Return Balance for Account or Sub-Account
GET
https://test.veendhq.com/v1/balances/?account={{ACCOUNT_ID}}&accountId={{ACCOUNT_ID}}
Last updated