금융보안원 로고

회원가입 로그인

API가이드

은행 업권 정보제공 API 규격

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

    기본 정보
    API ID DB-001 (은행) HTTP Method GET
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/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/bank/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/bank/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/bank/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/bank/dc/detail
    설명 정보주체가 보유한 DC형 퇴직연금정보 개별운용상품별 추가(평가금액 등) 정보 조회
    (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로부터 배포
    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 aNS(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/bank/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/bank/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 계좌 기본정보 조회 (은행, 금투, 보험 공통) v2 2022-10-19

    기본 정보
    API ID IRP-002 (은행) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/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 계좌 기본정보 조회 (은행, 금투, 보험 공통) v1 2022-10-19

    기본 정보
    API ID IRP-002 (은행) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/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/bank/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/bank/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-004 (은행) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/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<br> 또는<br> DATE 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신(일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 해당일자의 거래 특정 번호
    (없을 경우 미회신)
    --trans_type 거래구분 Y aN(2) 해당 거래의 거래 유형
    - <코드값>
    01 : 입금
    02 : 지급
    --trans_amt 거래금액 Y N(15) 해당 거래의 금액

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

    기본 정보
    API ID IRP-004 (은행) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/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<br> 또는<br> 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_1 HTTP Method GET
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/prepaid
    설명 정보주체가 가입한 선불카드 목록 조회
    - 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까지 설정 가능
    - 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 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    pp_cnt 선불카드수 Y N(3)
    pp_list 선불카드목록 Y Object
    --pp_id 선불카드 식별자 Y aNS(40) 정정보제공자가 부여한 선불카드 식별 값
    --pp_name 선불카드 상품명 Y AH(300) 정보제공자가 부여한 선불카드의 상품명
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(권면)에 대해 개인신용정보 전송요구를 했는지 여부
    --reg_date 발급일자 Y DATE 최초 기명식 선불카드 발급일자
    --limit_amt 액면한도 또는 최대충전한도 Y N(5) 선불카드의 액면한도 또는 최대충전한도 (단위:만원)

  • 선불카드 잔액정보 조회 (은행, 카드 공통) v2 2022-10-19

    기본 정보
    API ID 선불-002_1 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/prepaid/balance
    설명 정보주체가 가입한 선불카드의 잔액정보 조회
    기준시점 현재 시점
    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로부터 배포
    pp_id 선불카드식별자 Y aN(64) 정보제공자가 부여한 선불카드 식별 값
    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] 참조
    total_balance_amt 총잔액 Y F(18,3) 선불카드의 총 잔액
    charge_balance_amt 충전포인트 잔액 N F(18,3) 계좌이체, 카드결제 등 결제행위를 통하여 충전한 금액 중 잔액
    - 해당하는 기관만 회신
    reserve_balance_amt 적립포인트 잔액 N F(18,3) 자사 또는 제휴사를 통하여 적립된 금액 중 잔액
    - 해당하는 기관만 회신
    reserve_due_amt 적립예정 N F(18,3) 향후 일정기간내 적립 예정인 금액
    - 해당하는 기관만 회신
    exp_due_amt 소멸예정 Y F(18,3) M+2개월내 소멸 예정인 금액
    - 카드포인트와 동일하게 소멸
    - M+2월 내 소멸될 총 포인트 표시

  • 선불카드 거래내역 조회 (은행, 카드 공통) v2 2022-10-19

    기본 정보
    API ID 선불-003_1 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/prepaid/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) - 지원 API로부터 배포
    pp_id 선불카드식별자 Y aN(64) 정보제공자가 부여한 선불카드 식별 값
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    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)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래내역수 Y N(3)
    trans_list 거래내역목록 Y Object
    --trans_type 거래유형 (코드) Y aN(4) 해당 거래의 구분 코드
    - [첨부9] 선불지급수단업 거래유형 코드
    - 다만, 거래유형 중 결제(5501), 결제취소(5502)에 해당하는 거래정보는 본 API가 아닌 선불-004를 통해 회신
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 해당 채권번호에서 거래가 이루어진 일시(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신 (일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 거래일자만 전송되어 거래시간에 대한 정보가 없을 경우 해당 일자의 거래 순서를 관리하고 데이터의 중복 여부를 판단하기 위해 정보제공자가 설정한 순번
    - (없을 경우 미회신)
    --trans_amt 거래금액 Y N(15) 해당 거래의 금액 (예: 충전, 적립, 송금 등에 해당하는 금액)
    --balance_amt 거래 후 잔액 N F(18,3) 해당 거래 후 잔액
    --trans_org_code 거래상대 기관(코드) N aN(8) 거래 상대 금융기관의 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - <참고>
    충전 :충전에 사용된 기관
    송금: 송금 대상 기관
    송금수취: 송금인의 기관
    적립: 적립이 이뤄진 기관
    결제: 결제가 이루어진 상대기관
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    --trans_id 거래상대 식별값 N AH(60) 거래 대상 금융기관이 발행한 거래 상대의 식별값
    - 1. 카드: 카드번호(마스킹포함), 2. 은행: 계좌번호, 3. 선불: 권면ID(명) 등
    - 카드번호일 경우는 카드업권 마스킹 규칙 준용
    - 해당 거래상대 식별값이 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신

  • 선불카드 승인내역(결제내역) 조회 (은행, 카드 공통) v2 2022-10-19

    기본 정보
    API ID 선불-004_1 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/prepaid/approval
    설명 정보주체가 보유한 선불카드별 승인내역(결제내역) 조회 (Pagination, 사용일시(승인인 경우 approvoed_dtime, 정정/취소인 경우 trans_dtime) 기준 내림차순)
    - 조회 시작일자/종료일자 기간 내에 승인내역 뿐만 아니라 정정/취소내역도 회신 필요 (즉, from_date <= 승인일자(승인일시의 YYYYMMDD에 해당) <= to_date를 만족하는 승인내역뿐만 아니라, from_date <= 정정/취소일자(“정정 또는 승인취소 일시”의 YYYYMMDD에 해당) <= to_date를 만족하는 정정내역 및 취소내역 회신 필요)
    - 신용정보법 시행령 제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로부터 배포
    pp_id 선불카드 식별자 Y aN(64) 정보제공자가 부여한 선불카드 식별 값
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    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)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    approved_cnt 승인목록수 Y N(3)
    approved_list 승인목록 Y Object
    --approved_num 승인번호 Y aN(21) 카드 승인 시 각 사에서 발행한 번호
    --approved_dtime 승인일시 Y DTIME 금융소비자가 물품을 구매하거나 용역을 제공받은 날짜와 시간
    --status 결제상태 (코드) Y aN(2) 해당 승인번호의 조회시점 결제상태
    - <코드값>
    01 : 승인
    02 : 승인취소
    03 : 정정
    --trans_dtime 정정 또는 승인취소 일시 N DTIME 정정 또는 승인취소가 발생한 일시
    - 결제상태(코드)가 '02'인 경우 : 취소일시
    - 결제상태(코드)가 '03'인 경우 : 정정일시
    --merchant_name 가맹점명 N AH(75) 금융소비자가 물품을 구매하거나 용역을 제공받은 곳의 명칭
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    --merchant_regno 가맹점 사업자등록번호 N aN(12) 가맹점의 사업자등록번호
    - '-' 포함
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    --approved_amt 이용금액 Y N(15) 가맹점에서 이용한 금액 (할부 시 전체금액으로)
    --modified_amt 정정후 금액 N N(15) 정정 후 이용 금액
    - 결제상태(코드)가 ‘03’인 경우만 회신
    --total_install_cnt 전체 할부회차 N N(5) 해당 상환거래 금액 중 이자

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

    기본 정보
    API ID 은행-001 HTTP Method GET
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts
    설명 정보주체가 보유한 금융회사별 계좌 목록 조회
    - Pagination, 계좌구분(코드) 기준 오름차순 후 계좌번호 기준 오름차순
    - 신용정보법 시행령 제28조의3제9항에 의거, 개인인 정보주체의 요청으로 특약사항을 기재하거나 약정하여 해당 정보의 제3자 제공을 금지한 경우 또는 비대면 정보 조회를 금지한 경우(예:숨김계좌, 보안계좌 등)에는 해당 정보에 대하여 대면으로 전송요구권을 행사하도록 되어있어, 회신 대상에서 제외
    - 마이너스통장(is_minus가 'true'인 수신계좌)은 수신계좌 및 대출계좌 둘 다에 해당되기 때문에 아래와 같은 기준 수립
    - 기본정보 조회 : 은행-002(수신계좌 기본정보), 은행-008(대출계좌 기본정보)
    - 추가정보 조회 : 은행-003(수신계좌 추가정보), 은행-009(대출계좌 추가정보)
    - 거래내역 조회 : 은행-004(수신계좌 거래내역)
    * 은행-008, 은행-009 호출시에도 대출용 계좌번호가 아닌 수신용 계좌번호 사용
    - 공동명의 계좌는 전송요구 대상에서 제외
    - 해지된 계좌는 전송요구 대상에서 제외
    - 중첩적 채무인수의 경우, 채무를 인수받은 시점을 기준으로 해당 대출상품계좌는 인수자의 전송요구 대상에 포함되며, 인계자의 전송요구 대상에서는 제외
    기준시점 현재 시점
    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을 회신 또는 미회신
    reg_date 고객정보 최초생성일 Y DATE 해당 금융기관에서 최초로 고객번호를 채번한 날짜(CRM 최초등록일) 또는 고객원장이 있는 가장 빠른 일자
    - 최초로 고객 레코드를 생성했다고 판단하는 날짜
    - 최초생성일이 부정확하거나 정보가 없을 경우 '99991231' 회신
    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 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 동일계좌번호라 하더라도 회차번호에 따라 별도의 복수개의 계좌로 관리하는 기관(기업은행, 산업은행 등)만 회신
    - 계좌번호만으로 PK처리가 가능한 경우, 회신하면 안됨
    --is_foreign_deposit 외화계좌여부 N Boolean 해당 수신계좌가 외화계좌인지 여부
    - 외화계좌(true)일 경우, 해당 계좌의 통화코드는 기본정보(은행-002), 추가정보(은행-003) API를 통해 확인 가능
    - 수신계좌가 아닌 경우는 미회신
    --prod_name 상품명 Y AH(300) 해당 계좌의 상품명
    --is_minus 마이너스약정여부 N Boolean 해당 수신계좌와 연결된 마이너스대출 약정 보유 여부
    - 수신계좌가 아닌경우는 미회신
    --account_type 게좌구분 (코드) Y aN(4) 계좌번호 별 구분 코드
    - [첨부3] 계좌번호 별 구분 코드
    --account_status 계좌상태 (코드) Y aN(2) 계좌번호 별 상태 코드

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

    기본 정보
    API ID 은행-001 HTTP Method GET
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts
    설명 정보주체가 보유한 금융회사별 계좌 목록 조회
    - Pagination, 계좌구분(코드) 기준 오름차순 후 계좌번호 기준 오름차순
    - 신용정보법 시행령 제28조의3제9항에 의거, 개인인 정보주체의 요청으로 특약사항을 기재하거나 약정하여 해당 정보의 제3자 제공을 금지한 경우 또는 비대면 정보 조회를 금지한 경우(예:숨김계좌, 보안계좌 등)에는 해당 정보에 대하여 대면으로 전송요구권을 행사하도록 되어있어, 회신 대상에서 제외
    - 마이너스통장(is_minus가 'true'인 수신계좌)은 수신계좌 및 대출계좌 둘 다에 해당되기 때문에 아래와 같은 기준 수립
    - 기본정보 조회 : 은행-002(수신계좌 기본정보), 은행-008(대출계좌 기본정보)
    - 추가정보 조회 : 은행-003(수신계좌 추가정보), 은행-009(대출계좌 추가정보)
    - 거래내역 조회 : 은행-004(수신계좌 거래내역)
    * 은행-008, 은행-009 호출시에도 대출용 계좌번호가 아닌 수신용 계좌번호 사용
    - 공동명의 계좌는 전송요구 대상에서 제외
    - 해지된 계좌는 전송요구 대상에서 제외
    - 중첩적 채무인수의 경우, 채무를 인수받은 시점을 기준으로 해당 대출상품계좌는 인수자의 전송요구 대상에 포함되며, 인계자의 전송요구 대상에서는 제외
    기준시점 현재 시점
    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을 회신 또는 미회신
    reg_date 고객정보 최초생성일 Y DATE 해당 금융기관에서 최초로 고객번호를 채번한 날짜(CRM 최초등록일) 또는 고객원장이 있는 가장 빠른 일자
    - 최초로 고객 레코드를 생성했다고 판단하는 날짜
    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 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 동일계좌번호라 하더라도 회차번호에 따라 별도의 복수개의 계좌로 관리하는 기관(기업은행, 산업은행 등)만 회신
    - 계좌번호만으로 PK처리가 가능한 경우, 회신하면 안됨
    --is_foreign_deposit 외화계좌여부 N Boolean 해당 수신계좌가 외화계좌인지 여부
    - 외화계좌(true)일 경우, 해당 계좌의 통화코드는 기본정보(은행-002), 추가정보(은행-003) API를 통해 확인 가능
    - 수신계좌가 아닌 경우는 미회신
    --prod_name 상품명 Y AH(300) 해당 계좌의 상품명
    --is_minus 마이너스약정여부 N Boolean 해당 수신계좌와 연결된 마이너스대출 약정 보유 여부
    - 수신계좌가 아닌경우는 미회신
    --account_type 게좌구분 (코드) Y aN(4) 계좌번호 별 구분 코드
    - [첨부3] 계좌번호 별 구분 코드
    --account_status 계좌상태 (코드) Y aN(2) 계좌번호 별 상태 코드

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

    기본 정보
    API ID 은행-002 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts/deposit/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    basic_cnt 기본정보목록수 Y N(3) 기본정보가 복수 개인 계좌(예: 다 통화예금이 가능한 외화예금의 경우 통화코드 별로 기본정보가 별도로 관리)를 수용하기 위한 List로 회신
    basic_list 기본정보목록 Y <object>
    --currency_code 통화코드 N A(3) 해당 계좌번호에 적용된 통화코드 (ISO 4217 준용)
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)
    --saving_method 저축방법 Y aN(2) 고객이 해당 계좌에 납입하는 방법
    - <코드값>
    01 : 요구불식
    02 : 거치식
    03 : 정액적립식
    04 : 자유적립식
    --issue_date 계좌개설일자 Y DATE 금융기관에서 해당 계좌를 개설한 날짜
    --exp_date 만기일 N DATE 해당 계좌의 금융거래가 만기(종료)되는 날짜 또는 계좌 상품의 만기가 되는 날짜
    - 만기일 없는 상품은 회신 안 함
    --commit_amt 약정액 N F(18,3) 예금주가 납입하기로 약정한 금액
    - 계좌구분에 따라 해당 없을 경우 회신 안 함
    --monthly_paid_in_amt 월 납입액 N F(18,3) 해당 상품에 예금주가 매월 납입 신청한 금액
    - 정기납입 상품 정보만 제공
    - 계좌구분에 따라 해당 없을 경우 회신 안 함

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

    기본 정보
    API ID 은행-002 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/deposit/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    basic_cnt 기본정보목록수 Y N(3) 기본정보가 복수 개인 계좌(예: 다 통화예금이 가능한 외화예금의 경우 통화코드 별로 기본정보가 별도로 관리)를 수용하기 위한 List로 회신
    basic_list 기본정보목록 Y <object>
    --currency_code 통화코드 N A(3) 해당 계좌번호에 적용된 통화코드 (ISO 4217 준용)
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)
    --saving_method 저축방법 Y aN(2) 고객이 해당 계좌에 납입하는 방법
    - <코드값>
    01 : 요구불식
    02 : 거치식
    03 : 정액적립식
    04 : 자유적립식
    --issue_date 계좌개설일자 Y DATE 금융기관에서 해당 계좌를 개설한 날짜
    --exp_date 만기일 N DATE 해당 계좌의 금융거래가 만기(종료)되는 날짜 또는 계좌 상품의 만기가 되는 날짜
    - 만기일 없는 상품은 회신 안 함
    --commit_amt 약정액 N F(18,3) 예금주가 납입하기로 약정한 금액
    - 계좌구분에 따라 해당 없을 경우 회신 안 함
    --monthly_paid_in_amt 월 납입액 N F(18,3) 해당 상품에 예금주가 매월 납입 신청한 금액
    - 정기납입 상품 정보만 제공
    - 계좌구분에 따라 해당 없을 경우 회신 안 함

  • 수신계좌 추가정보 조회 v2 2022-10-19

    기본 정보
    API ID 은행-003 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/deposit/detail
    설명 정보주체가 보유한 계좌별 추가 정보 조회
    기준시점 현재 시점
    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) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-"제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    detail_cnt 추가정보목록수 Y N(3) 추가정보가 복수개인 계좌(예: 다통화예금이 가능한 외화예금의 경우 통화코드별로 잔액등을 별도로 관리)를 수용하기 위해 List로 회신
    detail_list 추가정보목록 Y <object>
    --currency_code 통화코드 N A(3) 통화코드 (ISO 4217 준용)
    - 외화예금 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    --balance_amt 현재잔액 Y F(18,3) 조회 시점 계좌의 잔액
    --withdrawable_amt 출금 가능액 Y F(18,3) 현재 잔액 중 출금할 수 있는 금액
    --offered_rate 금리 Y F(7,5) 상품에 적용된 금리
    - 우대금리는 상품 만기시에 결정되는 사항으로 제외
    - 금리변동상품의 금리변동분은 실시간 반영이 불가하여 실제 적용금리와 차이가 발생할 수 있음
    - 만기 후 미해지 상태의 계좌의 경우, 고객이 뱅킹앱에서 조회하였을 때 보여지는 금리값 또는 원장상 저장된 값을 회신
    --last_paid_in_cnt 최종납입회차 N N(6) 계좌에 최종적으로(현재를 기준으로 가장 최신) 납입한 회차
    - 계좌구분에 따라 해당 없을 경우 회신 안함

  • 수신계좌 추가정보 조회 v1 2022-10-19

    기본 정보
    API ID 은행-003 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts/deposit/detail
    설명 정보주체가 보유한 계좌별 추가 정보 조회
    기준시점 현재 시점
    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) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-"제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    detail_cnt 추가정보목록수 Y N(3) 추가정보가 복수개인 계좌(예: 다통화예금이 가능한 외화예금의 경우 통화코드별로 잔액등을 별도로 관리)를 수용하기 위해 List로 회신
    detail_list 추가정보목록 Y <object>
    --currency_code 통화코드 N A(3) 통화코드 (ISO 4217 준용)
    - 외화예금 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    --balance_amt 현재잔액 Y F(18,3) 조회 시점 계좌의 잔액
    --withdrawable_amt 출금 가능액 Y F(18,3) 현재 잔액 중 출금할 수 있는 금액
    --offered_rate 적용금리 Y F(7,5) 상품에 적용된 기준금리
    - 우대금리는 상품 만기시에 결정되는 사항으로 제외
    --last_paid_in_cnt 최종납입회차 N N(6) 계좌에 최종적으로(현재를 기준으로 가장 최신) 납입한 회차
    - 계좌구분에 따라 해당 없을 경우 회신 안함

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

    기본 정보
    API ID 은행-004 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/deposit/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 API에서 회차번호를 회신한 기관의 경우, 해당 회차번호를 그대로 세팅
    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 : 입금
    04 : 정정(입금)
    05 : 정정(출금)
    06 : 출금취소(입금)
    07 : 입금취소(출금)
    98 : 기타(입금)
    99 : 기타(출금)
    --trans_class 거래구분 Y AH(15) 해당 거래의 구분 (예 : 창구, 인터넷뱅킹, ATM 등)
    - 텍스트로 전송
    --currency_code 통화코드 N A(3) 통화코드 (ISO 4217 준용)
    - 외화예금 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    --trans_amt 거래금액 Y F(18,3) 해당 계좌에서 일어난 거래의 금액
    --balance_amt 거래 후 잔액 Y F(18,3) 거래가 일어난 후 잔액
    --paid_in_cnt 납입회차 N N(6) 해당 거래의 납입 회차
    - 계좌구분에 따라 해당 없을 경우 회신 안 함
    --trans_memo 적요 N AH(90) 계좌입출금 거래 관련 수취·송금인 계좌·성명·메모 등이 기록된 정보로서 정보주체가 직접 기록한 내용(자동 입력에 의한 정보 포함)
    - 정보주체가 전송요구 시 적요 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_memo='true') 회신하고, 그렇지 않은 경우 미회신

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

    기본 정보
    API ID 은행-004 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts/deposit/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 API에서 회차번호를 회신한 기관의 경우, 해당 회차번호를 그대로 세팅
    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 : 입금
    04 : 정정(입금)
    05 : 정정(출금)
    06 : 출금취소(입금)
    07 : 입금취소(출금)
    98 : 기타(입금)
    99 : 기타(출금)
    --trans_class 거래구분 Y AH(15) 해당 거래의 구분 (예 : 창구, 인터넷뱅킹, ATM 등)
    - 텍스트로 전송
    --currency_code 통화코드 N A(3) 통화코드 (ISO 4217 준용)
    - 외화예금 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    --trans_amt 거래금액 Y F(18,3) 해당 계좌에서 일어난 거래의 금액
    --balance_amt 거래 후 잔액 Y F(18,3) 거래가 일어난 후 잔액
    --paid_in_cnt 납입회차 N N(6) 해당 거래의 납입 회차
    - 계좌구분에 따라 해당 없을 경우 회신 안 함
    --trans_memo 적요 N AH(90) 계좌입출금 거래 관련 수취·송금인 계좌·성명·메모 등이 기록된 정보로서 정보주체가 직접 기록한 내용(자동 입력에 의한 정보 포함)
    - 정보주체가 전송요구 시 적요 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_memo='true') 회신하고, 그렇지 않은 경우 미회신

  • 투자상품계좌 기본정보 조회 v1 2022-10-19

    기본 정보
    API ID 은행-005 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts/invest/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y AN(25) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-"제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    standard_fund_code 표준펀드코드 Y aN(12) 금융투자협회의 표준펀드코드
    paid_in_type 납입유형 (코드) Y aN(2) 해당투자상품에 대한 고객의 납입 유형 코드
    - <코드값>
    01 : 임의식
    02 : 적립식
    03 : 거치식
    issue_date 개설일 Y DATE 보유 투자 상품의 계좌 개설일(신규일자)
    exp_date 만기일 N DATE 보유 투자 상품 만기일
    - 만기일 없는 상품은 회신 안 함

  • 펀드상품계좌 기본정보 조회 v2 2022-10-19

    기본 정보
    API ID 은행-005 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/invest/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y AN(25) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-"제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    standard_fund_code 표준펀드코드 Y aN(12) 금융투자협회의 표준펀드코드
    paid_in_type 납입유형 (코드) Y aN(2) 해당펀드상품에 대한 고객의 납입 유형 코드
    - <코드값>
    01 : 임의식
    02 : 적립식
    03 : 거치식
    issue_date 개설일 Y DATE 보유 펀드상품의 계좌 개설일(신규일자)
    exp_date 만기일 N DATE 보유 펀드상품 만기일
    - 만기일 없는 상품은 회신 안 함

  • 펀드상품계좌 추가정보 조회 v2 2022-10-19

    기본 정보
    API ID 은행-006 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/invest/detail
    설명 정보주체가 보유한 펀드상품별 추가(잔액 등) 정보 조회
    기준시점 현재 시점
    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) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    currency_code 통화코드 N A(3) 통화코드 (ISO 4217 준용)
    - 역외펀드 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    balance_amt 잔액 Y F(18,3) 결산 후 잔액
    - 투자 설정액의 수익, 손실을 감안한 금액, 결산 후 재투자금액 반영
    eval_amt 평가금액 Y F(18,3) 잔고좌수 * (기준가/1000) (매입/환매 체결기준)
    inv_principal 투자원금 Y F(18,3) 금융상품, 펀드원금잔액
    - 선취수수료 미포함
    - 최초결산 이전에는 '잔액'과 같은 값
    fund_num 보유좌수 N F(18,3) 보유한 펀드의 좌수
    - 펀드 좌수가 존재하지 않는 상품의 경우 미회신

  • 투자상품계좌 추가정보 조회 v1 2022-10-19

    기본 정보
    API ID 은행-006 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts/invest/detail
    설명 정보주체가 보유한 투자상품별 추가(잔액 등) 정보 조회
    기준시점 현재 시점
    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) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    currency_code 통화코드 N A(3) 통화코드 (ISO 4217 준용)
    - 역외펀드 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    balance_amt 잔액 Y F(18,3) 결산 후 잔액
    - 투자 설정액의 수익, 손실을 감안한 금액, 결산 후 재투자금액 반영
    eval_amt 평가금액 Y F(18,3) 잔고좌수 * (기준가/1000) (매입/환매 체결기준)
    inv_principal 투자원금 Y F(18,3) 금융상품, 투자원금잔액
    - 선취수수료 미포함
    - 최초결산 이전에는 '잔액'과 같은 값
    fund_num 보유좌수 N F(18,3) 보유한 펀드의 좌수
    - 펀드 좌수가 존재하지 않는 상품의 경우 미회신

  • 투자상품계좌 거래내역 조회 v1 2022-10-19

    기본 정보
    API ID 은행-007 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts/invest/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 API에서 회차번호를 회신한 기관의 경우, 해당 회차번호를 그대로 세팅
    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 : 입금
    03 : 출금
    04 : 신규예약
    05 : 입금예약
    06 : 출금예약
    07 : 해지예약
    08 : 재투자
    09 : 정정(입금)
    10 : 정정(출금)
    98 : 기타(입금)
    99 : 기타(출금)
    - 신규예약, 입금예약, 출금예약 등 예약 거래와 이후 실 거래의 데이터는 별개로 전송(실 거래의 데이터를 예약거래의 데이터로 대체하지 않음. 단, 해지예약의 경우에는 해지 이후 데이터 전송에서 제외되기 때문에 실거래 데이터가 전송에서 제외됨)
    --currency_code 통화코드 N A(3) 통화코드 (ISO 4217 준용)
    - 역외펀드 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)
    --base_amt 기준가 N F(18,3) 기준가 : 펀드 1000좌당 가격 (실 계약 시 기준가)
    - 기준가, 거래좌수가 확정 전(예: 예약거래가 실행되기 이전 등)인 경우 미회신
    --trans_fund_num 거래좌수 N F(18,3) 해당 거래의 거래좌수
    - 기준가, 거래좌수가 확정 전(예: 예약거래가 실행되기 이전 등)인 경우 미회신
    --trans_amt 거래금액 Y F(18,3) 투자상품 거래금액
    --balance_amt 거래 후 잔고평가금액 Y F(18,3) 거래이후 평가금액 (매입/환매체결을 기준)

  • 펀드상품계좌 거래내역 조회 v2 2022-10-19

    기본 정보
    API ID 은행-007 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/invest/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 API에서 회차번호를 회신한 기관의 경우, 해당 회차번호를 그대로 세팅
    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 : 입금
    03 : 출금
    04 : 신규예약
    05 : 입금예약
    06 : 출금예약
    07 : 해지예약
    08 : 재투자
    09 : 정정(입금)
    10 : 정정(출금)
    98 : 기타(입금)
    99 : 기타(출금)
    - 신규예약, 입금예약, 출금예약 등 예약 거래와 이후 실 거래의 데이터는 별개로 전송(실 거래의 데이터를 예약거래의 데이터로 대체하지 않음. 단, 해지예약의 경우에는 해지 이후 데이터 전송에서 제외되기 때문에 실거래 데이터가 전송에서 제외됨)
    --currency_code 통화코드 N A(3) 통화코드 (ISO 4217 준용)
    - 역외펀드 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)
    --base_amt 기준가 N F(18,3) 기준가 : 펀드 1000좌당 가격 (실 계약 시 기준가)
    - 기준가, 거래좌수가 확정 전(예: 예약거래가 실행되기 이전 등)인 경우 미회신
    --trans_fund_num 거래좌수 N F(18,3) 해당 거래의 거래좌수
    - 기준가, 거래좌수가 확정 전(예: 예약거래가 실행되기 이전 등)인 경우 미회신
    --trans_amt 거래금액 Y F(18,3) 펀드상품 거래금액
    --balance_amt 거래 후 잔고평가금액 Y F(18,3) 거래이후 평가금액 (매입/환매체결을 기준)

  • 대출상품계좌 기본정보 조회 v1 2022-10-19

    기본 정보
    API ID 은행-008 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts/loan/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    issue_date 대출일 Y DATE 해당 대출이 실행된 날짜
    exp_date 만기일 Y DATE 해당 대출 계약이 만기(종료)되는 날짜
    last_offered_rate 최종적용금리 Y F(7,5) 차주가 가입한 대출상품의 최종금리
    - 대출 실행 시 정해진 최종금리를 의미하며, 금리 변동 사유 발생 시 변동된 금리를 회신
    - 마이너스통장의 경우 조회시점의 기준금리와 가산금리의 합
    repay_date 월상환일 N aN(2) 대출거래약정서 상 월 상환일('DD')마이너스 통장 등 월 상환일이 존재하지 않는 경우 미회신
    repay_method 상환방식(코드) Y aN(2) 해당 대출의 상환방식 구분 코드
    - [첨부4] 상환방식 코드
    repay_org_code 자동이체 기관(코드) N aN(8) 자동이체 등록이 된 상환계좌번호의 소속 기관 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 마이너스통장의 경우 이자납입계좌와 대출실행계좌가 다를 경우 전송
    - 대출실행 시 상환계좌번호를 미지정하거나, 지정 후 해제하는 등 자동이체 관련 정보가 없는 경우 미회신
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    repay_account_num 상환계좌번호(자동이체) N aN(20) 자동이체 등록이 된 상환계좌번호
    - 마이너스통장의 경우 이자납입계좌와 대출실행계좌가 다를 경우
    - 대출실행 시 상환계좌번호를 미지정하거나, 지정 후 해제하는 등 자동이체 관련정보가 없는 경우 미회신
    - 해당 계좌번호가 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신

  • 대출상품계좌 기본정보 조회 v2 2022-10-19

    기본 정보
    API ID 은행-008 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/loan/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    issue_date 대출일 Y DATE 해당 대출이 실행된 날짜
    exp_date 만기일 Y DATE 해당 대출 계약이 만기(종료)되는 날짜
    last_offered_rate 최종적용금리 Y F(7,5) 차주가 가입한 대출상품의 최종금리
    - 대출 실행 시 정해진 최종금리를 의미하며, 금리 변동 사유 발생 시 변동된 금리를 회신
    - 마이너스통장의 경우 조회시점의 기준금리와 가산금리의 합
    repay_date 월상환일 N aN(2) 대출거래약정서 상 월 상환일('DD')마이너스 통장 등 월 상환일이 존재하지 않는 경우 미회신
    repay_method 상환방식(코드) Y aN(2) 해당 대출의 상환방식 구분 코드
    - [첨부4] 상환방식 코드
    repay_org_code 자동이체 기관(코드) N aN(8) 자동이체 등록이 된 상환계좌번호의 소속 기관 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 마이너스통장의 경우 이자납입계좌와 대출실행계좌가 다를 경우 전송
    - 대출실행 시 상환계좌번호를 미지정하거나, 지정 후 해제하는 등 자동이체 관련 정보가 없는 경우 미회신
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    repay_account_num 상환계좌번호(자동이체) N aN(20) 자동이체 등록이 된 상환계좌번호
    - 마이너스통장의 경우 이자납입계좌와 대출실행계좌가 다를 경우
    - 대출실행 시 상환계좌번호를 미지정하거나, 지정 후 해제하는 등 자동이체 관련정보가 없는 경우 미회신
    - 해당 계좌번호가 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신
    unredeemed_start 거치기간 시작연월 N N(6) 해당 대출상품의 거치기간이 존재하는 경우, 거치기간이 시작되는 날짜(월단위)를 회신
    ex) 대출실행 시 거치기간이 시작되는 경우 대출일의 연월을 회신하며, 대출기간 중도에 거치기간이 시작하는 경우 시작일자의 연월을 회신
    unredeemed_end 거치기간 종료연월 N N(6) 해당 대출상품의 거치기간이 존재하는 경우, 거치기간이 종료되는 날짜(월단위)를 회신
    ex) 2022년 05월까지 거치기간이며, 6월부터 원금상환이 시작되는 경우 202205로 회신

  • 대출상품계좌 추가정보 조회 v1 2022-10-19

    기본 정보
    API ID 은행-009 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts/loan/detail
    설명 정보주체가 보유한 대출상품별 추가(잔액 등) 정보 조회
    기준시점 현재 시점
    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) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    currency_code 통화코드 N A(3) 통화코드(ISO 4217 준용)
    - 외화대출 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    balance_amt 대출잔액 Y F(18,3) 기준일자 현재 해당 대출상품에 상환해야 하는 잔여 금액
    loan_principal 대출원금 Y F(18,3) 해당 대출계약의 원금 전부
    next_repay_date 다음 이자 상환일 N DATE 다음 이자 상환 예정일
    - 상환 예정일 변경시, 변경후 일자 전송
    - 다음이자 상환일이 존재하지 않은 경우(만기일 경과 등) 최근 이자 상환일 전송
    - 실행 거래, 마이너스통장 이용 중 일부 케이스 등에서 다음 이자 상환일 데이터가 부재하는 경우 미회신

  • 대출상품계좌 추가정보 조회 v2 2022-10-19

    기본 정보
    API ID 은행-009 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/loan/detail
    설명 정보주체가 보유한 대출상품별 추가(잔액 등) 정보 조회
    기준시점 현재 시점
    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) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 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을 회신 또는 미회신
    currency_code 통화코드 N A(3) 통화코드(ISO 4217 준용)
    - 외화대출 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    balance_amt 대출잔액 Y F(18,3) 기준일자 현재 해당 대출상품에 상환해야 하는 잔여 금액
    loan_principal 대출원금 Y F(18,3) 해당 대출계약의 원금 전부
    next_repay_date 다음 이자 상환일 N DATE 다음 이자 상환 예정일
    - 상환 예정일 변경시, 변경후 일자 전송
    - 다음이자 상환일이 존재하지 않은 경우(만기일 경과 등) 최근 이자 상환일 전송
    - 실행 거래, 마이너스통장 이용 중 일부 케이스 등에서 다음 이자 상환일 데이터가 부재하는 경우 미회신

  • 대출상품계좌 거래내역 조회 v1 2022-10-19

    기본 정보
    API ID 은행-010 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/accounts/loan/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 API에서 회차번호를 회신한 기관의 경우, 해당 회차번호를 그대로 세팅
    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> 또는 DATE 해당 계좌에서 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 YYYYMMDD 회신 (일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 해당 일자의 거래 특정 번호
    - 없을 경우 회신 안 함
    --trans_type 거래유형 Y aN(2) 해당 거래의 유형
    - <코드값>
    01 : 실행
    02 : 상환
    03 : 정정
    99 : 기타
    --currency_code 통화코드 N A(3) 통화코드(ISO 4217 준용)
    - 외화대출 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    --trans_amt 거래금액 Y F(18,3) 해당 계좌에서 일어난 해당 거래(상환)의 금액
    --balance_amt 거래 후 대출잔액 Y F(18,3) 해당 계좌에서 거래가 일어난 후 남은 잔여 대출 금액
    --principal_amt 거래금액 중 원금 Y F(18,3) 해당 거래(상환) 금액 중 원금
    - 세전 금액 제공
    --int_amt 거래금액 중 이자 Y F(18,3) 해당 거래(상환) 금액 중 이자
    - "거래금액 중 이자"에 대한 정보 set : 한 건의 이자에 대해서도 여러 방식의 이자적용이 가능하기 때문에, [이자적용시작일, 이자적용종료일, 적용이율, 이자종류 (코드)] 데이터 항목이 Array로 적용
    --ret_int_amt 환출이자 N F(18,3) 고객에게 환출된 이자금액
    --int_cnt 이자적용수 Y N(3)
    --int_list 이자적용목록 Y <object>
    ----int_start_date 이자적용시작일 Y DATE 이자 계산기간의 시작일
    ----int_end_date 이자적용종료일 Y DATE 이자 계산기간의 종료일
    ----int_rate 적용이율 Y F(5,3) 해당 대출 거래(상환)시 납입한 이자의 이자율
    ----applied_int_amt 이자금액 Y F(18,3) 이자 기간과 적용이율을 통해 계상된 금액
    ----int_type 이자종류(코드) Y aN(2) 해당 거래의 이자 종류를 나타내는 구분 코드
    - <코드값>
    01 : 정상이자
    02 : 지연이자
    03 : 잔액연체이자
    99 : 기타

  • 대출상품계좌 거래내역 조회 v2 2022-10-19

    기본 정보
    API ID 은행-010 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/loan/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(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 은행-001 API에서 회차번호를 회신한 기관의 경우, 해당 회차번호를 그대로 세팅
    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> 또는 DATE 해당 계좌에서 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 YYYYMMDD 회신 (일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 해당 일자의 거래 특정 번호
    - 없을 경우 회신 안 함
    --trans_type 거래유형 Y aN(2) 해당 거래의 유형
    - <코드값>
    01 : 실행
    02 : 상환
    03 : 정정
    99 : 기타
    --currency_code 통화코드 N A(3) 통화코드(ISO 4217 준용)
    - 외화대출 등 통화코드가 필요한 경우
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    --trans_amt 거래금액 Y F(18,3) 해당 계좌에서 일어난 해당 거래(상환)의 금액
    --balance_amt 거래 후 대출잔액 Y F(18,3) 해당 계좌에서 거래가 일어난 후 남은 잔여 대출 금액
    --principal_amt 거래금액 중 원금 Y F(18,3) 해당 거래(상환) 금액 중 원금
    - 세전 금액 제공
    --int_amt 거래금액 중 이자 Y F(18,3) 해당 거래(상환) 금액 중 이자
    - "거래금액 중 이자"에 대한 정보 set : 한 건의 이자에 대해서도 여러 방식의 이자적용이 가능하기 때문에, [이자적용시작일, 이자적용종료일, 적용이율, 이자종류 (코드)] 데이터 항목이 Array로 적용
    --ret_int_amt 환출이자 N F(18,3) 고객에게 환출된 이자금액
    --int_cnt 이자적용수 Y N(3)
    --int_list 이자적용목록 Y <object>
    ----int_start_date 이자적용시작일 Y DATE 이자 계산기간의 시작일
    ----int_end_date 이자적용종료일 Y DATE 이자 계산기간의 종료일
    ----int_rate 적용이율 Y F(5,3) 해당 대출 거래(상환)시 납입한 이자의 이자율
    ----applied_int_amt 이자금액 Y F(18,3) 이자 기간과 적용이율을 통해 계상된 금액
    ----int_type 이자종류(코드) Y aN(2) 해당 거래의 이자 종류를 나타내는 구분 코드
    - <코드값>
    01 : 정상이자
    02 : 지연이자
    03 : 잔액연체이자
    99 : 기타

  • 신탁/ISA 상품 기본 정보 조회 v2 2022-10-19

    기본 정보
    API ID 은행-011 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/isa/basic
    설명 정보주체가 보유한 신탁/ISA 상품별 기본 정보 조회
    - 신탁상품은 특정금전신탁에 한정하여 제공 (연금신탁상품의 경우, 은행원에서는 불특정 금전신탁으로 분류하고 있지만, 마이데이터에서 특정금전신탁은 '개별편입상품이 금융자산(주식, 채권)으로 편입되어있고 고객에게 납입금액, 평가금액을 제공할 수 있는 신탁상품'을 정의하므로, 본 API에 포함하여 '23년 6월말부터 제공)
    - 유언대용신탁의 경우 위탁자별 신탁계약에 따라 조건이 다양하며, 대부분 비대면으로만 계좌조회가 가능하므로 제공대상에서 제외
    - 공익신탁은 비대면으로만 계좌조회가 가능하며, 고객 소유 자산 성격이 아니므로 제공대상에서 제외
    - 부동산 등 비금전자산이 신탁물로 편입된 계약 중 개별적인 계약 조건에 따라 진행되어, 계좌번호가 없거나 상품화되지 않아 API를 통해 상품정보 제공이 어려운 상품은 제외
    기준시점 현재 시점
    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) 고객이 보유한 신탁/ISA 상품 계좌번호
    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을 회신 또는 미회신
    currency_code 통화코드 N A(3) (선택전송) 해당 상품에 적용된 통화 코드(ISO4217 준용)
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)
    balance_amt 계좌잔액 N F(18,3) 신탁/ISA 계좌의 잔액(각 사 정책에 따라
    전송하되, 앱 또는 웹을 고객에게 제공하는 수치와 같은 값)
    eval_amt 계좌평가금액 N F(18,3) 조회 시점 전일자 기준의 이자 등 운용수익이
    반영된 평가금액(계좌 전체 기준, 수수료 관련
    이슈는 각 사 정책에 따름)
    issue_date 개설일 Y DATE 보유 신탁/ISA 상품의 계좌 개설일(신규일자)
    exp_date 만기일 Y DATE 보유 신탁/ISA 상품 만기일

  • 신탁/ISA 상품 거래내역 정보 조회 v2 2022-10-19

    기본 정보
    API ID 은행-012 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/isa/transactions
    설명 정보주체가 보유한 신탁/ISA 상품에서 조회 기간 동안 발생한 상세 거래 정보 조회 (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) 고객이 보유한 신탁/ISA 상품 계좌번호
    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 : 출금
    07 : 해지예약
    08 : 재투자
    09 : 정정(입금)
    10 : 정정(출금)
    98 : 기타(입금)
    99 : 기타(출금)
    --currency_code 통화코드 N A(3) (선택전송) 해당 상품에 적용된 통화 코드 (ISO 4217 준용)
    - 통화코드 값이 명시되어있지 않을 경우 KRW(원)
    --trans_amt 거래금액 Y F(18,3) 해당 거래의 금액

  • 신탁/ISA 개별운용상품 정보 조회 v2 2022-10-19

    기본 정보
    API ID 은행-013 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/isa/detail
    설명 정보주체가 보유한 개별운용상품별 추가(잔액 등) 정보 조회
    (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) 고객이 보유한 신탁/ISA 상품 계좌번호
    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] 페이지네이션 참조
    isa_cnt 운용상품수 Y N(3) 보유한 신탁/ISA 개별운용상품 수
    - 신탁상품 중, 단일상품으로 운용되더라도, 보유좌수 등 개별운용상품 항목 상 제공대상정보(보유좌수 등)가 있는 경우에는 운용상품수를 1로, 운용상품목록에 단일상품정보를 회신
    - 신탁상품 중, 단일상품으로 운용되며, 개별운용상품 항목 상 제공대상정보가 기본정보와 동일한 경우에는 운용상품수를 0으로 회신하며, 운용상품목록에 빈(empty) List를 회신
    isa_list 운용상품목록 Y <object>
    --prod_name 개별운용상품명 Y AH(300) 정보제공자의 원장에 기록되어 있는 개별운용상품의 명치
    일임형 ISA경우, 운용상품수에 1, 상품명에
    , MP명으로 회신
    --prod_num 상품가입번호 N aN(64) (선택전송) 동일 상품에 대해 중복 투자한 경우 이를 구분하기 위한 식별값
    --prod_type 상품유형
    (코드)    		 Y aN(2) 개별운용상품의 상품 유형
    - <코드값>
    01 : 원리금 보장
    02 : 원리금 비보장
    03 : 기타
    --currency_code 통화코드 N A(3) 통화코드 (ISO 4217 준용)
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)
    --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) 단일 개별운용상품에 다수의 계좌상품이
    포함되어 해당 정보들이 각기 관리되는 경우

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

    기본 정보
    API ID 은행-014 HTTP Method POST
    API 제공자 은행업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/accounts/deposit/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(10) 자동이체 등록계좌번호
    --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
    - 기타 : 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) /bank/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 등)

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

    기본 정보
    API ID 정보제공-공통-002 (은행) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자
    API 명 (URI) /v1/bank/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에서 상품(구매)분류 (코드) 미회신

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

    기본 정보
    API ID 정보제공-공통-002 (은행) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자
    API 명 (URI) /v2/bank/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에서 상품(구매)분류 (코드) 미회신

Table of contents

은행 업권 정보제공 API 규격