Sub Account APIs

Create Sub Account

POST /abc/v1/sub-account/create

Creates a sub account for fund segregation, budget management, and card operations.

Request Headers

X-API-Key

string

example

{apiKey}

X-Timestamp

integer

example

{{Timestamp}}

X-Nonce

string

example

{{Nonce}}

X-Signature

string

example

{{Signature}}

Content-Type

string

example

application/json

Request Body

Data model: OpenSubAccountCreateRequest

subAccountName

stringRequired

Description

sub account name

Example / Default

RD-SubAccount

currency

string

Description

currency

Example / Default

USD

subAccountAmount

number

Description

Initial amount (unit: cents)

Example / Default

10000

parentAccountId

string

Description

Primary account wallet ID

Successful Response

Data model: CommonResultOpenSubAccountResponse

Response Fields

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

▸

data

object (OpenSubAccountResponse)

View child fields

subAccountId

string

Description

sub account unique ID

subAccountName

string

Description

sub account name

parentAccountId

string

Description

primary account ID

currency

string

Description

currency

Example / Default

USD

status

integer

Description

Account status

Allowed values：

1active

2closed

3frozen

bookAmount

number

Description

Book amount (cents)

availableAmount

number

Description

Available amount (cents)

spendAmount

number

Description

Spent amount (cents)

budgetAvailableLimit

number

Description

Available budget limit (cents)

budgetTotalLimit

number

Description

Total budget limit (cents)

createTime

string

Description

creation time

frozenAmount

number

Description

Frozen amount, unit: cents (minor unit), integer

Query Sub Accounts

POST /abc/v1/sub-account/query

Queries sub accounts by filter. The default page size is 10, with a maximum of 200 records per page.

Request Headers

X-API-Key

string

example

{apiKey}

X-Timestamp

integer

example

{{Timestamp}}

X-Nonce

string

example

{{Nonce}}

X-Signature

string

example

{{Signature}}

Content-Type

string

example

application/json

Request Body

Data model: OpenSubAccountPageRequest

pageNo

integerRequired

Description

Page number, starting from 1

Range：≥1

Default：1

Example：1

pageSize

integerRequired

Description

Items per page, maximum 200

Range：≥1

Default：10

Example：10

subAccountId

string

Description

sub account ID

Example / Default

210945783621084760102

subAccountName

string

Description

sub account name

Example / Default

R&D sub account

Successful Response

Data model: CommonResultPageResultOpenSubAccountResponse

Response Fields

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

▸

data

object (PageResultOpenSubAccountResponse)

View child fields

total

integer (int64)

Description

Total

list

array<object (OpenSubAccountResponse)>

Description

Data

Sub Account Details

POST /abc/v1/sub-account/detail

Retrieves the specified sub account's basic information, status, and balances.

Request Headers

X-API-Key

string

example

{apiKey}

X-Timestamp

integer

example

{{Timestamp}}

X-Nonce

string

example

{{Nonce}}

X-Signature

string

example

{{Signature}}

Content-Type

string

example

application/json

Request Body

Data model: OpenSubAccountDetailRequest

subAccountId

stringRequired

Description

sub account ID

Example / Default

210945783621084760102

Successful Response

Data model: CommonResultOpenSubAccountResponse

Response Fields

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

▸

data

object (OpenSubAccountResponse)

View child fields

subAccountId

string

Description

sub account unique ID

subAccountName

string

Description

sub account name

parentAccountId

string

Description

primary account ID

currency

string

Description

currency

Example / Default

USD

status

integer

Description

Account status

Allowed values：

1active

2closed

3frozen

bookAmount

number

Description

Book amount (cents)

availableAmount

number

Description

Available amount (cents)

spendAmount

number

Description

Spent amount (cents)

budgetAvailableLimit

number

Description

Available budget limit (cents)

budgetTotalLimit

number

Description

Total budget limit (cents)

createTime

string

Description

creation time

frozenAmount

number

Description

Frozen amount, unit: cents (minor unit), integer

Enable or Disable Sub Account

POST /abc/v1/sub-account/update-status

Updates the specified sub account's enabled status to control subsequent operations.

Request Headers

X-API-Key

string

example

{apiKey}

X-Timestamp

integer

example

{{Timestamp}}

X-Nonce

string

example

{{Nonce}}

X-Signature

string

example

{{Signature}}

Content-Type

string

example

application/json

Request Body

Data model: OpenSubAccountStatusUpdateRequest

subAccountId

stringRequired

Description

sub account ID

Example / Default

210945783621084760102

accountStatus

integerRequired

Description

Target account status

Allowed values：

1enabled

4disabled

Example：4

disableReason

string

Description

Disable reason; recommended when accountStatus=4

Example / Default

BUSINESS_LINE_CLOSED

remark

string

Description

operation remark

Example / Default

Business line closed; sub account disabled

Successful Response

Data model: CommonResultOpenSubAccountResponse

Response Fields

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

▸

data

object (OpenSubAccountResponse)

View child fields

subAccountId

string

Description

sub account unique ID

subAccountName

string

Description

sub account name

parentAccountId

string

Description

primary account ID

currency

string

Description

currency

Example / Default

USD

status

integer

Description

Account status

Allowed values：

1active

2closed

3frozen

bookAmount

number

Description

Book amount (cents)

availableAmount

number

Description

Available amount (cents)

spendAmount

number

Description

Spent amount (cents)

budgetAvailableLimit

number

Description

Available budget limit (cents)

budgetTotalLimit

number

Description

Total budget limit (cents)

createTime

string

Description

creation time

frozenAmount

number

Description

Frozen amount, unit: cents (minor unit), integer

Update Sub Account Name

POST /abc/v1/sub-account/update-name

Updates the specified sub account's display name for easier identification and management.

Request Headers

X-API-Key

string

example

{apiKey}

X-Timestamp

integer

example

{{Timestamp}}

X-Nonce

string

example

{{Nonce}}

X-Signature

string

example

{{Signature}}

Content-Type

string

example

application/json

Request Body

Data model: OpenSubAccountUpdateNameRequest

subAccountId

stringRequired

Description

sub account ID

Example / Default

210945783621084760102

subAccountName

stringRequired

Description

new sub account name

Example / Default

R&D sub account

Successful Response

Data model: CommonResultBoolean

Response Fields

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

data

boolean

Description

Response data

Query Sub Account Fund Flows

POST /abc/v1/sub-account/flow/query

Queries the specified sub account's fund movements by filter, with paginated results.

Request Headers

X-API-Key

string

example

{apiKey}

X-Timestamp

integer

example

{{Timestamp}}

X-Nonce

string

example

{{Nonce}}

X-Signature

string

example

{{Signature}}

Content-Type

string

example

application/json

Request Body

Data model: OpenSubAccountFlowQueryRequest

pageNo

integerRequired

Description

Page number, starting from 1

Range：≥1

Default：1

Example：1

pageSize

integerRequired

Description

Items per page, maximum 200

Range：≥1

Default：10

Example：10

subAccountFlowId

string

Description

sub account fund flow ID

Example / Default

2108770631685566465

subAccountId

string

Description

sub account ID

Example / Default

210945783621084760102

subAccountName

string

Description

sub account name

Example / Default

R&D sub account

currency

string

Description

currency code ISO 4217

Example / Default

USD

transType

integer

Description

Transaction type

Allowed values：

1outgoing transfer

2incoming transfer

3purchase

4purchase refund

5freeze

6unfreeze

7adjustment increase

8adjustment decrease

9budget allocation

Example：3

transStatus

integer

Description

Transaction status

Allowed values：

1success

2failure

3pending

4processing

Range：1–4

Example：1

transactionTime

arraystring>

Description

Transaction time range: [start time, end time]

Items：2

Successful Response

Data model: CommonResultPageResultOpenSubAccountFlowResponse

Response Fields

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

▸

data

object (PageResultOpenSubAccountFlowResponse)

View child fields

total

integer (int64)

Description

Total

list

array<object (OpenSubAccountFlowResponse)>

Description

Data

switch sub account card provider

POST /abc/v1/sub-account/switch-provider

Switch Sub Account Card Provider

Request Headers

X-API-Key

stringRequired

Description

API key

example

{APIKey}

X-Timestamp

integerRequired

Description

Unix timestamp in seconds

example

{{Timestamp}}

X-Nonce

stringRequired

Description

Request nonce

example

{{Nonce}}

X-Signature

stringRequired

Description

Request signature

example

{{Signature}}

Content-Type

stringRequired

Description

Request content type

example

application/json

Request Body

Request body format: application/json

subAccountId

stringRequired

Description

Sub account ID, maximum length 64 characters

Example or Default

210945783621084760102

targetProviderName

stringRequired

Description

Target card provider ID. Use an available channel ID provided by ORBSIS.

Example or Default

ORBSIS_A

Available card provider IDs are based on the configuration provided by ORBSIS.

Request Body Example

{ "subAccountId": "210945783621084760102", "targetProviderName": "ORBSIS_A" }

cURL Example

curl --request POST 'https://open.orbsis.com/abc/v1/sub-account/switch-provider' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: api-key' \
  --header 'X-Timestamp: unix-seconds' \
  --header 'X-Nonce: unique-nonce' \
  --header 'X-Signature: base64-signature' \
  --data '{"subAccountId":"210945783621084760102","targetProviderName":"ORBSIS_A"}'

Successful Response

HTTP Status Code: 200

After the switch succeeds, the response body is an empty object.