Skip to main content
DELETE
Delete sub-account by sub-account ID.
Deletes a zero-balance sub-account.

Authorizations

x-api-key
string
header
required

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 seconds
  • x-signature: SHA256 HMAC HEX signature calculated over t={x-timestamp}&{requestBody} using your API Secret.

Path Parameters

subAccountIdRef
string
required

The unique onboard sub-account ID or reference

Response

Sub-account deleted Successfully

Status data, check additional message field.

success
boolean
required

Status can be successful or failed, a value of true indicates success.

Example:

true

message
string

additional message describing status.

data
object

Data associated with the status, this will not always be present

error
object

Default error object for services. This gives consistent error object that all services may use.