금융보안원 로고

회원가입 로그인

API가이드

할부금융 업권 정보제공 API 규격

  • API 목록 조회 (공통) v1 2021-10-18

    기본 정보
    API ID 정보제공-공통-001 (할부) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자, 종합포털
    API 명 (URI) /capital/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 2021-10-18

    기본 정보
    API ID 정보제공-공통-002 (할부) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자
    API 명 (URI) /v1/capital/consents
    설명 정보주체가 특정한 전송요구 내역 조회
    - 시행 초기 전산 용량 등을 감안하여 초기에는 전송 주기(fnd_cycle, add_cycle)를 주1회(“1/w”)로 고정하고, 추후 논의 과정을 거쳐 고객의 선택권을 다양화할 예정
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json
    요청 메세지 명세
    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에서 상품(구매)분류 (코드) 미회신

  • 계좌 목록 조회 v1 2021-10-18

    기본 정보
    API ID 할부금융-001 HTTP Method GET
    API 제공자 할부금융업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/capital/loans
    설명 정보주체가 보유한 캐피탈사 별 계좌 목록 조회
    - Pagination, 계좌구분(코드) 기준 오름차순
    회신되는 계좌구분(코드)가 3710(운용리스)인지 여부에 따라 기본정보, 추가정보 및 거래내역 조회 API가 구분
    - 코드값이 3710(운용리스)이 아닌 경우 정보 및 거래내역 등 조회 : 할부금융-002, 할부금융-003, 할부금융-004 API 호출
    - 코드값이 3710(운용리스)인 경우 정보 및 거래내역 등 조회 : 할부금융-005, 할부금융-006 API 호출
    - 해지된 계좌는 전송요구 대상에서 제외
    기준시점 현재 시점
    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 최초고객DB 생성일 Y DATE 해당 금융기관에서 최초로 고객 레코드를 생성한 날짜
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    account_cnt 보유계좌수 Y N(3)
    account_list 보유계좌목록 Y Object
    --account_num 계좌번호 Y aN(20) 금융회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    - 데이터들을 관리하기 위한 Primary Key로 사용
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품등에 적용)의 경우 회차번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 동일계좌번호라 하더라도 회차번호에 따라 별도의 복수개의 계좌로 관리하는 기관만 회신
    - 계좌번호만으로 PK처리가 가능한 경우, 회신하면 안됨
    --prod_name 상품명 Y AH(300) 해당 계좌의 상품명
    --account_type 계좌구분 (코드) Y aN(4) 계좌번호 별 구분 코드
    - [첨부3] 계좌번호 별 구분 코드
    --account_status 계좌상태 (코드) Y aN(2) 계좌번호 별 상태 코드
    - <코드표>
    01 : 활동(사고 포함),

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

    기본 정보
    API ID 할부금융-002 HTTP Method POST
    API 제공자 할부금융업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/capital/loans/basic
    설명 정보주체가 보유한 대출상품별 기본 정보 조회
    - 할부금융-001 API 회신 값 중 계좌구분(코드)(account_type) 코드값이 3710(운용리스)이 아닌 계좌의 경우 본 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) 금융 회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    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) 자동이체 등록이 된 상환계좌번호
    - 대출실행 시 상환계좌번호를 미지정하거나, 지정후 해제하는 등 자동이체 관련 정보가 없는 경우 미회신
    - 해당 계좌번호가 정보주체 본인소유가 확인된 경우에만 전송하며, 확인이 불가하거나 타인의 소유일 경우에는 미전송

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

    기본 정보
    API ID 할부금융-003 HTTP Method POST
    API 제공자 할부금융업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/capital/loans/detail
    설명 정보주체가 보유한 대출상품별 추가(잔액 등) 정보 조회
    - 할부금융-001 API 회신 값 중 계좌구분(코드)(account_type) 코드값이 3710(운용리스)이 아닌 계좌의 경우 본 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) 금융 회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    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 다음 이자 상환일 Y DATE 다음 이자 상환 예정일(또는 차기 결제일)
    - 상환 예정일 변경시, 변경 후 일자 전송
    - 다음 이자 상환일이 존재하지 않는 경우 (만기일 경과 등) 최근 이자 상환일 전송

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

    기본 정보
    API ID 할부금융-004 HTTP Method POST
    API 제공자 할부금융업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/capital/loans/transactions
    설명 정보주체가 보유한 대출상품에서 조회 기간 동안 발생한 상세 거래 정보 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - 할부금융-001 API 회신 값 중 계좌구분(코드)(account_type) 코드값이 3710(운용리스)이 아닌 계좌의 경우 본 API 사용
    기준시점 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 해당 계좌에서 거래가 일어난 날짜와 시간
    --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 이자금액 N F(18,3) 이자 기간과 적용이율을 통해 계상된 금액
    ----int_type 이자종류(코드) Y aN(2) 해당 거래의 이자 종류를 나타내는 구분 코드
    - <코드값>
    01 : 정상이자
    02 : 지연이자
    03 : 잔액연체이자
    99 : 기타

  • 운용리스 기본정보 조회 v1 2021-10-18

    기본 정보
    API ID 할부금융-005 HTTP Method POST
    API 제공자 할부금융업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/capital/loans/oplease/basic
    설명 정보주체가 보유한 운용리스 기본 정보 조회
    - 할부금융-001 API 회신 값 중 계좌구분(코드)(account_type) 코드값이 3710(운용리스)인 계좌의 경우 본 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) 금융 회사에서 고객이 이용하는 상품 또는 서비스에 부여하는 식별번호 (전체 자릿수)
    - "-" 제외
    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 해당 운용리스가 만기(종료)되는 날짜
    repay_date 월상환일 Y 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) 자동이체 등록이 된 상환계좌번호
    - 가상계좌 입금만 있고, 자동이체 서비스를 제공하지 않는 경우 미회신
    - 해당 계좌번호가 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신
    next_repay_date 다음 납입 예정일 Y DATE 다음 월리스료 납입 예정일
    - 정보없을 경우 “00000000“ 회신

  • 운용리스 거래내역 조회 v1 2021-10-18

    기본 정보
    API ID 할부금융-006 HTTP Method POST
    API 제공자 할부금융업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/capital/loans/oplease/transactions
    설명 정보주체가 보유한 운용리스에서 조회 기간 동안 발생한 상세 거래 정보 조회(Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - 할부금융-001 API 회신 값 중 계좌구분(코드)(account_type) 코드값이 3710(운용리스)인 계좌의 경우 본 API 사용
    기준시점 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 해당 운용리스에서 거래가 일어난 날짜와 시간
    --trans_no 거래번호 N aN(64) 해당 일자의 거래 특정 번호
    - 없을 경우 회신 안 함
    --trans_type 거래유형 Y aN(2) 해당 거래의 유형
    - <코드값>
    01 : 실행
    02 : 일부상환
    99 : 기타
    --trans_amt 거래금액 Y F(18,3) 해당 계좌에서 일어난 해당 거래(상환)의 금액

Table of contents

할부금융 업권 정보제공 API 규격