Update sub-account details by sub-account ID.
Virtual Account
Update Sub-account
This endpoint updates sub-account details by sub-account ID.
PUT
Update sub-account details by sub-account ID.
Updates a sub-account’s name or frozen status.
Authorizations
Requires authentication via API key and HMAC signature.
x-api-key: Your API key generated from your Onboard Business dashboard.x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 secondsx-signature: SHA256 HMAC HEX signature calculated overt={x-timestamp}&{requestBody}using your API Secret.
Path Parameters
The unique onboard sub-account ID or reference
Body
application/json
Sub-account update request
Response
Sub-account updated Successfully
Unique sub-account ID
The main account ID to which this sub-account belongs.
A unique reference for the sub-account.
Currency of the sub-account
Example:
"USD"
Account balance details
Indicates if the sub-account is frozen (locked) or not.
The date the sub-account was created.
An optional name for the sub-account.