子賬戶接口
創建子賬戶
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 | 是 | 目標卡渠道名稱。支援:slash、bill | slash |
支援的卡渠道:slash、bill。
請求體範例
{ "subAccountId": "SUB_001", "targetProviderName": "slash" }
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":"slash"}'
成功響應
HTTP 狀態碼:200
切換成功後,響應體爲空對象。
{}