개발가이드자동차하이패스 미납 여부

하이패스 미납 여부 API

명세 내보내기
OpenAPI 3.0.3Postman 컬렉션Markdown

차량번호 하나로 고속도로 하이패스 미납통행료 대상 여부와 미납 건수를 확인합니다. 차량을 사고팔기 전이나 통행료를 납부하기 전에 미납이 있는지 빠르게 확인할 때 씁니다.

POSThttps://apick.app/rest/hipass_unpaid
인증
Bearer 키
요청 형식
form-data
응답
JSON
경로
1개

알아둘 점

이용 전 확인

미납이 있는 조회 한 건당 60P가 차감됩니다. 실제 차감액은 응답의 api.cost에서 확인하세요.

미납이 없으면 unpaid_target=false, 건수 0으로 응답하며 과금되지 않습니다.

차량번호 형식이 맞지 않거나 조회에 실패하면 과금되지 않습니다.

이 API는 미납 여부와 건수만 제공합니다. 통행일시·구간·금액 같은 미납 내역은 제공하지 않습니다.

요청과 응답

API 요청
POST/rest/hipass_unpaid
  • Bearer 인증
  • multipart/form-data
  • JSON 응답
요청 파라미터 1개 · 필수 1
파라미터
설명
car_nostring필수
차량번호입니다. 예: 12가3456, 123가4567, 서울12가3456. 공백은 자동으로 제거합니다. 숫자 2~3자리 + 한글 1자 + 숫자 4자리 형식이어야 하며 앞에 지역명(한글 최대 2자)을 붙일 수 있습니다.
예시
12가3456
응답 필드 10개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.resultobject
조회 결과 본문입니다. 서비스가 찾은 실제 데이터가 들어 있으며, 자료가 없거나 조회에 실패하면 null이거나 필드가 생략됩니다.
data.result.car_nostring
조회한 차량번호입니다. 공백을 뺀 형태로 돌려줍니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.result.unpaid_targetboolean
미납통행료가 있으면 true 입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.result.unpaid_countinteger
미납 건수입니다. 미납이 없으면 0 입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.result.checked_atstring
조회 시각(ISO 8601, UTC)입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
apiobject
API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.costinteger
이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.successboolean
API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.msinteger
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
입력 조건·전송 규칙
항목
설정
메서드·주소
POST https://apick.app/rest/hipass_unpaid
인증 헤더
Authorization: Bearer — 내 계정의 API 인증키
본문 형식
multipart/form-data
요청 예시

차량번호로 미납 여부를 확인하는 예입니다. 미납이 있으면 과금되는 실제 요청입니다.

사용 예시

상황별로 보내는 값과 응답에서 확인할 값을 모았습니다. 언어 탭에서 그대로 복사해 쓸 수 있습니다.

예시 1. 차량번호로 미납 여부 확인

중고차 거래 전이나 통행료 납부 안내 전에 미납이 있는지 확인합니다.

요청POST/rest/hipass_unpaid
curl --fail-with-body --request POST 'https://apick.app/rest/hipass_unpaid' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string 'car_no=12가3456'
  • data.result.unpaid_target이 true이면 미납이 있습니다. data.result.unpaid_count로 건수를 안내하세요.
  • 미납이 없으면 unpaid_target이 false, api.cost가 0입니다.
예시 2. 지역명이 붙은 옛 번호판 확인

번호판에 지역명이 남아 있는 차량은 표기 그대로 보냅니다. 공백은 넣어도 자동으로 지워집니다.

요청POST/rest/hipass_unpaid
curl --fail-with-body --request POST 'https://apick.app/rest/hipass_unpaid' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string 'car_no=서울12가3456'
  • data.error_code가 INPUT_INVALID이면 번호판 표기를 다시 확인합니다. 영문·특수문자는 넣지 않습니다.
  • data.error_code가 UPSTREAM_FAILED이면 과금되지 않으니 잠시 후 같은 값으로 다시 요청합니다.

응답 처리

HTTP 성공과 업무 결과를 구분하세요. 경로별 응답 필드와 예시는 위 요청과 응답에 함께 있습니다.

{
  "data": {
    "result": {
      "car_no": "12가3456",
      "unpaid_target": true,
      "unpaid_count": 2,
      "checked_at": "2026-10-20T00:30:00.000Z"
    }
  },
  "api": { "cost": 60, "success": true, "ms": 900 }
}

등록되지 않은 차량번호도 형식만 맞으면 미납 없음(unpaid_target=false)으로 응답합니다. 차량 존재 여부를 확인하는 용도로는 쓰지 마세요.

원문 응답 필드 표 보기
필드
타입
설명
data.result.car_no
string
조회한 차량번호입니다. 공백을 뺀 형태로 돌려줍니다.
data.result.unpaid_target
boolean
미납통행료가 있으면 true 입니다.
data.result.unpaid_count
integer
미납 건수입니다. 미납이 없으면 0 입니다.
data.result.checked_at
string
조회 시각(ISO 8601, UTC)입니다.
api.cost
integer
차감된 포인트입니다. 미납이 없거나 실패하면 0 입니다.

오류 코드

응답을 아래 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

  1. HTTP 상태전송·인증·입력 오류
  2. api.successAPI 처리 여부
  3. data · result업무 결과와 오류 문구
  4. api.cost이번 요청의 과금
업무 실패 응답 data.error
  • 입력값이 맞지 않거나 대상 자료가 없거나 일시적으로 처리하지 못하면 data.error(사유 문구)와 data.success=0을 돌려줍니다. HTTP 상태는 사유에 따라 400·404·408·424 중 하나입니다.
  • 이때 api.cost는 0이며 과금되지 않습니다. data.error 문구를 그대로 기록하고 사용자에게 보여 주세요.
  • 입력 오류(400)는 값을 고친 뒤 다시 요청하세요. 408·424는 잠시 후 한 번 다시 시도하고, 같은 입력으로 짧은 간격의 자동 반복은 하지 마세요.
{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}
서비스 코드·조건

오류 코드

실패하면 data.error(안내 문구)와 data.error_code가 오며 과금되지 않습니다.

error_code
의미
대처
INPUT_REQUIRED
car_no를 보내지 않았습니다.
차량번호를 넣어 다시 요청합니다.
INPUT_INVALID
차량번호 형식이 맞지 않습니다.
번호판 표기 그대로(예: 12가3456) 다시 보냅니다. 영문·특수문자는 넣지 않습니다.
UPSTREAM_FAILED
일시적으로 조회하지 못했습니다.
잠시 후 같은 값으로 다시 요청합니다.
인증·포인트 오류 result.error 문구
코드
HTTP
의미·조치
유효하지 않은 API키 입니다.
401
Authorization: Bearer 헤더의 인증키를 확인하세요.
허용되지 않은 IP주소 입니다.
401
마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.
비활성화된 계정입니다.
401
계정 이용 상태를 고객지원으로 문의하세요.
사용 가능한 포인트이 부족합니다.
200
HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.
무료 포인트로 사용할 수 없는 서비스입니다.
200
최소 1회 결제 후 이용할 수 있습니다. result.error 전체 문구를 그대로 표시하세요.
인증 정보를 확인할 수 없습니다.
424
일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.
폼 입력 오류 error.code
코드
HTTP
의미·조치
FORM_DATA_INVALID
400
필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.
FORM_DATA_FIELD_CONFLICT
400
같은 값과 중첩 경로를 동시에 지정하지 마세요.
MULTIPART_LIMIT_OR_PARSE_ERROR
400·413
boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금기본 단가 60P · 건당무료 포인트로는 이용할 수 없으며 최소 1회 결제 후 이용할 수 있습니다.

실제 차감 금액은 응답의 api.cost로 확인하세요. 상세 요금은 요금정책에서 볼 수 있습니다.

연동 팁

  • 요청 예제의 오류 처리 포함 모드는 시간 제한과 업무 실패 판정을 함께 보여줍니다.
  • 인증키는 서버 환경변수에 두고 브라우저·앱에 넣지 마세요.
  • HTTP 성공과 업무 결과를 구분하고, 실패 응답의 오류 문구를 그대로 기록하세요.

개발가이드 검색

API 이름·경로·파라미터·오류 코드로 찾을 수 있습니다.

표시 가격은 기본 단가입니다. 상세 과금 조건은 각 가이드에서 확인하세요.