> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 銀行卡二要素核驗 API 對接說明

> Identity Authentication 集成指南 - XHuoAPI

本文將介紹一種 銀行卡二要素核驗 API 對接說明，它可用於校驗姓名和銀行卡號的真實性和一致性。

## 申請流程

要使用 API，需要先到 [銀行卡二要素核驗 API](https://api.xhuoapi.ai/documents/06efe2aa-5443-4dcc-af2f-28236bfb2158) 對應頁面申請對應的服務，進入頁面之後，點擊「Acquire」按鈕，如圖所示：

![](https://cdn.xhuoapi.ai/q6ytrc.png)

如果你尚未登入或註冊，會自動跳轉到登入頁面邀請您來註冊和登入，登入註冊之後會自動返回當前頁面。

在首次申請時會有免費額度贈送，可以免費使用該 API。

## 基本使用

首先先了解下基本的使用方式，就是輸入銀行卡的卡號信息，便可獲得處理後結果圖片，首先需要簡單地傳遞一個 `bank_card` 欄位。我們接下來就可以在介面上填寫對應的內容，如圖所示：

<p>
  <img src="https://cdn.xhuoapi.ai/u9bugq.png" width="500" className="m-auto" />
</p>

可以看到這裡我們設定了 Request Headers，包括：

* `accept`：想要接收怎樣格式的響應結果，這裡填寫為 `application/json`，即 JSON 格式。
* `authorization`：調用 API 的密鑰，申請之後可以直接下拉選擇。

另外設定了 Request Body，包括：

* `bank_card`：需要處理的銀行卡號信息，是必選參數。
* `name`：用戶的姓名，是必選參數。
* `encryption`：可選，敏感字段加密參數（如需上送密文）。

選擇之後，可以發現右側也生成了對應代碼，如圖所示：

<p>
  <img src="https://cdn.xhuoapi.ai/yn8yxf.png" width="500" className="m-auto" />
</p>

點擊「Try」按鈕即可進行測試，如上圖所示，這裡我們就得到了如下結果：

```json theme={null}
{
  "result": "0",
  "description": "認證通過"
}
```

返回結果一共有多個字段，介紹如下：

* `result `，認證結果碼，收費情況如下。
  * 收費結果碼：
    * 0: 認證通過
    * -1: 認證未通過
    * -4: 持卡人信息有誤
    * -5: 未開通無卡支付
    * -6: 此卡被沒收
    * -7: 無效卡號
    * -8: 此卡無對應發卡行
    * -9: 該卡未初始化或睡眠卡
    * -10: 作弊卡、吞卡
    * -11: 此卡已掛失
    * -12: 該卡已過期
    * -13: 受限制的卡
    * -14: 密碼錯誤次數超限
    * -15: 發卡行不支持此交易
  * 不收費結果碼：
    * -2: 姓名校驗不通過
    * -3: 銀行卡號碼有誤
    * -16: 驗證中心服務繁忙
    * -17: 驗證次數超限，請次日重試
* `description`，業務結果描述。

可以看出這張銀行卡的姓名和銀行卡號的真實性和一致性已經通過了。

另外如果想生成對應的對接代碼，可以直接複製生成，例如 CURL 的代碼如下：

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/bankcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "bank_card": "***"
}'
```

Python 的對接代碼如下：

```python theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/bankcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "bank_card": "***"
}'
```

## 錯誤處理

在調用 API 時，如果遇到錯誤，API 會返回相應的錯誤代碼和信息。例如：

* `400 token_mismatched`：Bad request, possibly due to missing or invalid parameters.
* `400 api_not_implemented`：Bad request, possibly due to missing or invalid parameters.
* `401 invalid_token`：Unauthorized, invalid or missing authorization token.
* `429 too_many_requests`：Too many requests, you have exceeded the rate limit.
* `500 api_error`：Internal server error, something went wrong on the server.

### 錯誤響應示例

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## 結論

通過本文檔，您已經了解了如何使用 銀行卡二要素核驗 API 進行校驗姓名和銀行卡號的真實性和一致性。希望本文檔能幫助您更好地對接和使用該 API。如有任何問題，請隨時聯繫我們的技術支持團隊。