빌키 조회 API
빌링 서비스 빌키 조회 Non-UI 방식에서 사용하는 API입니다.
빌키 조회
등록된 빌키의 정보를 조회하여 카드 정보를 확인할 수 있습니다. 실제 카드번호는 마스킹 처리되며, 발급사 정보와 카드 유형 등을 확인할 수 있습니다.
요청 파라미터
POST
/api/v1/bill_search
Base URL
https://dev.firstpay.co.krContent-Type
application/json필수
조건부 필수
| key | 타입 | 최대크기 | 필수 | 설명 |
|---|---|---|---|---|
mxId | String | 12 | 가맹점 ID | |
billKey | String | 28 | 빌키 | |
callHash | String | - | 체크용 해시 데이터 : SHA256(mxId + billKey + passKey) |
요청 예시
json
{
"mxId": "testcorp",
"billKey": "BK20241103103045ABC123",
"callHash": "SHA256(mxId + billKey + passKey)"
}응답 파라미터
API 응답은 서비스 API 공통 형식을 따릅니다.
data 필드 상세는 아래와 같습니다.
필수
조건부 필수
| key | 타입 | 최대크기 | 필수 | 설명 |
|---|---|---|---|---|
mxId | String | 12 | 가맹점 ID | |
billKey | String | 28 | 빌키 | |
| String | 2 | 발급사코드 | ||
ccNo | String | 4 | 카드번호 뒤 4자리 | |
ccOverFlag | String | 1 | 해외카드 여부 (Y: 해외카드, N: 국내카드) |
보안
조회된 정보는 카드번호 뒤 4자리만 포함됩니다. 전체 카드번호는 절대 반환되지 않습니다.