| 분류체계 | 재정·세제·금융 - 금융 | 제공기관 | 한국주택금융공사 |
|---|---|---|---|
| 관리부서명 | ICT 전략부 | 관리부서 전화번호 | |
| API 유형 | REST | 데이터포맷 | JSON+XML |
| 활용신청 | 45 | 키워드 | 한국주택금융공사,주택연금,예상연금 |
| 등록일 | 2021-07-07 | 수정일 | 2022-05-04 |
| 비용부과유무 | 무료 | 신청가능 트래픽 | 개발계정 : 1,000 / 운영계정 : 활용사례 등록시 신청하면 트래픽 증가 가능 |
| 심의유형 | 개발단계 : 자동승인 / 운영단계 : 자동승인 | ||
| 이용허락범위 | |||
| 참고문서 | 주택연금예상연금조회.docx | ||
요청변수(Request Parameter)
| 항목명(국문) | 항목명(영문) | 항목크기 | 항목구분 | 샘플데이터 | 항목설명 |
|---|---|---|---|---|---|
| 서비스키 | serviceKey | 400 | 필수 | 인증키 (URL Encode) | 공공데이터포털에서 받은 인증키 |
| 페이지 번호 | pageNo | 4 | 필수 | 1 | 페이지 번호 |
| 한 페이지 결과 수 | numOfRows | 4 | 필수 | 10 | 한 페이지 결과 수 |
| 주택가격 | housePrc | 10 | 필수 | 250000000 | 주택 가격 |
| 주택구분코드 | houseDvcd | 2 | 필수 | 01 | 01: 일반주택 02: 노인복지주택 |
| 연금지급방식구분코드 | pnsnPayMthdDvcd | 2 | 필수 | 01 | 01: 종신지급 02: 종신혼합 04: 확정혼합 06: 대출상환 07: 우대지급 08: 우대혼합 |
| 월지급금증감구분코드 | mmPayAmtIndcDvcd | 2 | 필수 | 01 | 01: 정액형 31:정기증가형 41:초기증액형(10년) 42:초기증액형(7년) 43:초기증액형(5년) 44:초기증액형(3년) |
| 가입자출생일자 | joinPersBrthDy | 8 | 필수 | 19510205 | 주택소유자 생년월일 |
| 배우자 출생일자 | sposBrthDy | 8 | 옵션 | 19540605 | 배우자 생년월일 |
| 지급기간코드 | payTermCd | 2 | 필수 | 01 | 01: 종신(연금지급방식 구분코드: 01,02,06,07,08인 경우) 02: 30년 03: 25년 04: 20년 05: 15년 06: 10년 |
| 인출한도설정금액 | wdrwLmtSetpAmt | 10 | 옵션 | 1000000 | 인출한도설정금액 |
| 데이터타입 | dataType | 4 | 옵션 | XML | 오픈 API에서 제공할 데이터 타입을 대문자 문자열로 지정 - 데이터 타입 지원 형식 XML/JSON 단, 시스템에서 정의된 디폴트 포맷의 요청인 경우 생략 가능 |
출력결과(Response Element)
| 항목명(국문) | 항목명(영문) | 항목크기 | 항목구분 | 샘플데이터 | 항목설명 |
|---|---|---|---|---|---|
| 결과코드 | resultCode | 2 | 필수 | 00 | 결과코드 |
| 결과메시지 | resultMsg | 50 | 필수 | NORMAL SERVICE | 결과메시지 |
| 한 페이지 결과 수 | numOfRows | 4 | 필수 | 10 | 한 페이지 결과 수 |
| 페이지 번호 | pageNo | 4 | 필수 | 1 | 페이지 번호 |
| 데이터 총 개수 | totalCount | 4 | 필수 | 1 | 데이터 총 개수 |
| 월지급금 | monPmtAmt | 10 | 필수 | 603360 | 월지급금 |
| 최대인출한도 | ImaxAmt | 10 | 필수 | 54125000 | 최대인출한도 |
샘플코드는 PC에서 확인해주세요.
| 분류체계 | 재정·세제·금융 - 금융 | |
|---|---|---|
| 제공기관 | 한국주택금융공사 | |
| 관리부서명 | ICT 전략부 | |
| 관리부서 전화번호 | ||
| API 유형 | REST | |
| 데이터포맷 | JSON+XML | |
| 활용신청 | 45 | |
| 키워드 | 한국주택금융공사,주택연금,예상연금 | |
| 등록일 | 2021-07-07 | |
| 수정일 | 2022-05-04 | |
| 심의유형 | 개발단계 : 자동승인 / 운영단계 : 자동승인 | |
| 비용부과유무 | 무료 | |
| 신청가능 트래픽 | 개발계정 : 1,000 / 운영계정 : 활용사례 등록시 신청하면 트래픽 증가 가능 | |
| 이용허락범위 | ||
| 참고문서 | 주택연금예상연금조회.docx | |
요청변수(Request Parameter)
| 항목명(국문) | 항목명(영문) | 항목크기 | 항목구분 | 샘플데이터 | 항목설명 |
|---|---|---|---|---|---|
| 서비스키 | serviceKey | 400 | 필수 | 인증키 (URL Encode) | 공공데이터포털에서 받은 인증키 |
| 페이지 번호 | pageNo | 4 | 필수 | 1 | 페이지 번호 |
| 한 페이지 결과 수 | numOfRows | 4 | 필수 | 10 | 한 페이지 결과 수 |
| 주택가격 | housePrc | 10 | 필수 | 250000000 | 주택 가격 |
| 주택구분코드 | houseDvcd | 2 | 필수 | 01 | 01: 일반주택 02: 노인복지주택 |
| 연금지급방식구분코드 | pnsnPayMthdDvcd | 2 | 필수 | 01 | 01: 종신지급 02: 종신혼합 04: 확정혼합 06: 대출상환 07: 우대지급 08: 우대혼합 |
| 월지급금증감구분코드 | mmPayAmtIndcDvcd | 2 | 필수 | 01 | 01: 정액형 31:정기증가형 41:초기증액형(10년) 42:초기증액형(7년) 43:초기증액형(5년) 44:초기증액형(3년) |
| 가입자출생일자 | joinPersBrthDy | 8 | 필수 | 19510205 | 주택소유자 생년월일 |
| 배우자 출생일자 | sposBrthDy | 8 | 옵션 | 19540605 | 배우자 생년월일 |
| 지급기간코드 | payTermCd | 2 | 필수 | 01 | 01: 종신(연금지급방식 구분코드: 01,02,06,07,08인 경우) 02: 30년 03: 25년 04: 20년 05: 15년 06: 10년 |
| 인출한도설정금액 | wdrwLmtSetpAmt | 10 | 옵션 | 1000000 | 인출한도설정금액 |
| 데이터타입 | dataType | 4 | 옵션 | XML | 오픈 API에서 제공할 데이터 타입을 대문자 문자열로 지정 - 데이터 타입 지원 형식 XML/JSON 단, 시스템에서 정의된 디폴트 포맷의 요청인 경우 생략 가능 |
출력결과(Response Element)
| 항목명(국문) | 항목명(영문) | 항목크기 | 항목구분 | 샘플데이터 | 항목설명 |
|---|---|---|---|---|---|
| 결과코드 | resultCode | 2 | 필수 | 00 | 결과코드 |
| 결과메시지 | resultMsg | 50 | 필수 | NORMAL SERVICE | 결과메시지 |
| 한 페이지 결과 수 | numOfRows | 4 | 필수 | 10 | 한 페이지 결과 수 |
| 페이지 번호 | pageNo | 4 | 필수 | 1 | 페이지 번호 |
| 데이터 총 개수 | totalCount | 4 | 필수 | 1 | 데이터 총 개수 |
| 월지급금 | monPmtAmt | 10 | 필수 | 603360 | 월지급금 |
| 최대인출한도 | ImaxAmt | 10 | 필수 | 54125000 | 최대인출한도 |
샘플코드는 PC에서 확인해주세요.