> ## 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/3523988d-acba-4362-9def-105657991eb4) 해당 페이지에서 서비스를 신청해야 합니다. 페이지에 들어가면 "Acquire" 버튼을 클릭합니다, 아래 그림과 같이:

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

로그인 또는 등록이 되어 있지 않으면 자동으로 로그인 페이지로 이동하여 등록 및 로그인을 요청합니다. 로그인 및 등록 후에는 자동으로 현재 페이지로 돌아옵니다.

첫 신청 시 무료 한도가 제공되어 해당 API를 무료로 사용할 수 있습니다.

## 기본 사용

먼저 기본 사용 방식을 이해해야 합니다. 즉, 은행 카드 번호를 입력하면 처리된 후 검증 결과를 얻을 수 있습니다. 먼저 간단히 `bank_card` 필드를 전달해야 하며, 다음으로 화면에 해당 내용을 입력할 수 있습니다, 아래 그림과 같이:

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

여기서 설정한 Request Headers를 볼 수 있습니다, 포함된 내용은 다음과 같습니다:

* `accept`: 어떤 형식의 응답 결과를 받고 싶은지, 여기서는 `application/json`으로 작성하여 JSON 형식으로 설정합니다.
* `authorization`: API 호출을 위한 키, 신청 후 직접 드롭다운에서 선택할 수 있습니다.

또한 Request Body를 설정했습니다, 포함된 내용은 다음과 같습니다:

* `bank_card`: 은행 카드 번호.
* `encryption`: 선택 사항, 민감한 필드 암호화 매개변수(암호문 전송이 필요한 경우).

선택 후 오른쪽에 해당 코드가 생성된 것을 확인할 수 있습니다, 아래 그림과 같이:

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

"Try" 버튼을 클릭하면 테스트를 진행할 수 있습니다, 위 그림과 같이, 여기서 다음과 같은 결과를 얻었습니다:

```json theme={null}
{
  "result": "0",
  "description": "조회 성공",
  "account_bank": "공상은행",
  "account_type": 1
}
```

반환 결과는 여러 필드로 구성되어 있으며, 설명은 다음과 같습니다:

* `result`, 인증 결과 코드, 요금 상황은 다음과 같습니다.
  * 요금 결과 코드:
    * 0: 조회 성공
    * -1: 정보를 찾을 수 없음
  * 비요금 결과 코드:
    * -2: 인증 센터 서비스가 바쁨
    * -3: 은행 카드가 존재하지 않음
* `description`, 비즈니스 결과 설명.
* `account_bank`, 개설 은행.
* `account_type`, 카드 성격: 1. 직불 카드; 2. 신용 카드; 3. 선불 카드; 4. 준신용 카드.

은행 카드 기본 정보가 조회된 것을 확인할 수 있습니다.

또한 해당 연동 코드를 생성하고 싶다면 직접 복사하여 생성할 수 있습니다, 예를 들어 CURL의 코드는 다음과 같습니다:

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

Python의 연동 코드는 다음과 같습니다:

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/identity/bankcard/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "bank_card": "****"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

## 오류 처리

API를 호출할 때 오류가 발생하면 API는 해당 오류 코드와 정보를 반환합니다. 예를 들어:

* `400 token_mismatched`: 잘못된 요청, 누락되거나 잘못된 매개변수 때문일 수 있습니다.
* `400 api_not_implemented`: 잘못된 요청, 누락되거나 잘못된 매개변수 때문일 수 있습니다.
* `401 invalid_token`: 권한 없음, 잘못되었거나 누락된 인증 토큰.
* `429 too_many_requests`: 너무 많은 요청, 비율 제한을 초과했습니다.
* `500 api_error`: 내부 서버 오류, 서버에서 문제가 발생했습니다.

### 오류 응답 예시

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "가져오기 실패"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## 결론

본 문서를 통해 은행 카드 기본 정보 조회 API를 사용하여 입력한 은행 카드 번호로 은행 카드 기본 정보를 조회하는 방법을 이해하셨습니다. 본 문서가 귀하가 해당 API를 더 잘 연동하고 사용하는 데 도움이 되기를 바랍니다. 질문이 있으시면 언제든지 기술 지원 팀에 문의해 주시기 바랍니다.