오픈API

등록된 퇴직연금 계좌 목록 조회 v1.0.0

등록된 퇴직연금 계좌 목록 조회 v1.0.0

API개요

API개요(API 명, API 설명, URL, HTTP Method, OAuth 2.0, 제3자 정보제공 동의) 표
API 명 등록된 퇴직연금 계좌 목록 조회
API 설명 등록된 퇴직연금 계좌 목록 조회
URL /ibk/biz/rtpnAcntCtlgInq
HTTP Method POST
OAuth 2.0 Y
제3자 정보제공 동의 비대상
이용금액 별도협의

Request Header

항목명 필드명 데이터타입 길이 Scale 필수여부 설명
오픈API사용자일련번호oapiusersrnNumber100

클라이언트ID

X-IBK-Client-Id

String

320

클라이언트Sceret

X-IBK-Client-Secret

String

320

Authorization

Authorization

String

40000

Request Body

LV 항목명 필드명 데이터타입 길이 Scale 필수여부 설명
1오픈API클라이언트IDoapiClntIdString500
1퇴직연금계좌목록Nextkey오픈API계좌대체번호rtpnAcntListNextkeyOapiAcntAltrNoString200
1페이지조회건수pageInqNbiNumber100

Request Sample

{
  "rtpnAcntListNextkeyOapiAcntAltrNo" : "sample_rtpnAcntListNextkeyOapiAcntAltrNo",
  "rtpnAcntListRowcount" : 0.0,
  "rtpnAcntList" : [ {
    "oapiAcntAltrNo" : "sample_oapiAcntAltrNo",
    "oapiInofrTgtNo" : "sample_oapiInofrTgtNo",
    "crcd" : "sample_crcd",
    "pdm" : "sample_pdm",
    "pdifAnlsPtrnDcd" : "sample_pdifAnlsPtrnDcd",
    "acssDcd" : "sample_acssDcd"
  } ]
}

Response Header

Response Body

LV 항목명 필드명 데이터타입 길이 Scale 필수여부 설명
1퇴직연금계좌목록Nextkey오픈API계좌대체번호rtpnAcntListNextkeyOapiAcntAltrNoString200
1퇴직연금계좌목록배열rtpnAcntListRowcountNumber50
1퇴직연금계좌목록rtpnAcntList

Array

00
2오픈API계좌대체번호oapiAcntAltrNoString200
2오픈API정보제공대상번호oapiInofrTgtNoString200
2통화코드crcdString30
2상품명pdmString1000
2상품정보분석유형구분코드pdifAnlsPtrnDcdString40
2계좌상태구분코드acssDcdString20

Response Sample

{
  "rtpnAcntListNextkeyOapiAcntAltrNo" : "sample_rtpnAcntListNextkeyOapiAcntAltrNo",
  "rtpnAcntListRowcount" : 0.0,
  "rtpnAcntList" : [ {
    "oapiAcntAltrNo" : "sample_oapiAcntAltrNo",
    "oapiInofrTgtNo" : "sample_oapiInofrTgtNo",
    "crcd" : "sample_crcd",
    "pdm" : "sample_pdm",
    "pdifAnlsPtrnDcd" : "sample_pdifAnlsPtrnDcd",
    "acssDcd" : "sample_acssDcd"
  } ]
}

성공/실패 Case