Skip to main content

子賬戶接口

創建子賬戶​

POST /abc/v1/sub-account/create

創建子賬戶

請求頭

名稱類型必填說明範例
X-API-Keystring否-{apiKey}
X-Timestampinteger否-{{Timestamp}}
X-Noncestring否-{{Nonce}}
X-Signaturestring否-{{Signature}}
Content-Typestring否-application/json

請求體

數據模型:OpenSubAccountCreateRequest

欄位類型必填說明範例 / 默認值
subAccountNamestring是子賬戶名稱RD-SubAccount
currencystring否幣種USD
subAccountAmountnumber否初始金額(單位:分)10000
parentAccountIdstring否主賬戶錢包編號-

成功響應

數據模型:CommonResultOpenSubAccountResponse

欄位類型必填說明範例 / 默認值
codeinteger否錯誤碼-
msgstring否錯誤提示,用戶可閱讀-
messagestring否--
data對象(OpenSubAccountResponse)否--

data 結構(OpenSubAccountResponse)

欄位類型必填說明範例 / 默認值
subAccountIdstring否子賬戶唯一編號-
subAccountNamestring否子賬戶名稱-
parentAccountIdstring否主賬戶編號-
currencystring否幣種USD
statusinteger否賬戶狀態:1=正常,2=已銷戶,3=凍結-
bookAmountnumber否賬面金額(分)-
availableAmountnumber否可用金額(分)-
spendAmountnumber否已消費金額(分)-
budgetAvailableLimitnumber否可用預算額度(分)-
budgetTotalLimitnumber否預算總額度(分)-
createTimestring否創建時間-
frozenAmountnumber否凍結金額,單位:分(cent/minor unit),整數-

子賬戶分頁查詢​

POST /abc/v1/sub-account/query

子賬戶分頁查詢

請求頭

名稱類型必填說明範例
X-API-Keystring否-{apiKey}
X-Timestampinteger否-{{Timestamp}}
X-Noncestring否-{{Nonce}}
X-Signaturestring否-{{Signature}}
Content-Typestring否-application/json

請求體

數據模型:OpenSubAccountPageRequest

欄位類型必填說明範例 / 默認值
pageNointeger是頁碼,從 1 開始;最小值 11
pageSizeinteger是每頁條數,最大值爲 200;最小值 110
subAccountIdstring否子賬戶編號SUB_001
subAccountNamestring否子賬戶名稱研發子賬戶

成功響應

數據模型:CommonResultPageResultOpenSubAccountResponse

欄位類型必填說明範例 / 默認值
codeinteger否錯誤碼-
msgstring否錯誤提示,用戶可閱讀-
messagestring否--
data對象(PageResultOpenSubAccountResponse)否--

data 結構(PageResultOpenSubAccountResponse)

欄位類型必填說明範例 / 默認值
totalinteger (int64)否總量-
list數組<對象(OpenSubAccountResponse)>否數據-

子賬戶詳情​

POST /abc/v1/sub-account/detail

子賬戶詳情

請求頭

名稱類型必填說明範例
X-API-Keystring否-{apiKey}
X-Timestampinteger否-{{Timestamp}}
X-Noncestring否-{{Nonce}}
X-Signaturestring否-{{Signature}}
Content-Typestring否-application/json

請求體

數據模型:OpenSubAccountDetailRequest

欄位類型必填說明範例 / 默認值
subAccountIdstring是子賬戶編號SUB_001

成功響應

數據模型:CommonResultOpenSubAccountResponse

欄位類型必填說明範例 / 默認值
codeinteger否錯誤碼-
msgstring否錯誤提示,用戶可閱讀-
messagestring否--
data對象(OpenSubAccountResponse)否--

data 結構(OpenSubAccountResponse)

欄位類型必填說明範例 / 默認值
subAccountIdstring否子賬戶唯一編號-
subAccountNamestring否子賬戶名稱-
parentAccountIdstring否主賬戶編號-
currencystring否幣種USD
statusinteger否賬戶狀態:1=正常,2=已銷戶,3=凍結-
bookAmountnumber否賬面金額(分)-
availableAmountnumber否可用金額(分)-
spendAmountnumber否已消費金額(分)-
budgetAvailableLimitnumber否可用預算額度(分)-
budgetTotalLimitnumber否預算總額度(分)-
createTimestring否創建時間-
frozenAmountnumber否凍結金額,單位:分(cent/minor unit),整數-

啓停子賬戶​

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

啓停子賬戶

請求頭

名稱類型必填說明範例
X-API-Keystring否-{apiKey}
X-Timestampinteger否-{{Timestamp}}
X-Noncestring否-{{Nonce}}
X-Signaturestring否-{{Signature}}
Content-Typestring否-application/json

請求體

數據模型:OpenSubAccountStatusUpdateRequest

欄位類型必填說明範例 / 默認值
subAccountIdstring是子賬戶編號SUB_001
accountStatusinteger是目標賬戶狀態:1=啓用,4=停用4
disableReasonstring否停用原因,accountStatus=4 時建議填寫BUSINESS_LINE_CLOSED
remarkstring否操作備註業務線關閉,子賬戶停用

成功響應

數據模型:CommonResultOpenSubAccountResponse

欄位類型必填說明範例 / 默認值
codeinteger否錯誤碼-
msgstring否錯誤提示,用戶可閱讀-
messagestring否--
data對象(OpenSubAccountResponse)否--

data 結構(OpenSubAccountResponse)

欄位類型必填說明範例 / 默認值
subAccountIdstring否子賬戶唯一編號-
subAccountNamestring否子賬戶名稱-
parentAccountIdstring否主賬戶編號-
currencystring否幣種USD
statusinteger否賬戶狀態:1=正常,2=已銷戶,3=凍結-
bookAmountnumber否賬面金額(分)-
availableAmountnumber否可用金額(分)-
spendAmountnumber否已消費金額(分)-
budgetAvailableLimitnumber否可用預算額度(分)-
budgetTotalLimitnumber否預算總額度(分)-
createTimestring否創建時間-
frozenAmountnumber否凍結金額,單位:分(cent/minor unit),整數-

修改子賬戶名稱​

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

修改子賬戶名稱

請求頭

名稱類型必填說明範例
X-API-Keystring否-{apiKey}
X-Timestampinteger否-{{Timestamp}}
X-Noncestring否-{{Nonce}}
X-Signaturestring否-{{Signature}}
Content-Typestring否-application/json

請求體

數據模型:OpenSubAccountUpdateNameRequest

欄位類型必填說明範例 / 默認值
subAccountIdstring是子賬戶編號SUB_001
subAccountNamestring是子賬戶新名稱研發子賬戶

成功響應

數據模型:CommonResultBoolean

欄位類型必填說明範例 / 默認值
codeinteger否錯誤碼-
msgstring否錯誤提示,用戶可閱讀-
messagestring否--
databoolean否返回數據-

查詢子賬戶資金流水​

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

查詢子賬戶資金流水

請求頭

名稱類型必填說明範例
X-API-Keystring否-{apiKey}
X-Timestampinteger否-{{Timestamp}}
X-Noncestring否-{{Nonce}}
X-Signaturestring否-{{Signature}}
Content-Typestring否-application/json

請求體

數據模型:OpenSubAccountFlowQueryRequest

欄位類型必填說明範例 / 默認值
pageNointeger是頁碼,從 1 開始;最小值 11
pageSizeinteger是每頁條數,最大值爲 200;最小值 110
subAccountFlowIdstring否子賬戶資金流水編號SF20260101000001
subAccountIdstring否子賬戶編號SUB_001
subAccountNamestring否子賬戶名稱研發子賬戶
currencystring否幣種編碼 ISO 4217USD
transTypeinteger否交易類型:1=轉出,2=轉入,3=消費,4=消費退款,5=凍結,6=解凍,7=調增,8=調減,9=分配預算3
transStatusinteger否交易狀態:1=成功,2=失敗,3=待處理,4=處理中;最小值 1;最大值 41
transactionTime數組<string>否交易時間區間,長度爲 2 的數組:[開始時間, 結束時間]-

成功響應

數據模型:CommonResultPageResultOpenSubAccountFlowResponse

欄位類型必填說明範例 / 默認值
codeinteger否錯誤碼-
msgstring否錯誤提示,用戶可閱讀-
messagestring否--
data對象(PageResultOpenSubAccountFlowResponse)否--

data 結構(PageResultOpenSubAccountFlowResponse)

欄位類型必填說明範例 / 默認值
totalinteger (int64)否總量-
list數組<對象(OpenSubAccountFlowResponse)>否數據-

切換子賬戶卡渠道​

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

切換子賬戶卡渠道

請求頭

名稱類型必填說明範例
X-API-Keystring是API 密鑰{{APIKey}}
X-Timestampinteger是Unix 時間戳,單位爲秒{{Timestamp}}
X-Noncestring是請求隨機值{{Nonce}}
X-Signaturestring是請求籤名{{Signature}}
Content-Typestring是請求內容類型application/json

請求體

請求體格式:application/json

欄位類型必填說明範例或默認值
subAccountIdstring是子賬戶編號,最大長度爲 64 個字符SUB_001
targetProviderNamestring是目標卡渠道名稱。支援:slash、billslash

支援的卡渠道: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

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

{}