子賬戶接口

創建子賬戶

POST /abc/v1/sub-account/create

建立新的子賬戶，用於資金隔離、預算管理及卡片業務。

請求頭

X-API-Key

string

範例

{apiKey}

X-Timestamp

integer

範例

{{Timestamp}}

X-Nonce

string

範例

{{Nonce}}

X-Signature

string

範例

{{Signature}}

Content-Type

string

範例

application/json

請求體

數據模型：OpenSubAccountCreateRequest

subAccountName

string必填

說明

子賬戶名稱

範例 / 默認值

RD-SubAccount

currency

string

說明

幣種

範例 / 默認值

USD

subAccountAmount

number

說明

初始金額（單位：分）

範例 / 默認值

10000

parentAccountId

string

說明

主賬戶錢包編號

成功響應

數據模型：CommonResultOpenSubAccountResponse

響應欄位

code

integer

說明

錯誤碼

msg

string

說明

錯誤提示，用戶可閱讀

message

string

data

對象（OpenSubAccountResponse）

查看子欄位

subAccountId

string

說明

子賬戶唯一編號

subAccountName

string

說明

子賬戶名稱

parentAccountId

string

說明

主賬戶編號

currency

string

說明

幣種

範例 / 默認值

USD

status

integer

說明

賬戶狀態

可選值：

1正常

2已銷戶

3凍結

bookAmount

number

說明

賬面金額（分）

availableAmount

number

說明

可用金額（分）

spendAmount

number

說明

已消費金額（分）

budgetAvailableLimit

number

說明

可用預算額度（分）

budgetTotalLimit

number

說明

預算總額度（分）

createTime

string

說明

創建時間

frozenAmount

number

說明

凍結金額，單位：分(cent/minor unit)，整數

子賬戶分頁查詢

POST /abc/v1/sub-account/query

根據篩選條件取得子賬戶列表。預設每頁回傳 10 筆結果，可透過請求參數調整，每頁最多回傳 200 筆。

請求頭

X-API-Key

string

範例

{apiKey}

X-Timestamp

integer

範例

{{Timestamp}}

X-Nonce

string

範例

{{Nonce}}

X-Signature

string

範例

{{Signature}}

Content-Type

string

範例

application/json

請求體

數據模型：OpenSubAccountPageRequest

pageNo

integer必填

說明

頁碼，從 1 開始

範圍：≥1

默認值：1

範例：1

pageSize

integer必填

說明

每頁條數，最大值爲 200

範圍：≥1

默認值：10

範例：10

subAccountId

string

說明

子賬戶編號

範例 / 默認值

210945783621084760102

subAccountName

string

說明

子賬戶名稱

範例 / 默認值

研發子賬戶

成功響應

數據模型：CommonResultPageResultOpenSubAccountResponse

響應欄位

code

integer

說明

錯誤碼

msg

string

說明

錯誤提示，用戶可閱讀

message

string

data

對象（PageResultOpenSubAccountResponse）

查看子欄位

total

integer (int64)

說明

總量

list

數組<對象（OpenSubAccountResponse）>

說明

數據

子賬戶詳情

POST /abc/v1/sub-account/detail

根據子賬戶識別資訊取得基本資料、狀態及資金餘額。

請求頭

X-API-Key

string

範例

{apiKey}

X-Timestamp

integer

範例

{{Timestamp}}

X-Nonce

string

範例

{{Nonce}}

X-Signature

string

範例

{{Signature}}

Content-Type

string

範例

application/json

請求體

數據模型：OpenSubAccountDetailRequest

subAccountId

string必填

說明

子賬戶編號

範例 / 默認值

210945783621084760102

成功響應

數據模型：CommonResultOpenSubAccountResponse

響應欄位

code

integer

說明

錯誤碼

msg

string

說明

錯誤提示，用戶可閱讀

message

string

data

對象（OpenSubAccountResponse）

查看子欄位

subAccountId

string

說明

子賬戶唯一編號

subAccountName

string

說明

子賬戶名稱

parentAccountId

string

說明

主賬戶編號

currency

string

說明

幣種

範例 / 默認值

USD

status

integer

說明

賬戶狀態

可選值：

1正常

2已銷戶

3凍結

bookAmount

number

說明

賬面金額（分）

availableAmount

number

說明

可用金額（分）

spendAmount

number

說明

已消費金額（分）

budgetAvailableLimit

number

說明

可用預算額度（分）

budgetTotalLimit

number

說明

預算總額度（分）

createTime

string

說明

創建時間

frozenAmount

number

說明

凍結金額，單位：分(cent/minor unit)，整數

啓停子賬戶

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

更新指定子賬戶的啟用狀態，以控制其後續業務操作。

請求頭

X-API-Key

string

範例

{apiKey}

X-Timestamp

integer

範例

{{Timestamp}}

X-Nonce

string

範例

{{Nonce}}

X-Signature

string

範例

{{Signature}}

Content-Type

string

範例

application/json

請求體

數據模型：OpenSubAccountStatusUpdateRequest

subAccountId

string必填

說明

子賬戶編號

範例 / 默認值

210945783621084760102

accountStatus

integer必填

說明

目標賬戶狀態

可選值：

1啓用

4停用

範例：4

disableReason

string

說明

停用原因，accountStatus=4 時建議填寫

範例 / 默認值

BUSINESS_LINE_CLOSED

remark

string

說明

操作備註

範例 / 默認值

業務線關閉，子賬戶停用

成功響應

數據模型：CommonResultOpenSubAccountResponse

響應欄位

code

integer

說明

錯誤碼

msg

string

說明

錯誤提示，用戶可閱讀

message

string

data

對象（OpenSubAccountResponse）

查看子欄位

subAccountId

string

說明

子賬戶唯一編號

subAccountName

string

說明

子賬戶名稱

parentAccountId

string

說明

主賬戶編號

currency

string

說明

幣種

範例 / 默認值

USD

status

integer

說明

賬戶狀態

可選值：

1正常

2已銷戶

3凍結

bookAmount

number

說明

賬面金額（分）

availableAmount

number

說明

可用金額（分）

spendAmount

number

說明

已消費金額（分）

budgetAvailableLimit

number

說明

可用預算額度（分）

budgetTotalLimit

number

說明

預算總額度（分）

createTime

string

說明

創建時間

frozenAmount

number

說明

凍結金額，單位：分(cent/minor unit)，整數

修改子賬戶名稱

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

修改指定子賬戶的顯示名稱，方便識別與管理。

請求頭

X-API-Key

string

範例

{apiKey}

X-Timestamp

integer

範例

{{Timestamp}}

X-Nonce

string

範例

{{Nonce}}

X-Signature

string

範例

{{Signature}}

Content-Type

string

範例

application/json

請求體

數據模型：OpenSubAccountUpdateNameRequest

subAccountId

string必填

說明

子賬戶編號

範例 / 默認值

210945783621084760102

subAccountName

string必填

說明

子賬戶新名稱

範例 / 默認值

研發子賬戶

成功響應

數據模型：CommonResultBoolean

響應欄位

code

integer

說明

錯誤碼

msg

string

說明

錯誤提示，用戶可閱讀

message

string

data

boolean

說明

返回數據

查詢子賬戶資金流水

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

根據篩選條件分頁查詢指定子賬戶的資金變動記錄。

請求頭

X-API-Key

string

範例

{apiKey}

X-Timestamp

integer

範例

{{Timestamp}}

X-Nonce

string

範例

{{Nonce}}

X-Signature

string

範例

{{Signature}}

Content-Type

string

範例

application/json

請求體

數據模型：OpenSubAccountFlowQueryRequest

pageNo

integer必填

說明

頁碼，從 1 開始

範圍：≥1

默認值：1

範例：1

pageSize

integer必填

說明

每頁條數，最大值爲 200

範圍：≥1

默認值：10

範例：10

subAccountFlowId

string

說明

子賬戶資金流水編號

範例 / 默認值

2108770631685566465

subAccountId

string

說明

子賬戶編號

範例 / 默認值

210945783621084760102

subAccountName

string

說明

子賬戶名稱

範例 / 默認值

研發子賬戶

currency

string

說明

幣種編碼 ISO 4217

範例 / 默認值

USD

transType

integer

說明

交易類型

可選值：

1轉出

2轉入

3消費

4消費退款

5凍結

6解凍

7調增

8調減

9分配預算

範例：3

transStatus

integer

說明

交易狀態

可選值：

1成功

2失敗

3待處理

4處理中

範圍：1–4

範例：1

transactionTime

數組<string>

說明

交易時間區間：[開始時間, 結束時間]

元素數量：2

成功響應

數據模型：CommonResultPageResultOpenSubAccountFlowResponse

響應欄位

code

integer

說明

錯誤碼

msg

string

說明

錯誤提示，用戶可閱讀

message

string

data

對象（PageResultOpenSubAccountFlowResponse）

查看子欄位

total

integer (int64)

說明

總量

list

數組<對象（OpenSubAccountFlowResponse）>

說明

數據

切換子賬戶卡渠道

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

切換指定子賬戶使用的卡片渠道，後續開卡將使用更新後的渠道。

請求頭

X-API-Key

string必填

說明

API 密鑰

範例

{{APIKey}}

X-Timestamp

integer必填

說明

Unix 時間戳，單位爲秒

範例

{{Timestamp}}

X-Nonce

string必填

說明

請求隨機值

範例

{{Nonce}}

X-Signature

string必填

說明

請求籤名

範例

{{Signature}}

Content-Type

string必填

說明

請求內容類型

範例

application/json

請求體

請求體格式：application/json

subAccountId

string必填

說明

子賬戶編號，最大長度爲 64 個字符

範例或默認值

210945783621084760102

targetProviderName

string必填

說明

目標卡渠道 ID，請填寫 ORBSIS 提供的可用渠道 ID

範例或默認值

ORBSIS_A

可用卡渠道 ID 以 ORBSIS 提供的配置為準。

請求體範例

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

cURL 範例

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"}'

成功響應

HTTP 狀態碼：200

切換成功後，響應體爲空對象。

{}

創建子賬戶​

請求頭​

請求體​

成功響應​

響應欄位​

子賬戶分頁查詢​

請求頭​

請求體​

成功響應​

響應欄位​

子賬戶詳情​

請求頭​

請求體​

成功響應​

響應欄位​

啓停子賬戶​

請求頭​

請求體​

成功響應​

響應欄位​

修改子賬戶名稱​

請求頭​

請求體​

成功響應​

響應欄位​

查詢子賬戶資金流水​

請求頭​

請求體​

成功響應​

響應欄位​

切換子賬戶卡渠道​

請求頭​

請求體​

成功響應​

創建子賬戶

請求頭

請求體

成功響應

響應欄位

子賬戶分頁查詢

請求頭

請求體

成功響應

響應欄位

子賬戶詳情

請求頭

請求體

成功響應

響應欄位

啓停子賬戶

請求頭

請求體

成功響應

響應欄位

修改子賬戶名稱

請求頭

請求體

成功響應

響應欄位

查詢子賬戶資金流水

請求頭

請求體

成功響應

響應欄位

切換子賬戶卡渠道

請求頭

請求體

成功響應