跳至主要內容

子賬戶接口

創建子賬戶​

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)否
說明
-
範例 / 默認值
-

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

子賬戶分頁查詢

請求頭

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
pageSize
integer是
說明
每頁條數,最大值爲 200;最小值 1
範例 / 默認值
10
subAccountId
string否
說明
子賬戶編號
範例 / 默認值
SUB_001
subAccountName
string否
說明
子賬戶名稱
範例 / 默認值
研發子賬戶

成功響應

數據模型:CommonResultPageResultOpenSubAccountResponse

code
integer否
說明
錯誤碼
範例 / 默認值
-
msg
string否
說明
錯誤提示,用戶可閱讀
範例 / 默認值
-
message
string否
說明
-
範例 / 默認值
-
data
對象(PageResultOpenSubAccountResponse)否
說明
-
範例 / 默認值
-

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是
說明
子賬戶編號
範例 / 默認值
SUB_001

成功響應

數據模型:CommonResultOpenSubAccountResponse

code
integer否
說明
錯誤碼
範例 / 默認值
-
msg
string否
說明
錯誤提示,用戶可閱讀
範例 / 默認值
-
message
string否
說明
-
範例 / 默認值
-
data
對象(OpenSubAccountResponse)否
說明
-
範例 / 默認值
-

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是
說明
子賬戶編號
範例 / 默認值
SUB_001
accountStatus
integer是
說明
目標賬戶狀態:1=啓用,4=停用
範例 / 默認值
4
disableReason
string否
說明
停用原因,accountStatus=4 時建議填寫
範例 / 默認值
BUSINESS_LINE_CLOSED
remark
string否
說明
操作備註
範例 / 默認值
業務線關閉,子賬戶停用

成功響應

數據模型:CommonResultOpenSubAccountResponse

code
integer否
說明
錯誤碼
範例 / 默認值
-
msg
string否
說明
錯誤提示,用戶可閱讀
範例 / 默認值
-
message
string否
說明
-
範例 / 默認值
-
data
對象(OpenSubAccountResponse)否
說明
-
範例 / 默認值
-

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是
說明
子賬戶編號
範例 / 默認值
SUB_001
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
pageSize
integer是
說明
每頁條數,最大值爲 200;最小值 1
範例 / 默認值
10
subAccountFlowId
string否
說明
子賬戶資金流水編號
範例 / 默認值
SF20260101000001
subAccountId
string否
說明
子賬戶編號
範例 / 默認值
SUB_001
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)否
說明
-
範例 / 默認值
-

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 個字符
範例或默認值
SUB_001
targetProviderName
string是
說明
目標卡渠道 ID,請填寫 ORBSIS 提供的可用渠道 ID
範例或默認值
ORBSIS_A

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

請求體範例

{ "subAccountId": "SUB_001", "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":"SUB_001","targetProviderName":"ORBSIS_A"}'

成功響應

HTTP 狀態碼:200

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

{}