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.
Each user on VeendHQ can have multiple Sub-accounts for different use cases.
post
{{BASE_URL}}
/v1/accounts/{{ACCOUNT_ID}}/subaccount?accountId={{ID}}
Create a new sub-account.
Parameters
Query
accountId*
Body
name*
John Doe
A name for the sub account
user*
62bff....e6f
userId returned from the sign up or login.
webhookurl
A webhook url endpoint to be triggered when certain event occur
currency*
NGN
The currency to be used for the sub account. This should be same as the main account.
Responses
200: OK
Sample success response for created sub-account
get
{{BASE_URL}}
/v1/accounts/{{ACCOUNT_ID}}?accountId={{ACCOUNT_ID}}&populate=users
Returns details about a sub-account
Parameters
Query
accountId*
626...44b
populate
users
Responses
200: OK
Get the statement of a sub-account which returns information about all transactions on that sub-account.
get
{{BASE_URL}}
/payments?accountId={{ACCOUNT_ID}}&populate=Purchases&desc=true&limit=5&sort=-_id
Returns sub-account statement
Parameters
Query
populate
Purchases
limit
10
limit the returned response to a collection of 10 transactions
sort
a field to sort the response by
Responses
200: OK
Sample success response limited to 1 statement
patch
{{BASE_URL}}
/v1/accounts/{{ACCOUNT_ID}}?accountId={{ACCOUNT_ID}}
Update details of a sub-account
Parameters
Body
name*
Peter Pan
Responses
You can send fund from one sub-account to another on VeendHQ Business Account.
post
{{BASE_URL}}
/v1/accounts/{{SENDER_ACCOUNT_ID}}/transfer/{{RECEIVER_ACCOUNT_ID}}?accountId={{ID}}
Transfer fund to a subaccount
Parameters
Body
amount*
400000
description*
Fund for Airtime
Responses
200: OK
Sample success response
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.
patch
https://test.veendhq.com
/v1/balances/{{BALANCE_ID}}?accountId={{ACCOUNT_ID}}
Lock and Unlock SubAccount Balance
Set blocked on the body of the request to true to lock the subaccount balance, otherwise set to false to unblock the account balance.
Parameters
Query
accountId*
5d6c3...53d30d
Body
blocked*
true
Boolean value to set lock and unlock a sub-account balance
Responses
200: OK
Get balance for an account or a sub-account.
get
https://test.veendhq.com
/v1/balances/?account={{ACCOUNT_ID}}&accountId={{ACCOUNT_ID}}
Return Balance for Account or Sub-Account
Last modified 3mo ago