跳至主要内容

卡管理接口

同步創建單張虛擬卡(同步返回卡信息)​

POST /abc/v1/card/create

同步創建單張虛擬卡(同步返回卡信息)

請求頭

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

請求體

數據模型:OpenCardSyncCreateRequest

欄位類型必填說明範例 / 默認值
budgetIdstring是預算 IDBUD_20260101_001
cardNamestring是卡名稱RD-Test-Card
cardHolderNamestring是持卡人姓名Zhang San
cardBinCodestring是卡 BIN 碼(卡號前6-8位),如 622202440299
isSharedCardinteger否卡類型:1=共享卡(缺省),2=限額卡1
cardSpendLimitnumber否單卡限額(單位:分,整數)。限額卡必填;共享卡禁止傳入;最小值 -9999999999;最大值 9999999999-

成功響應

數據模型:CommonResultOpenCardResponse

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

data 結構(OpenCardResponse)

欄位類型必填說明範例 / 默認值
cardInfoIdstring否虛擬卡唯一編號-
cardNamestring否卡名稱-
cardBinCodestring否卡 BIN 碼-
cardNostring否掩藏卡號(BIN + ***** + 後四位)-
lastFourstring否卡後四位-
expirationYearstring否過期年份-
expirationMonthstring否過期月份-
cvvNumstring否加密 CVV-
cardSchemestring否卡組織:VISA、MASTERCARD、UnionPay、JCB-
cardHolderNamestring否持卡人-
currencystring否幣種 ISO 4217USD
cardStatusinteger否卡狀態:0=禁用,1=正常,2=掛失,3=註銷-
isSharedCardinteger否是否共享卡:1=是(共享預算池),2=否(獨立限額卡)-
cardSpendLimitnumber否卡消費限額(限額卡專用;共享卡爲 0)-
totalSpendAmountnumber否卡累計消費金額-
serviceFeeAmountnumber否開卡手續費-
budgetIdstring否關聯預算編號-
budgetNamestring否關聯預算名稱-
subAccountIdstring否關聯子賬戶編號-
subAccountNamestring否關聯子賬戶名稱-
createTimestring否創建時間-
updateTimestring否更新時間-

查詢卡列表​

POST /abc/v1/card/query

查詢卡列表

請求頭

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

請求體

數據模型:OpenCardQueryRequest

欄位類型必填說明範例 / 默認值
pageNointeger是頁碼,從 1 開始;最小值 11
pageSizeinteger是每頁條數,最大值爲 200;最小值 110
cardNamestring否卡名稱-

成功響應

數據模型:CommonResultPageResultOpenCardResponse

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

data 結構(PageResultOpenCardResponse)

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

更新卡片(卡名稱 / 卡類型 / 限額)​

POST /abc/v1/card/edit

更新卡片(卡名稱 / 卡類型 / 限額)

請求頭

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

請求體

數據模型:OpenCardEditRequest

欄位類型必填說明範例 / 默認值
cardInfoIdstring是虛擬卡唯一編號29364
cardNamestring否卡名稱,不傳則不修改-
isSharedCardinteger是是否共享卡:1=共享卡,2=限額卡1
cardSpendLimitnumber否卡消費限額(單位:分),目標類型爲限額卡時必傳;轉爲共享卡時不傳;最小值 -9999999999;最大值 9999999999-

成功響應

數據模型:CommonResultOpenCardResponse

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

data 結構(OpenCardResponse)

欄位類型必填說明範例 / 默認值
cardInfoIdstring否虛擬卡唯一編號-
cardNamestring否卡名稱-
cardBinCodestring否卡 BIN 碼-
cardNostring否掩藏卡號(BIN + ***** + 後四位)-
lastFourstring否卡後四位-
expirationYearstring否過期年份-
expirationMonthstring否過期月份-
cvvNumstring否加密 CVV-
cardSchemestring否卡組織:VISA、MASTERCARD、UnionPay、JCB-
cardHolderNamestring否持卡人-
currencystring否幣種 ISO 4217USD
cardStatusinteger否卡狀態:0=禁用,1=正常,2=掛失,3=註銷-
isSharedCardinteger否是否共享卡:1=是(共享預算池),2=否(獨立限額卡)-
cardSpendLimitnumber否卡消費限額(限額卡專用;共享卡爲 0)-
totalSpendAmountnumber否卡累計消費金額-
serviceFeeAmountnumber否開卡手續費-
budgetIdstring否關聯預算編號-
budgetNamestring否關聯預算名稱-
subAccountIdstring否關聯子賬戶編號-
subAccountNamestring否關聯子賬戶名稱-
createTimestring否創建時間-
updateTimestring否更新時間-

更新虛擬卡狀態(啓用 / 禁用)​

POST /abc/v1/card/update-status

更新虛擬卡狀態(啓用 / 禁用)

請求頭

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

請求體

數據模型:OpenCardUpdateStatusRequest

欄位類型必填說明範例 / 默認值
cardInfoIdstring是虛擬卡唯一編號29364
cardStatusinteger是卡狀態:1=正常,2=禁用2

成功響應

數據模型:CommonResultOpenCardResponse

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

data 結構(OpenCardResponse)

欄位類型必填說明範例 / 默認值
cardInfoIdstring否虛擬卡唯一編號-
cardNamestring否卡名稱-
cardBinCodestring否卡 BIN 碼-
cardNostring否掩藏卡號(BIN + ***** + 後四位)-
lastFourstring否卡後四位-
expirationYearstring否過期年份-
expirationMonthstring否過期月份-
cvvNumstring否加密 CVV-
cardSchemestring否卡組織:VISA、MASTERCARD、UnionPay、JCB-
cardHolderNamestring否持卡人-
currencystring否幣種 ISO 4217USD
cardStatusinteger否卡狀態:0=禁用,1=正常,2=掛失,3=註銷-
isSharedCardinteger否是否共享卡:1=是(共享預算池),2=否(獨立限額卡)-
cardSpendLimitnumber否卡消費限額(限額卡專用;共享卡爲 0)-
totalSpendAmountnumber否卡累計消費金額-
serviceFeeAmountnumber否開卡手續費-
budgetIdstring否關聯預算編號-
budgetNamestring否關聯預算名稱-
subAccountIdstring否關聯子賬戶編號-
subAccountNamestring否關聯子賬戶名稱-
createTimestring否創建時間-
updateTimestring否更新時間-

查詢卡詳情​

POST /abc/v1/card/detail

查詢卡詳情

請求頭

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

請求體

數據模型:OpenCardDetailRequest

欄位類型必填說明範例 / 默認值
cardInfoIdstring是卡主鍵 ID1024

成功響應

數據模型:CommonResultOpenCardResponse

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

data 結構(OpenCardResponse)

欄位類型必填說明範例 / 默認值
cardInfoIdstring否虛擬卡唯一編號-
cardNamestring否卡名稱-
cardBinCodestring否卡 BIN 碼-
cardNostring否掩藏卡號(BIN + ***** + 後四位)-
lastFourstring否卡後四位-
expirationYearstring否過期年份-
expirationMonthstring否過期月份-
cvvNumstring否加密 CVV-
cardSchemestring否卡組織:VISA、MASTERCARD、UnionPay、JCB-
cardHolderNamestring否持卡人-
currencystring否幣種 ISO 4217USD
cardStatusinteger否卡狀態:0=禁用,1=正常,2=掛失,3=註銷-
isSharedCardinteger否是否共享卡:1=是(共享預算池),2=否(獨立限額卡)-
cardSpendLimitnumber否卡消費限額(限額卡專用;共享卡爲 0)-
totalSpendAmountnumber否卡累計消費金額-
serviceFeeAmountnumber否開卡手續費-
budgetIdstring否關聯預算編號-
budgetNamestring否關聯預算名稱-
subAccountIdstring否關聯子賬戶編號-
subAccountNamestring否關聯子賬戶名稱-
createTimestring否創建時間-
updateTimestring否更新時間-

卡管理:註銷卡片​

POST /abc/v1/card/cancel

卡管理:註銷卡片

請求頭

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

請求體

數據模型:OpenCardCancelRequest

欄位類型必填說明範例 / 默認值
cardIdstring是--

成功響應

數據模型:CommonResultBoolean

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

查詢卡 BIN​

查詢卡 BIN。

請求地址:POST https://open.orbsis.com/abc/v1/card/bin/query

請求頭

欄位位置類型範例或說明
X-API-KeyHeaderstring{{APIKey}}
X-TimestampHeaderinteger{{Timestamp}}
X-NonceHeaderstring{{Nonce}}
X-SignatureHeaderstring{{Signature}}
Content-TypeHeaderstringapplication/json

請求參數

欄位類型必填說明與約束範例或默認值
pageNointeger是頁碼,從 1 開始;最小值爲 1。默認值:1;範例:1
pageSizeinteger是每頁條數,最大值爲 200;最小值爲 1。默認值:10;範例:10
merchantIdstring否商戶號。4416
cardBinCodestring否卡 BIN 碼。448213
statusinteger否狀態。-
currencystring否幣種。USD
countrystring否國家。US
cardGroupstring否卡組織。VISA

cURL 範例:

curl --request POST 'https://open.orbsis.com/abc/v1/card/bin/query' \
--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 '{"pageNo":1,"pageSize":10,"merchantId":"4416","cardBinCode":"448213","status":1,"currency":"USD","country":"US","cardGroup":"VISA"}'

請求體範例:

{
"pageNo": 1,
"pageSize": 10,
"merchantId": "4416",
"cardBinCode": "448213",
"status": 1,
"currency": "USD",
"country": "US",
"cardGroup": "VISA"
}

響應欄位

欄位路徑類型必填說明
codeinteger否錯誤碼
msgstring否錯誤提示,用戶可閱讀
messagestring否訊息欄位
dataobject否返回數據
data.totalinteger(int64)否總量
data.listarray否數據列表
data.list[].idinteger(int64)否主鍵 ID;範例:7163
data.list[].parameterIdstring否產品編號;範例:22597
data.list[].cardBinstring否卡 BIN 碼
data.list[].issuerstring否髮卡商
data.list[].cardFeenumber否開卡費用
data.list[].maxCardNuminteger否最大開卡數量
data.list[].statusinteger否狀態:0 - 不可用,1 - 可用;範例:1
data.list[].effectiveTimestring否生效時間
data.list[].failureTimestring否失效時間
data.list[].createTimestring否創建時間
data.list[].currencystring否幣種
data.list[].countrystring否國家
data.list[].cardGroupstring否卡組織
data.list[].totalIssuedCountinteger(int64)否已開卡數量
data.list[].providerDefaultinteger否是否爲默認渠道:2 - 否,1 - 是;範例:1
data.list[].isEnabledinteger否渠道是否啓用:2 - 禁用,1 - 啓用;範例:1

成功響應範例:

{
"code": 0,
"msg": "success",
"message": "success",
"data": {
"total": 1,
"list": [
{
"id": 7163,
"parameterId": "22597",
"cardBin": "448213",
"issuer": "string",
"cardFee": 100,
"maxCardNum": 1,
"status": 1,
"effectiveTime": "string",
"failureTime": "string",
"createTime": "string",
"currency": "USD",
"country": "US",
"cardGroup": "VISA",
"totalIssuedCount": 1,
"providerDefault": 1,
"isEnabled": 1
}
]
}
}