금융보안원 로고

회원가입 로그인

API가이드

금융투자 업권 정보제공 API 규격

  • DB형 퇴직연금정보 기본정보 조회 (은행, 금투, 보험 공통) v2 2022-10-19

    기본 정보
    API ID DB-001 (금투) HTTP Method GET
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/db/basic
    설명 정보주체가 보유한 DB형 퇴직연금정보 기본정보 조회
    - DB제도 특성 상 퇴직 후 퇴직금 정산 등 처리기간이 필요하므로 변동사항이 실시간으로 반영되지 않을 수 있음
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    is_running_pension 보유여부 Y Boolean DB형 퇴직연금 보유여부

  • DC형 퇴직연금정보 목록정보 조회 (은행, 금투, 보험 공통) v2 2022-10-19

    기본 정보
    API ID DC-001 (금투) HTTP Method GET
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/dc
    설명 정보주체가 보유한 DC형 퇴직연금정보 목록(Pagination, 상품관리번호 기준 오름차순)
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    - 2.1-[2] 페이지네이션 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    dc_cnt 퇴직연금수 Y N(3)
    dc_list 퇴직연금목록 Y <object>
    --dc_num 상품관리번호 Y aN(15) 고객이 보유한 DC형 연금제도 관리번호
    - 금융회사에서 개인 또는 (개인이 2개이상 DC제도 보유시) 상품별로 관리하고 있는 상품관리번호 (계좌번호, 원장관리번호 등 내부에서 key값으로 관리중인 일련번호를 회신)
    --dc_name 상품명 Y AH(300) 고객이 보유한 DC형 연금제도 명칭- 사명, 제도명 등 웹 또는 앱에서 보여주고 있는 명칭과 동일하게 전송
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부

  • DC형 퇴직연금정보 기본정보 조회 (은행, 금투, 보험 공통) v2 2022-10-19

    기본 정보
    API ID DC-002 (금투) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/dc/basic
    설명 정보주체가 보유한 DC형 퇴직연금정보 기본정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    dc_num 상품관리번호 Y aN(15) 고객이 보유한 DC형 연금제도 관리번호
    - 금융회사에서 개인 또는 (개인이 2개이상 DC제도 보유시) 상품별로 관리하고 있는 상품관리번호 (계좌번호, 원장관리번호 등 내부에서 key값으로 관리중인 일련번호를 회신)
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    balance_amt 계좌잔액 N F(18,3) DC형 연금 계좌의 잔액(각 사 정책에 따라 전송하되, 앱 또는 웹을 고객에게 제공하는 수치와 같은 값)
    - 전일자 또는 실시간 기준 금액
    eval_amt 계좌평가금액 Y F(18,3) 조회 시점 기준의 이자 등 운용수익이 반영된 평가금액
    (각 사 정책, 전산관리 방식 등에 따라 전송하되, 앱 또는 웹에서 고객에서 제공하는 수치와 같은 값으로 제공)
    issue_date 개설일 Y DATE DC형 연금 가입일
    - 각사 내규에 따라 가입자 명부 등록일과 최초 입금일 중 가입일로 판단하는 날짜를 회신

  • DC형 퇴직연금정보 거래내역정보 조회 (은행, 금투, 보험 공통) v2 2022-10-19

    기본 정보
    API ID DC-003 (금투) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/dc/transactions
    설명 조회 기간 동안 발생한 정보주체의 DC형 퇴직연금정보 거래내역 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    dc_num 상품관리번호 Y aN(15) 고객이 보유한 DC형 연금제도 관리번호
    - 금융회사에서 개인 또는 (개인이 2개이상 DC제도 보유시) 상품별로 관리하고 있는 상품관리번호 (계좌번호, 원장관리번호 등 내부에서 key값으로 관리중인 일련번호를 회신)
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래목록수 Y N(3)
    trans_list 거래목록 Y <object>
    --trans_dtime 거래일시 또는 거래일자 Y DTIME<br>또는<br>DATE 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신(일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) (선택전송) 해당 일자의 거래 특정 번호
    없을 경우 회신 안함
    --trans_type 거래구분 Y aN(2) 해당 거래의 거래 유형
    - <코드값>
    01 : 신규
    02 : 입금
    03 : 출금
    09 : 정정(입금)
    10 : 정정(출금)
    98 : 기타(입금)
    99 : 기타(출금)
    --trans_amt 거래금액 Y F(18,3) 해당 거래의 금액

  • DC형 퇴직연금정보 추가정보 조회 (은행, 금투, 보험 공통) v2 2022-10-24

    기본 정보
    API ID DC-004 (금투) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/dc/detail
    설명 정보주체가 보유한 DC형 퇴직연금정보 개별운용상품별 추가(평가금액 등) 정보 조회
    (Pagination, 거래일시 기준 내림차순)
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    dc_num 상품관리번호 Y aN(15) 고객이 보유한 DC형 연금제도 관리번호
    - 금융회사에서 개인 또는 (개인이 2개이상 DC제도 보유시) 상품별로 관리하고 있는 상품관리번호 (계좌번호, 원장관리번호 등 내부에서 key값으로 관리중인 일련번호를 회신)
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aN(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 N N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    - 2.1-[2] 페이지네이션 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    dc_cnt 운용상품수 Y N(4) 보유한 DC형 퇴직연금 수
    dc_list 운용상품목록 Y <object>
    --prod_name 개별운용상품명 Y AH(300) 정보제공자의 원장에 기록되어 있는 개별운용상품의 명칭 (예 : 00은행 정기예금 1년 등)
    --prod_num 상품가입번호 N aN(64) (선택전송) 동일상품에 대해 중복 투자한 경우 이를 구분하기 위한 식별값
    --prod_type 상품유형
    (코드)    		 Y aN(2) 개별운용상품의 상품 유형
    - <코드값>
    01 : 원리금 보장
    02 : 원리금 비보장
    03 : 기타
    --eval_amt 평가금액 Y F(18,3) 조회 시점 기준의 이자 등 운용수익이 반영된 평가금액
    (각 사 정책, 전산관리 방식 등에 따라 전송하되, 앱 또는 웹에서 고객에서 제공하는 수치와 같은 값으로 제공)
    --principal_amt 납입(투자)원금 Y F(18,3) 납입원본 또는 납입후 이자 재예치후 원금 (개별운용상품 기준 잔액 표기 = 고객이 납입한 총 원금 - 지급 원금)
    --holding_num 보유좌수 N F(18,3) (선택전송) 개별운용상품이 보유한 좌수(원리금보장(예금) 상품일 경우에는 전송하지 않음)
    - 개별운용상품 단위로 정보를 관리하지 않을 경우 미전송
    ex) 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우
    --issue_date 신규일 N DATE (선택전송) 개별상품 신규일(재예치일)
    - 개별운용상품 단위로 정보를 관리하지 않을 경우 미전송
    ex) 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우
    --exp_date 만기일 N DATE (선택전송) 개발상품 만기일
    - 개별운용상품 단위로 정보를 관리하지 않을 경우 미전송
    ex) 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우
    --int_rate 약정이자율 N F(5,3) (선택전송) 해당 개별운용상품이 원리금 보장(예금) 상품일 경우의 이자율
    - 개별운용상품 단위로 정보를 관리하지 않을 경우 미전송
    ex) 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우

  • 개인형 IRP 계좌 목록 조회 (은행, 금투, 보험 공통) v2 2022-10-19

    기본 정보
    API ID IRP-001 (금투) HTTP Method GET
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/irps
    설명 정보주체가 보유한 개인형 IRP 계좌목록 조회
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    irp_cnt 보유계좌수 Y N(3) 보유한 개인형 IRP 계좌 수
    irp_list 보유계좌목록 Y <object>
    --prod_name 상품명 Y AH(300) 개인형 IRP 상품의 명칭
    --account_num 계좌번호 Y aN(20) 해당 고객이 보유한 개인형 IRP 계좌번호
    - "-" 제외
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부

  • 개인형 IRP 계좌 목록 조회 (은행, 금투, 보험 공통) v1 2022-10-19

    기본 정보
    API ID IRP-001 (금투) HTTP Method GET
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/irps
    설명 정보주체가 보유한 개인형 IRP 계좌목록 조회
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    irp_cnt 보유계좌수 Y N(3) 보유한 개인형 IRP 계좌 수
    irp_list 보유계좌목록 Y <object>
    --prod_name 상품명 Y AH(300) 개인형 IRP 상품의 명칭
    --account_num 계좌번호 Y aN(20) 해당 고객이 보유한 개인형 IRP 계좌번호
    - "-" 제외
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부

  • 개인형 IRP 계좌 기본정보 조회 (은행, 금투, 보험 공통) v1 2022-10-19

    기본 정보
    API ID IRP-002 (금투) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/irps/basic
    설명 정보주체가 보유한 개인형 IRP 계좌별 기본정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    accum_amt 계좌잔액 Y F(18,3) IRP 계좌의 잔액
    - 각 사 정책에 따라 전송하되, 앱 또는 웹을 고객에게 제공하는 수치와 같은 값 (실시간 기준)
    eval_amt 계좌평가금액 Y F(18,3) 조회 시점 전일자 기준의 이자 등 운용수익이 반영된 평가금액(계좌 전체 기준, 수수료 관련 이슈는 각 사 정책에 따름
    employer_amt 사용자부담금 Y F(18,3) 적립금액 중 사용자 부담금
    employee_amt 가입자부담금 Y F(18,3) 적립금액 중 가입자 부담금
    - ISA 만기자금 포함
    issue_date 개설일 Y DATE 계좌 개설일
    - 통장이 만들어진 날짜
    first_deposit_date 최초입금일 N DATE 연금계좌 가입일 (DC 최초 부담금 납입일①과 개인형 IRP 최초부담금납입일② 중 빠른 날짜
    reg_date 최초제도가입일 N DATE DB 제도에서 퇴직금이 입금되었을대 DB 제도의 가입일
    rcv_start_date 연금개시시작(예정)일 N DATE 고객이 연금개시가 되도록 지정한 날짜(예정) 또는 연금개시가 시작된 날짜

  • 개인형 IRP 계좌 기본정보 조회 (은행, 금투, 보험 공통) v2 2022-10-19

    기본 정보
    API ID IRP-002 (금투) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/irps/basic
    설명 정보주체가 보유한 개인형 IRP 계좌별 기본정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    accum_amt 계좌잔액 Y F(18,3) IRP 계좌의 잔액
    - 각 사 정책에 따라 전송하되, 앱 또는 웹을 고객에게 제공하는 수치와 같은 값 (실시간 기준)
    eval_amt 계좌평가금액 Y F(18,3) 조회 시점 전일자 기준의 이자 등 운용수익이 반영된 평가금액(계좌 전체 기준, 수수료 관련 이슈는 각 사 정책에 따름
    employer_amt 사용자부담금 Y F(18,3) 적립금액 중 사용자 부담금
    employee_amt 가입자부담금 Y F(18,3) 적립금액 중 가입자 부담금
    - ISA 만기자금 포함
    issue_date 개설일 Y DATE 계좌 개설일
    - 통장이 만들어진 날짜
    first_deposit_date 최초입금일 N DATE 연금계좌 가입일 (DC 최초 부담금 납입일①과 개인형 IRP 최초부담금납입일② 중 빠른 날짜
    reg_date 최초제도가입일 N DATE DB 제도에서 퇴직금이 입금되었을대 DB 제도의 가입일
    rcv_start_date 연금개시시작(예정)일 N DATE 고객이 연금개시가 되도록 지정한 날짜(예정) 또는 연금개시가 시작된 날짜

  • 개인형 IRP 계좌 추가정보 조회 (은행, 금투, 보험 공통) v2 2022-10-19

    기본 정보
    API ID IRP-003 (금투) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/irps/detail
    설명 정보주체가 보유한 개인형 IRP 추가정보(상품정보 등) 조회
    Pagination, 신규일 기준 내림차순 (일부 기관의 경우 운용상품 수가 500개 초과하는 경우 존재)
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    irp_cnt 운용상품수 Y N(3)
    irp_list 운용상품목록 Y <object>
    --irp_name 개별운용상품명 Y AH(300) 금융회사의 원장에 기록되어 있는 개별운용상품의 명칭 (예 : 00은행 정기예금 1년 등)
    --irp_no 상품가입번호 N aN(64) 상품관리번호 (동일상품에 대해 여러 번 투자한 경우 이를 구분하기 위한 식별값)
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --irp_type 상품유형
    (코드)    		 Y aN(2) 개별운용상품의 상품 유형
    - <코드값>
    01 : 원리금 보장
    02 : 원리금 비보장
    03 : 기타
    --eval_amt 평가금액 Y F(18,3) 기준일자의 이자 등 운용수익이 반영된 평가금액(개별운용상품 기준, 수수료 관련 이슈는 각 사 정책에 따름)
    --inv_principal 납입(투자)원금 Y F(18,3) 납입원본 또는 납입후 이자 재예치후 원금 (개별운용상품 기준 잔액 표기 = 고객이 납입한 총 원금 - 지급 원금)
    --fund_num 보유좌수 N F(18,3) 개별운용상품이 보유한 좌수
    - 원리금 보장(예금) 상품의 경우 (보유좌수를 관리 안함) 미회신- 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --open_date 신규일 N DATE 개별상품 신규일(재예치일)
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --exp_date 만기일 N DATE 개발상품 만기일
    - 없을 경우 회신 안 함
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --int_rate 약정이자율 N F(5,3) 해당 개별운용상품이 원리금 보장(예금) 상품일 경우의 이자율
    - 원리금 보장(예금)만 해당하며, 그 외는 미회신
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)

  • 개인형 IRP 계좌 추가정보 조회 (은행, 금투, 보험 공통) v1 2022-10-19

    기본 정보
    API ID IRP-003 (금투) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/irps/detail
    설명 정보주체가 보유한 개인형 IRP 추가정보(상품정보 등) 조회
    Pagination, 신규일 기준 내림차순 (일부 기관의 경우 운용상품 수가 500개 초과하는 경우 존재)
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    irp_cnt 운용상품수 Y N(3)
    irp_list 운용상품목록 Y <object>
    --irp_name 개별운용상품명 Y AH(300) 금융회사의 원장에 기록되어 있는 개별운용상품의 명칭 (예 : 00은행 정기예금 1년 등)
    --irp_no 상품가입번호 N aN(64) 상품관리번호 (동일상품에 대해 여러 번 투자한 경우 이를 구분하기 위한 식별값)
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --irp_type 상품유형
    (코드)    		 Y aN(2) 개별운용상품의 상품 유형
    - <코드값>
    01 : 원리금 보장
    02 : 원리금 비보장
    03 : 기타
    --eval_amt 평가금액 Y F(18,3) 기준일자의 이자 등 운용수익이 반영된 평가금액(개별운용상품 기준, 수수료 관련 이슈는 각 사 정책에 따름)
    --inv_principal 납입(투자)원금 Y F(18,3) 납입원본 또는 납입후 이자 재예치후 원금 (개별운용상품 기준 잔액 표기 = 고객이 납입한 총 원금 - 지급 원금)
    --fund_num 보유좌수 N F(18,3) 개별운용상품이 보유한 좌수
    - 원리금 보장(예금) 상품의 경우 (보유좌수를 관리 안함) 미회신- 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --open_date 신규일 N DATE 개별상품 신규일(재예치일)
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --exp_date 만기일 N DATE 개발상품 만기일
    - 없을 경우 회신 안 함
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --int_rate 약정이자율 N F(5,3) 해당 개별운용상품이 원리금 보장(예금) 상품일 경우의 이자율
    - 원리금 보장(예금)만 해당하며, 그 외는 미회신
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)

  • 개인형 IRP 계좌 거래내역 조회 (은행, 금투, 보험 공통) v2 2022-10-19

    기본 정보
    API ID IRP-004 (금투) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/irps/transactions
    설명 정보주체가 보유한 개인형 IRP 거래정보 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래목록수 Y N(3)
    trans_list 거래목록 Y <object>
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신(일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 해당일자의 거래 특정 번호
    (없을 경우 미회신)
    --trans_type 거래구분 Y aN(2) 해당 거래의 거래 유형
    - <코드값>
    01 : 입금
    02 : 지급
    --trans_amt 거래금액 Y N(15) 해당 거래의 금액

  • 개인형 IRP 계좌 거래내역 조회 (은행, 금투, 보험 공통) v1 2022-10-19

    기본 정보
    API ID IRP-004 (금투) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/irps/transactions
    설명 정보주체가 보유한 개인형 IRP 거래정보 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래목록수 Y N(3)
    trans_list 거래목록 Y <object>
    --trans_dtime 거래일시 또는 거레일자 Y DTIME 또는 DATE 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신(일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 해당일자의 거래 특정 번호
    (없을 경우 미회신)
    --trans_type 거래구분 Y aN(2) 해당 거래의 거래 유형
    - <코드값>
    01 : 입금
    02 : 지급
    --trans_amt 거래금액 Y N(15) 해당 거래의 금액

  • 계좌 목록 조회 v2 2022-10-19

    기본 정보
    API ID 금투-001 HTTP Method GET
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/accounts
    설명 정보주체가 보유한 금융회사별 계좌 목록 조회
    - Pagination, 계좌종류 기준 오름차순
    - 연금계좌(계좌종류(코드) '105')의 경우, 연금계좌 추가정보(금투-005) 조회 가능
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    account_cnt 보유계좌수 Y N(3)
    account_list 보유계좌목록 Y Object
    --account_num 계좌번호 Y aN(20) 증권 계좌번호
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --account_name 계좌명 Y AH(60) 상품명, 계좌별명 등 계좌에 속한 부가 정보를 전송하되, 데이터가 없을 시 '계좌종류 (코드)'의 한글 명을 전송가능
    - 정보주체의 실명으로 계좌명이 설정되는 경우, 정보활용 측면에서 실명 외에 다른 부가정보 전송을 권고
    --account_type 계좌종류(코드) Y aN(3) 계좌 종류
    - [첨부3] 계좌번호 별 구분 코드 中 금투업권 표
    --issue_date 계좌개설일 Y DATE 해당 계좌를 개설한 일자
    --is_tax_benefits 세제혜택 적용여부 (계좌) Y Boolean 해당 계좌의 세제혜택 적용여부
    - 계좌에 포함된 상품의 세제혜택 적용여부와는 별개 (상품별로 세제혜택 적용여부 다를 수 있음)
    --is_cma CMA상품포함 여부 Y Boolean 해당 계좌의 CMA상품(약정) 포함 여부
    --is_stock_trans 주식거래가능 여부 Y Boolean 해당 계좌가 CMA상품(약정)을 포함하는 경우, CMA상품(약정)의 국내주식 또는 해외주식 거래 가능 여부
    - CMA 상품포함 여부가 false인 경우, false 전송
    --is_account_link 은행연계계좌 여부 Y Boolean 해당 계좌가 은행 계좌와 연계된 은행예수금 방식으로 운용되는지 여부
    - 계좌에 포함된 상품 별로 은행 연계 계좌 여부 다를 수 있음

  • 계좌 목록 조회 v1 2022-10-19

    기본 정보
    API ID 금투-001 HTTP Method GET
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/accounts
    설명 정보주체가 보유한 금융회사별 계좌 목록 조회
    - Pagination, 계좌종류 기준 오름차순
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    account_cnt 보유계좌수 Y N(3)
    account_list 보유계좌목록 Y Object
    --account_num 계좌번호 Y aN(20) 증권 계좌번호
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --account_name 계좌명 Y AH(60) 상품명, 계좌별명 등 계좌에 속한 부가 정보를 전송하되, 데이터가 없을 시 '계좌종류 (코드)'의 한글 명을 전송가능
    - 정보주체의 실명으로 계좌명이 설정되는 경우, 정보활용 측면에서 실명 외에 다른 부가정보 전송을 권고
    --account_type 계좌종류(코드) Y aN(3) 계좌 종류
    - [첨부3] 계좌번호 별 구분 코드
    --issue_date 계좌개설일 Y DATE 해당 계좌를 개설한 일자
    --is_tax_benefits 세제혜택 적용여부 (계좌) Y Boolean 해당 계좌의 세제혜택 적용여부
    - 계좌에 포함된 상품의 세제혜택 적용여부와는 별개 (상품별로 세제혜택 적용여부 다를 수 있음)

  • 계좌 기본정보 조회 v2 2022-10-19

    기본 정보
    API ID 금투-002 HTTP Method POST
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/accounts/basic
    설명 정보주체가 보유한 계좌별 기본 정보 조회
    - 정보제공자는 자사 온라인 플랫폼에서 노출되는 실시간 최신 정보 전송을 원칙으로 하며, 체결기준 정보를 결제기준 정보보다 우선시하여 전송(잔고평가 화면의 체결기준 현금잔고 정보)
    - 외화 잔액의 경우, 전체 잔액(예수금, 대출금 등)이 모두 0원이면 : 해당 통화코드 미전송, 잔액 미전송
    - 원화 잔액의 경우, 전체 잔액(예수금, 대출금 등)이 모두 0원이면 : 잔액 0원으로 전송
    - 정보제공기관은 시스템 안전성 확보를 위해 장 초반/마감 시 체결성상품 API 호출에 대해 응답거부 가능(에러코드 : 50010)
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    base_date 기준일자 Y DATE 전송 데이터의 기준일자
    - 금투-004의 기준일자와 같은 값 전송
    basic_cnt 기본정보목록수 Y N(3) 기본정보가 복수 개인 계좌(예: 통화코드 별로 정보가 별도로 관리)를 수용하기 위해 List로 회신
    basic_list 기본정보목록 Y <object>
    --currency_code 통화코드 N A(3) 예수금, 신용융자, 대출금에 대한 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    - 외화의 경우, 전체 잔액(예수금 등)이 0원인 경우 해당 통화 잔액정보 미전송
    - 원화의 경우, 잔액이 0원인 경우 전송
    --withholdings_amt 예수금 N F(18,3) 조회시점 기준 계좌의 실시간 체결기준 현금 총 잔액으로 단기매매상품(CMA, MMF) 등의 잔고를 제외한 순수 현금 잔액
    - 미수 발생 시, 미수에 해당하는 금액을 마이너스 형태로 표기 (예: -2000)
    - 외화 예수금이 0원인 경우에만 미전송(원화 예수금이 0원인 경우 전송)
    --credit_loan_amt 신용 융자 Y F(18,3) 해당 계좌에서 매매거래를 위해 증권사로부터 빌린 매수대금의 총액
    - 신용 약정을 하지 않았거나 상환해야할 금액이 없는 경우 : '0'으로 표기
    --mortgage_amt 대출금 Y F(18,3) 유가증권을 담보로 대출받은 금액의 총 합계
    - 조회시점 기준 상환되지 않고 남아있는 전체 담보 대출 금액
    --avail_balance 출금가능금액 Y F(18,3) 계좌 잔액 중 즉시 출금(현금화)이 가능한 금액

  • 계좌 기본정보 조회 v1 2022-10-19

    기본 정보
    API ID 금투-002 HTTP Method POST
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/accounts/basic
    설명 정보주체가 보유한 계좌별 기본 정보 조회
    - 체결기준이 아닌, 결제기준
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    base_date 기준일자 Y DATE 전송 데이터의 기준일자
    - 정보제공자의 정보처리 시스템에 따라 '결제 기준'을 해석함에 차이가 있을 수 있어, 데이터의 수신자의 이해를 돕기 위한 기준일을 함께 전송
    basic_cnt 기본정보목록수 Y N(3) 기본정보가 복수 개인 계좌(예: 통화코드 별로 정보가 별도로 관리)를 수용하기 위해 List로 회신
    basic_list 기본정보목록 Y <object>
    --currency_code 통화코드 N A(3) 예수금, 신용융자, 대출금에 대한 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --withholdings_amt 예수금 Y F(18,3) 조회시점 기준 계좌에 입금되어 있는 현금 총 잔액으로 단기매매상품(CMA, MMF) 등의 잔고를 제외한 순수 현금 잔액
    - 미수 발생 시, 미수에 해당하는 금액을 마이너스 형태로 표기 (예: -2000)
    --credit_loan_amt 신용 융자 Y F(18,3) 해당 계좌에서 매매거래를 위해 증권사로부터 빌린 매수대금의 총액
    - 신용 약정을 하지 않았거나 상환해야할 금액이 없는 경우 : '0'으로 표기
    --mortgage_amt 대출금 Y F(18,3) 유가증권을 담보로 대출받은 금액의 총 합계
    - 조회시점 기준 상환되지 않고 남아있는 전체 담보 대출 금액

  • 계좌 거래내역 조회 v1 2022-10-19

    기본 정보
    API ID 금투-003 HTTP Method POST
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/accounts/transactions
    설명 정보주체가 보유한 계좌에서 조회 기간 동안 발생한 상세 거래 정보 조회
    (Pagination, 거래일시 기준 내림차순)
    - 체결기준이 아닌, 결제기준
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    거래금액(trans_amt), 정산금액(settle_amt), 거래후잔액(balance_amt)의 경우 “현금의 입출입을 표현”하기 위한 데이터이며, 종목명(상품명)(prod_name), 종목코드(상품코드)(prod_code), 해외주식거래소코드(ex_code), 거래수량(trans_num), 거래단가(base_amt)는 “종목의 입출입을 표현”하기 위한 데이터이기 때문에 아래와 같이 선택 전송
    1) 거래종류(코드)(trans_type)가 입금(301), 출금(302), 상환(303), 입금취소(311), 출금취소(312), 매수(341), 매도(342)인 경우 : 거래금액(trans_amt)이 필수적으로 전송
    2) 거래종류(코드)(type)가 입고(321), 출고(322), 매수(341), 매도(342)인 경우 : 거래수량(trans_num)이 필수적으로 전송
    3) 1), 2)의 의무사항 외에는 정보제공자의 판단 하에 보유 데이터를 전송 가능
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    from_date 시작일지 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래내역수 Y N(3)
    trans_list 거래내역목록 Y <object>
    --prod_name 종목명(상품명) N AH(60) 거래가 발생한 상품의 명칭
    --prod_code 종목코드(상품코드) N aN(12) 종목코드(상품코드)
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 거래 또는 거래취소가 발생한 기준일(시)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신 (일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 해당 일자의 거래 특정 번호 (없을 경우 미회신)
    거래일시가 거래일자로 전송되는 경우 거래의 중복 및 순서를 파악하기 위해 정보제공자가 임의로 특정한 해당 일자의 거래번호
    --trans_type 거래종류 (코드) Y aN(3) 거래종류 특정 코드
    - [첨부6] 거래종류 코드
    --trans_type_detail 거래종류 상세 Y AH(60) 상세 거래 종류 (코드가 아닌 상세 거래 종류 명)
    - 예) 배당금이 입금되었을 경우 : 거래종류(코드)='301'(입금), 거래종류 상세='배당금 입금'
    --trans_num 거래수량 N F(21,6) 해당종목이 본 거래에서 거래된 총 수량
    (일부 금융투자상품의 경우 수량이 아닐 수 있음
    --base_amt 거래단가 N F(17,4) 해당종목이 본 거래에서 거래된 단위 가격
    (일부 금융투자상품의 경우 단위 가격이 아닐 수 있음
    --trans_amt 거래금액 N F(18,3) 해당 종목이 본 거래에서 거래된 총 금액
    --settle_amt 정산금액 N F(18,3) 거래대금에서 제세공과금 등을 차감한 금액
    (세금, 수수료 등이 없는 현금 거래일 경우 거래금액과 동일 값)
    - 정산금액 = 거래대금 - 세금 - 증권사 수수료
    --balance_amt 거래후잔액 N F(18,3) 해당 계좌의 현금 잔액(예수금)
    --currency_code 통화코드 N A(3) 거래에 적용된 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --ex_code 해외주식 거래소 코드 N aN(3) 해외 거래소 코드 (해외주식 한정)
    - [첨부16] 해외주식 거래소 코드

  • 계좌 거래내역 조회 v2 2022-10-19

    기본 정보
    API ID 금투-003 HTTP Method POST
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/accounts/transactions
    설명 정보주체가 보유한 계좌에서 조회 기간 동안 발생한 상세 거래 정보 조회
    (Pagination, 거래일시 기준 내림차순)
    - 체결기준이 아닌, 결제기준의 거래(입출)내역이며 당일 수도결제를 반영하여 전송
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - '현금'의 입출: 거래금액, 정산금액, 거래후잔액을 통해 전송
    - '상품'의 입출: 거래수량, 수량단위명, 거래단가를 통해 전송
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래내역수 Y N(3)
    trans_list 거래내역목록 Y <object>
    --prod_name 종목명(상품명) N AH(60) 거래가 발생한 상품의 명칭
    --prod_code 종목코드(상품코드) N aN(12) 해당 개별 상품(종목)의 코드
    - [첨부5] 상품종류 코드 및 상품코드표 中 종목코드(상품코드)
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 거래 또는 거래취소가 발생한 기준일(시)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신 (일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 해당 일자의 거래 특정 번호 (없을 경우 미회신)
    거래일시가 거래일자로 전송되는 경우 거래의 중복 및 순서를 파악하기 위해 정보제공자가 임의로 특정한 해당 일자의 거래번호
    --trans_type 거래종류 (코드) Y aN(3) 거래종류 특정 코드
    - [첨부6] 거래종류 코드
    --trans_type_detail 거래종류 상세 Y AH(60) 상세 거래 종류 (코드가 아닌 상세 거래 종류 명)
    - 예) 배당금이 입금되었을 경우 : 거래종류(코드)='301'(입금), 거래종류 상세='배당금 입금'
    --trans_num 거래수량 N F(21,8) 해당종목이 본 거래에서 거래된 총 수량
    - 거래종류(코드)가 입출고(321-~324), 수도(341~344)인 경우 필수적으로 전송
    - 소수점거래의 경우 소수점 수량의 전송(예: 0.0001)
    --trans_unit 수량단위명 N AH(30) 거래수량(trans_num) 제공 기준 단위명을 전송하여 수신자의 이해를 도움
    <예시>
    주식: '주'
    펀드: '금액' 혹은 '좌'
    채권: '금액' 혹은 '채'
    파생상품: '금액' 혹은 '계약' 등 자사 기준에 따름
    --base_amt 거래단가 N F(20,8) 해당종목이 본 거래에서 거래된 단위 가격
    (일부 금융투자상품의 경우 단위 가격이 아닐 수 있음
    --trans_amt 거래금액 N F(18,3) 해당 종목이 본 거래에서 거래된 총 금액
    - 거래종류(코드)가 입출금 및 상황(301~313), 수도(341~344)인 경우 필수적으로 전송
    --settle_amt 정산금액 N F(18,3) 거래대금에서 제세공과금 등을 차감한 금액
    (세금, 수수료 등이 없는 현금 거래일 경우 거래금액과 동일 값)
    - 정산금액 = 거래대금 - 세금 - 증권사 수수료
    --balance_amt 거래후잔액 N F(18,3) 거래 발생 후 해당 계좌의 현금 잔액(예수금)으로 단기매매상품(CMA, MMF 등)의 잔고를 제외한 순수 예수금
    --currency_code 통화코드 N A(3) 거래에 적용된 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --trans_memo 적요 N AH(90) 계좌입출금 거래 관련 수취·송금인 계좌·성명·메모 등이 기록된 정보로서 정보주체가 직접 기록한 내용(자동 입력에 의한 정보 포함)
    - 정보주체가 전송요구 시 적요 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_memo='true') 회신하고, 그렇지 않은 경우 미회신
    --ex_code 거래소 코드 N aN(3) 거래소 코드
    - 주식의 경우 필수적으로 전송
    - [첨부16] 거래소 코드

  • 계좌 상품정보 조회 v1 2022-10-19

    기본 정보
    API ID 금투-004 HTTP Method POST
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/accounts/products
    설명 정보주체가 보유한 계좌에 포함된 상품의 조회 시점 기준 상세 정보 조회
    - Pagination, 상품코드(종목코드) 기준 오름차순
    - 체결기준이 아닌, 결제기준
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    base_date 기준일자 Y DATE 전송 데이터의 기준일자
    - 결제 보유수량의 기준일
    prod_cnt 상품수 Y N(3)
    prod_list 상품목록 Y <object>
    --prod_type 상품종류(코드) Y aN(3) 해당 개별 상품의 종류 코드 (코드표 중 4XX 사용)
    - [첨부5] 상품종류 코드 및 상품코드
    --prod_type_detail 상품종류 상세 Y AH(60) 정보제공자가 특정한 상품의 상세 명칭 (예 : CMA, RP, CD, ETF 등)
    --prod_code 종목코드(상품코드) Y aN(12) 종목코드(상품코드)
    - [첨부5] 상품종류 코드 및 상품코드
    --ex_code 해외주식 거래소 코드 N aN(3) 해외 거래소 코드 (해외주식 한정)
    - [첨부16] 해외주식 거래소 코드
    --prod_name 종목명 Y AH(300) 해당 계좌에 보유하고 있는 상품의 명칭
    --pos_type 파생상품포지션구분(코드) N aN(2) 파생상품의 포지션 구분 코드
    <코드값>
    01 : 매수
    02 : 매도
    --credit_type 신용구분 (코드) Y aN(2) 신용 구분 유형 코드
    <코드값>
    01 : 현금
    02 : 신용
    03 : 담보대출
    --is_tax_benefits 세제혜택 적용여부 (상품) Y Boolean 해당 상품의 세제혜택 적용여부
    --purchase_amt 매입금액 Y F(18,3) 조회시점 기준 해당 계좌 보유상품별 총 매입 금액 (또는 담보대출금액, 거래금액 산정기준과 동일)
    - 체결일 기준이 아닌, 결제일 기준의 정보를 전송함에 따라, 데이터의 상세 기준(예: 수도 결제 반영 여부 등)이 정보제공자 별로 차이가 있을 수 있음
    --holding_num 보유수량 Y F(21,6) 조회시점 기준 해당 계좌 보유상품별 수량(또는 담보대출수량)
    - 체결일 기준이 아닌, 결제일 기준의 정보를 전송함에 따라, 데이터의 상세 기준(예: 수도 결제 반영 여부 등)이 정보제공자 별로 차이가 있을 수 있음.
    - 일부 금융투자상품의 경우 수량이 아닐 수 있음. (예: 금액(채권, CMA 등), 좌수(펀드 등))
    --eval_amt 평가금액 Y F(18,3) 전일 종가 기준 해당 상품의 평가금액( = 전일종가 X 보유수량)
    - 체결일 기준이 아닌, 결제일 기준의 정보를 전송함에 따라, 데이터의 상세 기준(예: 수도 결제 반영 여부 등)이 정보제공자 별로 차이가 있을 수 있음.
    --currency_code 통화코드 N A(3) 해당 상품에 적용된 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)

  • 계좌 상품정보 조회 v2 2022-10-19

    기본 정보
    API ID 금투-004 HTTP Method POST
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/accounts/products
    설명 정보주체가 보유한 계좌에 포함된 상품의 조회 시점 기준 상세 정보 조회
    - Pagination, 상품코드(종목코드) 기준 오름차순
    - 정보제공자는 자사 온라인 플랫폼에서 노출되는 실시간 최신 정보 전송을 원칙으로 하며, 체결기준 정보를 결제기준 정보보다 우선시하며 전송
    - 결제 기준의 정보는 당일수도결제분을 반영한 실시간 기준의 정보를 전송하며, 이때 금투-002 잔액정보와 금투-004 상품정보의 시점은 동일함
    <체결 및 결제 기준>
    - 상품종류(코드)가 국내주식(401), 해외주식(402), 국내장내파생상품(408), 해외장내파생상품(409)인 경우 체결기준 정보 전송(주식, 파생상품)
    - 상품종류(코드)가 국내펀드(413), 해외역내펀드(414), 해외역외펀드(415)인 경우, 기준가 적용일기준의 정보를 전송(펀드)
    - 상품종류(코드)가 국내채권(403), 해외채권(404), 국내단기금융상품(411), 해외단기금융상품(412), 현금과예금(418)인 경우, 결제기준 정보가 실시간 최신의 확정 정보
    - 그 외 상품에 대해서는 기관·상품별로 체결기준 정보 전송 가능 여부가 상이함. 제공자는 자사 플랫폼에서 체결기준 정보를 제공할 경우 체결기준 정보를 전송하고, 아닌 경우 결제 기준 정보를 전송. 이를 '체결기준여부' 항목으로 수신자에게 안내하도록 함.
    - 정보제공기관은 시스템 안전성 확보를 위해 장 초반/마감 시 체결성상품 API 호출에 대해 응답거부 가능(에러코드 : 50010)
    * 장 시작 : 08:30 ~ 09:30, 장 마감 : 15:00 ~ 16:00
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    base_date 기준일자 Y DATE 전송 데이터의 기준일자
    - 보유수량의 기준일자로, 금투-002의 기준일자와 같은 값 전송
    - 결제기준 정보의 경우 당일(D) 수도결제를 반영하여 전송
    prod_cnt 상품수 Y N(3)
    prod_list 상품목록 Y <object>
    --prod_type 상품종류(코드) Y aN(3) 해당 개별 상품의 종류 코드
    - [첨부5] 상품종류 코드 및 상품코드표 中 종목코드(상품코드)
    --prod_type_detail 상품종류 상세 Y AH(60) 정보제공자가 특정한 상품종류의 상세 명칭 (예 : CMA, RP, CD, ETF 등)
    --prod_code 종목코드(상품코드) Y aN(12) 해당 개별 상품(종목)의 코드
    - [첨부5] 상품종류 코드 및 상품코드표 中 종목코드(상품코드)
    --ex_code 거래소 코드 N aN(3) 거래소 코드
    - [첨부16] 거래소 코드
    - 주식의 경우 필수적으로 전송
    --prod_name 종목명 Y AH(300) 해당 계좌에 보유하고 있는 상품(종목)의 상세 명칭
    (예: ABC투자신탁, XX전자 등)
    --pos_type 파생상품포지션구분(코드) N aN(2) 파생상품의 포지션 구분 코드
    <코드값>
    01 : 매수
    02 : 매도
    --credit_type 신용구분 (코드) Y aN(2) 신용 구분 유형 코드
    <코드값>
    01 : 현금
    02 : 신용
    03 : 담보대출
    --is_tax_benefits 세제혜택 적용여부 (상품) Y Boolean 해당 상품의 세제혜택 적용여부
    --purchase_amt 매입금액 Y F(18,3) 조회시점 기준 해당 계좌 보유상품별 총 매입 금액 (또는 담보대출금액, 거래금액 산정기준과 동일)
    --holding_num 보유수량 Y F(21,8) 조회시점 기준 해당 계좌 보유상품별 수량(또는 담보대출수량)
    - 소수점거래의 경우 소수점 수량으로 전송(예: 0.0001)
    --trans_unit 수량단위명 N AH(30) 보유수량(holding_num) 제공 기준 단위명을 전송하여 수신자의 이해를 도움
    <예시>
    주식: '주'
    펀드: '금액' 혹은 '좌'
    채권: '금액' 혹은 '채'
    파생상품: '금액' 혹은 '계약' 등 자사 기준에 따름
    --eval_amt 평가금액 Y F(18,3) 해당 상품의 실시간 평가금액
    - 전송요구 시점 기준으로 자사 플랫폼에서 보여지는 실시간 평가금액 전송
    - 예) 장중(실시간 현재가 X 보유수량), 장전시간외(전일종가 X 보유수량), 장후시간외(당일종가 X 보유수량), 동시호가(동시호가 X 보유수량) 등 자사 기준에 따름
    --is_execution 체결기준여부 Y Boolean 해당 상품의 정보가 체결(주식, 파생상품) 또는 기준가적용일(펀드) 기준의 정보인지 여부
    - 기관별 조건에 따라 체결일 기준 전송이 불가할 수 있음에 따라 수신자의 이해를 위해 전송(예: 장외 펀드의 체결기준 정보를 자사 플랫폼에서도 제공하지 않는 경우에는 체결기준 정보 전송 불가)
    - 상품종류(코드)가 채권(403, 404), 단기금융상품(411, 412), 현금과예금(418)인 경우 false 전송 (결제기준 정보가 실시간 확정 정보인 상품)
    --currency_code 통화코드 N A(3) 해당 상품에 적용된 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)

  • 연금계좌 추가정보 조회 v1 2022-10-19

    기본 정보
    API ID 금투-005 HTTP Method POST
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/accounts/pension
    설명 정보주체가 보유한 연금 계좌의 추가정보 조회
    - 해당 계좌의 종류가 연금계좌(금투-001의 account_type이 ‘105’)일 경우, 연금계좌 추가정보를 추가적으로 호출 가능
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)- 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    issue_date 연금가입일 Y DATE 해당 연금상품 가입일자 (해당 상품 포함 계좌에 최초 납입된 일자)
    paid_in_amt 납부총액 Y F(18,3) 조회 시점 기준 납부된 총액
    withdrawal_amt 기출금액 Y F(18,3) 조회 시점 기준 출금한 총액
    last_paid_in_date 최종납입일 N DATE 실제 최종 납입한 일자
    rcv_amt 연금기수령액 Y F(18,3) 조회시점 기준 연금 수령총액

  • 연금계좌 추가정보 조회 v2 2022-10-19

    기본 정보
    API ID 금투-005 HTTP Method POST
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/accounts/pension
    설명 정보주체가 보유한 연금 계좌의 추가정보 조회
    - 해당 계좌의 종류가 연금계좌(금투-001의 account_type이 ‘105’)일 경우, 연금계좌 추가정보를 추가적으로 호출 가능
    - 정보제공기관은 시스템 안전성 확보를 위해 장 초반/마감 시 체결성상품 API 호출에 대해 응답거부 가능(에러코드 : 50010)
    * 장 시작 : 08:30 ~ 09:30, 장 마감 : 15:00 ~ 16:00
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)- 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    issue_date 연금가입일 Y DATE 해당 연금상품 가입일자 (해당 상품 포함 계좌에 최초 납입된 일자)
    paid_in_amt 납부총액 Y F(18,3) 조회 시점 기준 납부된 총액
    withdrawal_amt 기출금액 Y F(18,3) 조회 시점 기준 출금한 총액
    last_paid_in_date 최종납입일 N DATE 실제 최종 납입한 일자
    rcv_amt 연금기수령액 Y F(18,3) 조회시점 기준 연금 수령총액
    pension_rcv_start_date 연금개시(예정)일 N DATE 고객이 연금개시가 되도록 지정한 날짜(예정) 또는 연금개시가 시작된 날짜
    annual_pay_amount 금년납입금 Y F(18,3) 고객이 해당 해에 납입한 총액
    currency_code 통화코드 N A(3) 해당 상품에 적용된 통화코드 (ISO 4217 준용)
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)

  • 계좌지정 자동이체 등록정보 v2 2022-10-19

    기본 정보
    API ID 금투-006 HTTP Method POST
    API 제공자 금투업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/accounts/scheduled
    설명 정보주체가 등록한 계좌지정 자동이체 등록정보
    (Pagination, 자동이체계좌번호 기준 오름차순
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호(전체 자릿수)
    - "-" 제외
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 N N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    scheduled_cnt 자동이체 수 Y N(3) 정보주체가 등록한 계좌지정 자동이체 수
    scheduled_list 자동이체 목록 Y <object>
    --scheduled_org_code 자동이체 기관(코드) N aN(8) 자동이체 등록이 된 상환계좌번호의 소속 기관 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 고객이 앱 등을 통해 등록한 '계좌지정자동이체' 中 지정계좌가 본인명의인 경우에 한하여 전송
    --scheduled_account_num 자동이체계좌번호 Y aN(20) 자동이체 등록계좌번호
    --currency_code 통화코드 N A(3) (선택전송) 해당 상품에 적용된 통화 코드
    (ISO 4217 준용)
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    --scheduled_amt 자동이체금액 Y F(18,3) 자동이체금액
    --scheduled_cycle 자동이체주기 Y aNS(2) 자동이체주기
    - 1개월 : 01
    - 2개월 : 02
    - 3개월 : 03
    - 4개월 : 04
    - 5개월 : 05
    - 6개월 : 06
    - 7개월 : 07
    - 8개월 : 08
    - 9개월 : 09
    - 10개월 : 10
    - 11개월 : 11
    - 12개월 : 12,
    - 매주 : 13,
    - 매일 : 14
    - 매월말 : 15
    - 기타 : 99
    --scheduled_date 자동이체주기상세 N aN(2) 자동이체일, 또는 요일(자동이체주기가 1개월 이상인 경우, 지정이체일을 01~31 숫자로 전송)
    자동이체주기가 매주(13)인 경우, 지정된 요일코드로 회신
    <<월:32,화:33,수:34,목:35,금:36,토:37,일:38>>
    - 자동이체주기가 매월말인 경우에는 본항목 미회신
    - 자동이체주기가 2개월 또는 그 이상이지만, 자동이체지정일이 매월 말인 경우 본항목에 39(매월 말)번 코드 로 회신
    (예 : 3개월마다 말일에 이체되는 자동이체건의 경우 : 자동이체주기 : 03 (3개월), 자동이체주기 상세 : 39 (매월 말) )
    --trans_memo 적요 N AH(90) 계좌입출금 거래 관련 수취·송금인 계좌·성명·메모 등이 기록된 정보로서 정보주체가 직접 기록한 내용(자동 입력에 의한 정보 포함)
    - 정보주체가 전송요구 시 적요 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_memo='true') 회신하고, 그렇지 않은 경우 미회신

  • API 목록 조회 (공통) v1 2022-10-19

    기본 정보
    API ID 정보제공-공통-001 (금투) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자, 종합포털
    API 명 (URI) /invest/apis
    설명 정보제공자가 제공하는 정보제공 API 목록(정보제공-공통-001, 정보제공-공통-002 포함)을 회신
    - 인증 API는 모든 정보제공자(또는 중계기관)가 공통적으로 구축해야 하므로, 목록을 조회하는 것이 불필요
    - 지원 API는 종합포털과 주고받는 API이기 때문에 API 요청자인 마이데이터사업자가 목록을 조회하는 것이 불필요
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 N aNS(12) 정기적/비정기적 전송 API 유형- 비정기적 전송일 경우 미설정
    Parameter org_code 기관코드 Y aN(10) - 지원 API로부터 배포
    client_id 클라이언트ID Y aN(50) 종합포털에 마이데이터 서비스 등록 시 발급받은 클라이언트 식별값
    - API 요청자가 “종합포털”인 경우, client_id는 PDS 자격증명의 client_id로 요청
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    version 현재 버전 Y aN(10) API 현재 버전 (업권별 정보제공 API)
    - 참고 : 업권별로 버전이 관리되기 때문에 해당 업권의 정보제공API들의 현재버전(버전정보가 존재하지 않는 정보제공-공통-001 API제외)은 모두 동일하며, 해당 현재버전을 회신
    min_version 호환가능 최소 버전 N aN(10) 마이데이터사업자가 이전 버전 호출 시 응답 가능한 최소 버전
    (예: 최신 버전이 v5, min_version=v2이라고 가정 시, 마이데이터사업자는 v2를 호출해도 정보제공자는 해당 버전의 API를 처리하여 회신- 현재버전이 v1인 경우 미회신
    api_cnt API 개수 Y N(3) 제공 API 개수
    api_list API 목록 Y <object>
    --api_code API 구분 코드 Y AN(4) API 구분 코드
    --api_uri API 명 Y aN(50) URI 계층구조 중 에 해당하는 정보 (예: /account, /accounts/deposit/basic 등)

  • 전송요구 내역 조회 (공통) v2 2022-10-19

    기본 정보
    API ID 정보제공-공통-002 (금투) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자
    API 명 (URI) /v2/invest/consents
    설명 정보주체가 특정한 전송요구 내역 조회
    - 시행 초기 전산 용량 등을 감안하여 초기에는 전송 주기(fnd_cycle, add_cycle)를 주1회(“1/w”)로 고정하고, 추후 논의 과정을 거쳐 고객의 선택권을 다양화할 예정
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) - 지원 API로부터 배포
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    is_scheduled 정기적 전송 여부 Y Boolean 정기적 전송을 요구하는지 여부
    fnd_cycle 전송 주기(기본정보) N aNS(5) 정기적 전송 주기
    - 규격 : 횟수/기준 (기준:월=“m”, 주=“w”, 일=“d”)
    <예시>
    1/w : 주1회
    1/d : 일1회
    - is_scheduled='true'인 경우 회신
    add_cycle 전송 주기(추가정보) N aNS(5) 추가정보의 정기적 전송 주기
    - 규격 : fnd_cycle과 동일
    - is_scheduled='true'인 경우 회신
    end_date 종료시점 Y DATE 전송요구 종료 시점
    - 자산목록 전송요구(1차 통합인증) 시 : 전송요구시점부터 7일째 되는 일자 (예: 2021.12.1. 전송요구 시 종료시점은 +7일인 2021.12.8.)
    - 개별인증 시 또는 자산에 대한 세부 전송요구(2차 통합인증) 시 : 전송요구시점부터 1년째 되는 일자 (예: 2021.12.1. 전송요구 시 종료시점은 +1년인 2022.12.1.) 또는 고객이 선택한 일자
    purpose 목적 Y AH(150) 전송을 요구하는 목적
    period 보유기간 Y DATE 전송을 요구하는 개인신용정보의 보유기간
    - 자산목록 전송요구(1차 통합인증) 시 : 전송요구시점부터 7일째 되는 일자 (예: 2021.12.1. 전송요구 시 보유기간은 +7일인 2021.12.8.)
    - 개별인증 시 또는 자산에 대한 세부 전송요구(2차 통합인증) 시 : '99991231' 고정값
    - '99991231' : '서비스 이용 종료시 또는 삭제요구시 까지'를 의미
    is_consent_trans_memo 적요/거래메모 전송요구 여부 N Boolean 정보주체가 보유한 수신계좌의 거래내역 중 적요/거래메모(trans_memo) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 은행업권, 금투업권, 전자금융업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 은행업권 : 은행-004, 은행-014에서 적요 회신
    - 금투업권 : 금투-003, 금투-006에서 적요 회신
    - 전자금융업권 : 전금-004, 전금-103에서 거래메모 회신
    - “false”인 경우 :
    - 은행업권 : 은행-004, 은행-014에서 적요 미회신
    - 금투업권 : 금투-003, 금투-006에서 적요 미회신
    - 전자금융업권 : 전금-004, 전금-103에서 거래메모 미회신
    is_consent_merchant_name_regno 가맹점명/사업자등록번호 전송요구 여부 N Boolean 가맹점명(merchant_name) 및 사업자등록번호(merchant_regno) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 카드업권, 전자금융업권, 통신업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 카드업권 : 카드-005, 카드-008, 카드-014, 선불-004에서 가맹점명 및 사업자등록번호 회신, 카드-009에서 가맹점명 회신
    - 전자금융업권 : 전금-004에서 가맹점명 회신, 전금-103에서 가맹점명 및 사업자등록번호 회신
    - 통신업권 : 통신-004에서 가맹점명 및 사업자등록번호 회신
    - “false”인 경우 :
    - 카드업권 : 카드-005, 카드-008, 카드-014, 선불-004에서 가맹점명 및 사업자등록번호 미회신, 카드-009에서 가맹점명 미회신
    - 전자금융업권 : 전금-004에서 가맹점명 미회신, 전금-103에서 가맹점명 및 사업자등록번호 미회신
    - 통신업권 : 통신-004에서 가맹점명 및 사업자등록번호 미회신
    is_consent_trans_category 상품(구매)분류 전송요구 여부 N Boolean 정보주체의 결제내역 중 상품(구매)분류(코드)(trans_category) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 전자금융업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 전자금융업권 : 전금-004, 전금-103에서 상품(구매)분류 (코드) 회신
    - “false”인 경우 :
    - 전자금융업권 : 전금-004, 전금-103에서 상품(구매)분류 (코드) 미회신

  • 전송요구 내역 조회 (공통) v1 2022-10-19

    기본 정보
    API ID 정보제공-공통-002 (금투) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자
    API 명 (URI) /v1/invest/consents
    설명 정보주체가 특정한 전송요구 내역 조회
    - 시행 초기 전산 용량 등을 감안하여 초기에는 전송 주기(fnd_cycle, add_cycle)를 주1회(“1/w”)로 고정하고, 추후 논의 과정을 거쳐 고객의 선택권을 다양화할 예정
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) - 지원 API로부터 배포
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    is_scheduled 정기적 전송 여부 Y Boolean 정기적 전송을 요구하는지 여부
    fnd_cycle 전송 주기(기본정보) N aNS(5) 정기적 전송 주기
    - 규격 : 횟수/기준 (기준:월=“m”, 주=“w”, 일=“d”)
    <예시>
    1/w : 주1회
    1/d : 일1회
    - is_scheduled='true'인 경우 회신
    add_cycle 전송 주기(추가정보) N aNS(5) 추가정보의 정기적 전송 주기
    - 규격 : fnd_cycle과 동일
    - is_scheduled='true'인 경우 회신
    end_date 종료시점 Y DATE 전송요구 종료 시점
    - 자산목록 전송요구(1차 통합인증) 시 : 전송요구시점부터 7일째 되는 일자 (예: 2021.12.1. 전송요구 시 종료시점은 +7일인 2021.12.8.)
    - 개별인증 시 또는 자산에 대한 세부 전송요구(2차 통합인증) 시 : 전송요구시점부터 1년째 되는 일자 (예: 2021.12.1. 전송요구 시 종료시점은 +1년인 2022.12.1.) 또는 고객이 선택한 일자
    purpose 목적 Y AH(150) 전송을 요구하는 목적
    period 보유기간 Y DATE 전송을 요구하는 개인신용정보의 보유기간
    - 자산목록 전송요구(1차 통합인증) 시 : 전송요구시점부터 7일째 되는 일자 (예: 2021.12.1. 전송요구 시 보유기간은 +7일인 2021.12.8.)
    - 개별인증 시 또는 자산에 대한 세부 전송요구(2차 통합인증) 시 : '99991231' 고정값
    - '99991231' : '서비스 이용 종료시 또는 삭제요구시 까지'를 의미
    is_consent_trans_memo 적요/거래메모 전송요구 여부 N Boolean 정보주체가 보유한 수신계좌의 거래내역 중 적요/거래메모(trans_memo) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 은행업권, 전자금융업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 은행업권 : 은행-004에서 적요 회신
    - 전자금융업권 : 전금-004, 전금-103에서 거래메모 회신
    - “false”인 경우 :
    - 은행업권 : 은행-004에서 적요 미회신
    - 전자금융업권 : 전금-004, 전금-103에서 거래메모 미회신
    is_consent_merchant_name_regno 가맹점명/사업자등록번호 전송요구 여부 N Boolean 가맹점명(merchant_name) 및 사업자등록번호(merchant_regno) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 카드업권, 전자금융업권, 통신업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 카드업권 : 카드-005, 카드-008, 선불-004에서 가맹점명 및 사업자등록번호 회신, 카드-009에서 가맹점명 회신
    - 전자금융업권 : 전금-004에서 가맹점명 회신, 전금-103에서 가맹점명 및 사업자등록번호 회신
    - 통신업권 : 통신-004에서 가맹점명 회신
    - “false”인 경우 :
    - 카드업권 : 카드-005, 카드-008, 선불-004에서 가맹점명 및 사업자등록번호 미회신, 카드-009에서 가맹점명 미회신
    - 전자금융업권 : 전금-004에서 가맹점명 미회신, 전금-103에서 가맹점명 및 사업자등록번호 미회신
    - 통신업권 : 통신-004에서 가맹점명 미회신
    is_consent_trans_category 상품(구매)분류 전송요구 여부 N Boolean 정보주체의 결제내역 중 상품(구매)분류(코드)(trans_category) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 전자금융업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 전자금융업권 : 전금-004, 전금-103에서 상품(구매)분류 (코드) 회신
    - “false”인 경우 :
    - 전자금융업권 : 전금-004, 전금-103에서 상품(구매)분류 (코드) 미회신

Table of contents

금융투자 업권 정보제공 API 규격