跳至主要內容

卡管理接口

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

POST /abc/v1/card/create

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

請求頭

X-API-Key
string否
說明
-
範例
{apiKey}
X-Timestamp
integer否
說明
-
範例
{{Timestamp}}
X-Nonce
string否
說明
-
範例
{{Nonce}}
X-Signature
string否
說明
-
範例
{{Signature}}
Content-Type
string否
說明
-
範例
application/json

請求體

數據模型:OpenCardSyncCreateRequest

budgetId
string是
說明
預算 ID
範例 / 默認值
BUD_20260101_001
cardName
string是
說明
卡名稱
範例 / 默認值
RD-Test-Card
cardHolderName
string是
說明
持卡人姓名
範例 / 默認值
Zhang San
cardBinCode
string是
說明
卡 BIN 碼(卡號前6-8位),如 622202
範例 / 默認值
440299
isSharedCard
integer否
說明
卡類型:1=共享卡(缺省),2=限額卡
範例 / 默認值
1
cardSpendLimit
number否
說明
單卡限額(單位:分,整數)。限額卡必填;共享卡禁止傳入;最小值 -9999999999;最大值 9999999999
範例 / 默認值
-

成功響應

數據模型:CommonResultOpenCardResponse

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

data 結構(OpenCardResponse)

cardInfoId
string否
說明
虛擬卡唯一編號
範例 / 默認值
-
cardName
string否
說明
卡名稱
範例 / 默認值
-
cardBinCode
string否
說明
卡 BIN 碼
範例 / 默認值
-
cardNo
string否
說明
掩藏卡號(BIN + ***** + 後四位)
範例 / 默認值
-
lastFour
string否
說明
卡後四位
範例 / 默認值
-
expirationYear
string否
說明
過期年份
範例 / 默認值
-
expirationMonth
string否
說明
過期月份
範例 / 默認值
-
cvvNum
string否
說明
加密 CVV
範例 / 默認值
-
cardScheme
string否
說明
卡組織:VISA、MASTERCARD、UnionPay、JCB
範例 / 默認值
-
cardHolderName
string否
說明
持卡人
範例 / 默認值
-
currency
string否
說明
幣種 ISO 4217
範例 / 默認值
USD
cardStatus
integer否
說明
卡狀態:0=禁用,1=正常,2=掛失,3=註銷
範例 / 默認值
-
isSharedCard
integer否
說明
是否共享卡:1=是(共享預算池),2=否(獨立限額卡)
範例 / 默認值
-
cardSpendLimit
number否
說明
卡消費限額(限額卡專用;共享卡爲 0)
範例 / 默認值
-
totalSpendAmount
number否
說明
卡累計消費金額
範例 / 默認值
-
serviceFeeAmount
number否
說明
開卡手續費
範例 / 默認值
-
budgetId
string否
說明
關聯預算編號
範例 / 默認值
-
budgetName
string否
說明
關聯預算名稱
範例 / 默認值
-
subAccountId
string否
說明
關聯子賬戶編號
範例 / 默認值
-
subAccountName
string否
說明
關聯子賬戶名稱
範例 / 默認值
-
createTime
string否
說明
創建時間
範例 / 默認值
-
updateTime
string否
說明
更新時間
範例 / 默認值
-

查詢卡列表​

POST /abc/v1/card/query

查詢卡列表

請求頭

X-API-Key
string否
說明
-
範例
{apiKey}
X-Timestamp
integer否
說明
-
範例
{{Timestamp}}
X-Nonce
string否
說明
-
範例
{{Nonce}}
X-Signature
string否
說明
-
範例
{{Signature}}
Content-Type
string否
說明
-
範例
application/json

請求體

數據模型:OpenCardQueryRequest

pageNo
integer是
說明
頁碼,從 1 開始;最小值 1
範例 / 默認值
1
pageSize
integer是
說明
每頁條數,最大值爲 200;最小值 1
範例 / 默認值
10
cardName
string否
說明
卡名稱
範例 / 默認值
-

成功響應

數據模型:CommonResultPageResultOpenCardResponse

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

data 結構(PageResultOpenCardResponse)

total
integer (int64)否
說明
總量
範例 / 默認值
-
list
數組<對象(OpenCardResponse)>否
說明
數據
範例 / 默認值
-

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

POST /abc/v1/card/edit

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

請求頭

X-API-Key
string否
說明
-
範例
{apiKey}
X-Timestamp
integer否
說明
-
範例
{{Timestamp}}
X-Nonce
string否
說明
-
範例
{{Nonce}}
X-Signature
string否
說明
-
範例
{{Signature}}
Content-Type
string否
說明
-
範例
application/json

請求體

數據模型:OpenCardEditRequest

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

成功響應

數據模型:CommonResultOpenCardResponse

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

data 結構(OpenCardResponse)

cardInfoId
string否
說明
虛擬卡唯一編號
範例 / 默認值
-
cardName
string否
說明
卡名稱
範例 / 默認值
-
cardBinCode
string否
說明
卡 BIN 碼
範例 / 默認值
-
cardNo
string否
說明
掩藏卡號(BIN + ***** + 後四位)
範例 / 默認值
-
lastFour
string否
說明
卡後四位
範例 / 默認值
-
expirationYear
string否
說明
過期年份
範例 / 默認值
-
expirationMonth
string否
說明
過期月份
範例 / 默認值
-
cvvNum
string否
說明
加密 CVV
範例 / 默認值
-
cardScheme
string否
說明
卡組織:VISA、MASTERCARD、UnionPay、JCB
範例 / 默認值
-
cardHolderName
string否
說明
持卡人
範例 / 默認值
-
currency
string否
說明
幣種 ISO 4217
範例 / 默認值
USD
cardStatus
integer否
說明
卡狀態:0=禁用,1=正常,2=掛失,3=註銷
範例 / 默認值
-
isSharedCard
integer否
說明
是否共享卡:1=是(共享預算池),2=否(獨立限額卡)
範例 / 默認值
-
cardSpendLimit
number否
說明
卡消費限額(限額卡專用;共享卡爲 0)
範例 / 默認值
-
totalSpendAmount
number否
說明
卡累計消費金額
範例 / 默認值
-
serviceFeeAmount
number否
說明
開卡手續費
範例 / 默認值
-
budgetId
string否
說明
關聯預算編號
範例 / 默認值
-
budgetName
string否
說明
關聯預算名稱
範例 / 默認值
-
subAccountId
string否
說明
關聯子賬戶編號
範例 / 默認值
-
subAccountName
string否
說明
關聯子賬戶名稱
範例 / 默認值
-
createTime
string否
說明
創建時間
範例 / 默認值
-
updateTime
string否
說明
更新時間
範例 / 默認值
-

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

POST /abc/v1/card/update-status

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

請求頭

X-API-Key
string否
說明
-
範例
{apiKey}
X-Timestamp
integer否
說明
-
範例
{{Timestamp}}
X-Nonce
string否
說明
-
範例
{{Nonce}}
X-Signature
string否
說明
-
範例
{{Signature}}
Content-Type
string否
說明
-
範例
application/json

請求體

數據模型:OpenCardUpdateStatusRequest

cardInfoId
string是
說明
虛擬卡唯一編號
範例 / 默認值
29364
cardStatus
integer是
說明
卡狀態:1=正常,2=禁用
範例 / 默認值
2

成功響應

數據模型:CommonResultOpenCardResponse

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

data 結構(OpenCardResponse)

cardInfoId
string否
說明
虛擬卡唯一編號
範例 / 默認值
-
cardName
string否
說明
卡名稱
範例 / 默認值
-
cardBinCode
string否
說明
卡 BIN 碼
範例 / 默認值
-
cardNo
string否
說明
掩藏卡號(BIN + ***** + 後四位)
範例 / 默認值
-
lastFour
string否
說明
卡後四位
範例 / 默認值
-
expirationYear
string否
說明
過期年份
範例 / 默認值
-
expirationMonth
string否
說明
過期月份
範例 / 默認值
-
cvvNum
string否
說明
加密 CVV
範例 / 默認值
-
cardScheme
string否
說明
卡組織:VISA、MASTERCARD、UnionPay、JCB
範例 / 默認值
-
cardHolderName
string否
說明
持卡人
範例 / 默認值
-
currency
string否
說明
幣種 ISO 4217
範例 / 默認值
USD
cardStatus
integer否
說明
卡狀態:0=禁用,1=正常,2=掛失,3=註銷
範例 / 默認值
-
isSharedCard
integer否
說明
是否共享卡:1=是(共享預算池),2=否(獨立限額卡)
範例 / 默認值
-
cardSpendLimit
number否
說明
卡消費限額(限額卡專用;共享卡爲 0)
範例 / 默認值
-
totalSpendAmount
number否
說明
卡累計消費金額
範例 / 默認值
-
serviceFeeAmount
number否
說明
開卡手續費
範例 / 默認值
-
budgetId
string否
說明
關聯預算編號
範例 / 默認值
-
budgetName
string否
說明
關聯預算名稱
範例 / 默認值
-
subAccountId
string否
說明
關聯子賬戶編號
範例 / 默認值
-
subAccountName
string否
說明
關聯子賬戶名稱
範例 / 默認值
-
createTime
string否
說明
創建時間
範例 / 默認值
-
updateTime
string否
說明
更新時間
範例 / 默認值
-

查詢卡詳情​

POST /abc/v1/card/detail

查詢卡詳情

請求頭

X-API-Key
string否
說明
-
範例
{apiKey}
X-Timestamp
integer否
說明
-
範例
{{Timestamp}}
X-Nonce
string否
說明
-
範例
{{Nonce}}
X-Signature
string否
說明
-
範例
{{Signature}}
Content-Type
string否
說明
-
範例
application/json

請求體

數據模型:OpenCardDetailRequest

cardInfoId
string是
說明
卡主鍵 ID
範例 / 默認值
1024

成功響應

數據模型:CommonResultOpenCardResponse

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

data 結構(OpenCardResponse)

cardInfoId
string否
說明
虛擬卡唯一編號
範例 / 默認值
-
cardName
string否
說明
卡名稱
範例 / 默認值
-
cardBinCode
string否
說明
卡 BIN 碼
範例 / 默認值
-
cardNo
string否
說明
掩藏卡號(BIN + ***** + 後四位)
範例 / 默認值
-
lastFour
string否
說明
卡後四位
範例 / 默認值
-
expirationYear
string否
說明
過期年份
範例 / 默認值
-
expirationMonth
string否
說明
過期月份
範例 / 默認值
-
cvvNum
string否
說明
加密 CVV
範例 / 默認值
-
cardScheme
string否
說明
卡組織:VISA、MASTERCARD、UnionPay、JCB
範例 / 默認值
-
cardHolderName
string否
說明
持卡人
範例 / 默認值
-
currency
string否
說明
幣種 ISO 4217
範例 / 默認值
USD
cardStatus
integer否
說明
卡狀態:0=禁用,1=正常,2=掛失,3=註銷
範例 / 默認值
-
isSharedCard
integer否
說明
是否共享卡:1=是(共享預算池),2=否(獨立限額卡)
範例 / 默認值
-
cardSpendLimit
number否
說明
卡消費限額(限額卡專用;共享卡爲 0)
範例 / 默認值
-
totalSpendAmount
number否
說明
卡累計消費金額
範例 / 默認值
-
serviceFeeAmount
number否
說明
開卡手續費
範例 / 默認值
-
budgetId
string否
說明
關聯預算編號
範例 / 默認值
-
budgetName
string否
說明
關聯預算名稱
範例 / 默認值
-
subAccountId
string否
說明
關聯子賬戶編號
範例 / 默認值
-
subAccountName
string否
說明
關聯子賬戶名稱
範例 / 默認值
-
createTime
string否
說明
創建時間
範例 / 默認值
-
updateTime
string否
說明
更新時間
範例 / 默認值
-

卡管理:註銷卡片​

POST /abc/v1/card/cancel

卡管理:註銷卡片

請求頭

X-API-Key
string否
說明
-
範例
{apiKey}
X-Timestamp
integer否
說明
-
範例
{{Timestamp}}
X-Nonce
string否
說明
-
範例
{{Nonce}}
X-Signature
string否
說明
-
範例
{{Signature}}
Content-Type
string否
說明
-
範例
application/json

請求體

數據模型:OpenCardCancelRequest

cardId
string是
說明
-
範例 / 默認值
-

成功響應

數據模型:CommonResultBoolean

code
integer否
說明
錯誤碼
範例 / 默認值
-
msg
string否
說明
錯誤提示,用戶可閱讀
範例 / 默認值
-
message
string否
說明
-
範例 / 默認值
-
data
boolean否
說明
返回數據
範例 / 默認值
-

查詢卡 BIN​

查詢卡 BIN。

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

請求頭

X-API-Key
Headerstring
範例或說明
{{APIKey}}
X-Timestamp
Headerinteger
範例或說明
{{Timestamp}}
X-Nonce
Headerstring
範例或說明
{{Nonce}}
X-Signature
Headerstring
範例或說明
{{Signature}}
Content-Type
Headerstring
範例或說明
application/json

請求參數

pageNo
integer是
說明與約束
頁碼,從 1 開始;最小值爲 1。
範例或默認值
默認值:1;範例:1
pageSize
integer是
說明與約束
每頁條數,最大值爲 200;最小值爲 1。
範例或默認值
默認值:10;範例:10
merchantId
string否
說明與約束
商戶號。
範例或默認值
4416
cardBinCode
string否
說明與約束
卡 BIN 碼。
範例或默認值
448213
status
integer否
說明與約束
狀態。
範例或默認值
-
currency
string否
說明與約束
幣種。
範例或默認值
USD
country
string否
說明與約束
國家。
範例或默認值
US
cardGroup
string否
說明與約束
卡組織。
範例或默認值
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"
}

響應欄位

code
integer否
說明
錯誤碼
msg
string否
說明
錯誤提示,用戶可閱讀
message
string否
說明
訊息欄位
data
object否
說明
返回數據
data.total
integer(int64)否
說明
總量
data.list
array否
說明
數據列表
data.list[].id
integer(int64)否
說明
主鍵 ID;範例:7163
data.list[].parameterId
string否
說明
產品編號;範例:22597
data.list[].cardBin
string否
說明
卡 BIN 碼
data.list[].issuer
string否
說明
髮卡商
data.list[].cardFee
number否
說明
開卡費用
data.list[].maxCardNum
integer否
說明
最大開卡數量
data.list[].status
integer否
說明
狀態:0 - 不可用,1 - 可用;範例:1
data.list[].effectiveTime
string否
說明
生效時間
data.list[].failureTime
string否
說明
失效時間
data.list[].createTime
string否
說明
創建時間
data.list[].currency
string否
說明
幣種
data.list[].country
string否
說明
國家
data.list[].cardGroup
string否
說明
卡組織
data.list[].totalIssuedCount
integer(int64)否
說明
已開卡數量

成功響應範例:

{
"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
}
]
}
}