卡管理接口
同步創建單張虛擬卡(同步返回卡信息)
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 | Header | string | {{APIKey}} |
| X-Timestamp | Header | integer | {{Timestamp}} |
| X-Nonce | Header | string | {{Nonce}} |
| X-Signature | Header | string | {{Signature}} |
| Content-Type | Header | string | 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) | 否 | 已開卡數量 |
| data.list[].providerDefault | integer | 否 | 是否爲默認渠道:2 - 否,1 - 是;範例:1 |
| data.list[].isEnabled | integer | 否 | 渠道是否啓用: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
}
]
}
}