금융보안원 로고

회원가입 로그인

API가이드

개별인증 API

  • 선불전자지급수단 목록 조회 v2 2022-10-19

    기본 정보
    API ID 전금-001 HTTP Method GET
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/efin/prepaid
    설명 정보주체가 가입한 전자지급수단 목록 조회
    - Pagination, 가입일자 기준 오름차순
    - 전송요구 단위는 권면(선불전자지급수단)이며, 따라서 고객이 전송요구 시 선택한 권면의 잔액정보, 자동충전정보 및 거래내역 등이 전송대상이 뒴
    - 권면상태가 '활동'인 권면만 전송요구 대상
    - (참고) 계정과 전자지급수단(권면) 관계
    1) 계정:권면=1:n (쿠팡, 핀크 등. 계정은 1개이고, 권면은 복수 개(예:쿠팡머니, 쿠팡캐시 등) 존재
    2) 계정:권면=n:1 (계정은 복수 개이고, 권면은 한 개 존재(권면 하나를 복수 개의 계정이 나눠쓰는 형태))
    3) 계정:권면=1:1 (카카오 등. 계정 및 권면은 복수 개이고, 계정당 권면 한 개씩 존재)
    4) 계정:권면=n:n (네이버 등. 계정 및 권면이 복수개이고, 계정 당 다 권면 가능)
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    fob_cnt 권면수 Y N(3)
    fob_list 권면목록 Y Object
    --fob_id 권면 ID Y aNS(64) 권면을 식별하기 위해 데이터 보유자가 부여한 권면의 고유 식별자
    --fob_name 권면명 Y AH(75) 권면의 발행자가 설정한 공식 명칭
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(권면)에 대해 개인신용정보 전송요구를 했는지 여부
    --reg_date 가입일자 Y DATE 권면별 최초 정보 생성일(ex. 권면 발행일, 회원 가입일)
    - CI 또는 주민등록번호 등 개인식별키 수집 이전의 금융정보는 전송요구대상에서 제외되어, 개인식별키 수집일자가 회원가입일보다 이후일 경우, 개인식별키 수집일자 전송
    --limit_amt 권면한도 Y F(5,1) 회원에게 발행한 선불전자지급수단의 권면한도 (최대 200, 단위: 만원)
    - 실지명의 확인 안 된 무기명식 권면한도 : 50만원
    - 실지명의가 확인된 은행계좌와 연결하여 발행한 기명식 권면한도 : 최대 200만원
    - 본인확인이 안된(CI가 없는) 무기명 선불전자지급수단은 제외 (예: 선불 교통카드 등)
    --is_charge 자동충전 등록 여부 Y Boolean 권면에 등록된 자동충전 정보 유무
    (회신값이 "true"인 경우, 선불전자지급수단 자동충전정보 조회 API(전금-003) 호출 가능)
    --is_withdrawable 출금 가능 여부 Y Boolean 권면의 출금 가능 유무
    - 신청 후 수일이 걸리는 환불의 경우 false 전송하며, 즉시 환불이 가능한 경우 true 전송
    --currency_code 통화코드 N A(3) 외화를 취급하는 선불 지급수단인 경우 해당 권면의 통화코드(ISO 4217 준용)
    - KRW인 경우 미회신
    - 통화코드를 회신한 경우, 해당 권면의 금액 관련 항목들(전금-002 ~ 전금-004 API 내 총잔액, 충전포인트 잔액, 거래금액 등)은 통화코드에 해당하는 금액을 의미
    --account_cnt 계정수 N N(3) - 계정이 존재하지 않는 기관의 경우 회신 안 함
    -권면 하나를 여러 계정이 공유하는 경우 회신 안 함
    --account_list 계정목록 N Object
    ----account_id 계정식별값 N AH(60) 권면에 하나 또는 다수의 계정이 연결되어 있을 경우, 각 계정을 구별할 수 있는 Key(ex. 계정ID)
    - 네이버, 카카오 등 일부기관의 경우, 동일 개인식별값 내에 다수의 계정을 보유할 수 있으며, 계정별로 정보들이 축적되고 있기 때문에 계정을 식별할 수 있는 Key 회신 필요
    - 동일한 계정ID를 복수 개 사용하는 기관(예: 이베이코리아의 경우, 고객이 옥션, 지마켓 계정ID를 동일하게 사용하는 경우 존재)의 경우 계정ID_사이트명 등과 같이 고객이 식별가능한 값 회신

  • 선불전자지급수단 목록 조회 v1 2022-10-19

    기본 정보
    API ID 전금-001 HTTP Method GET
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/efin/prepaid
    설명 정보주체가 가입한 전자지급수단 목록 조회
    - Pagination, 가입일자 기준 오름차순
    - 전송요구 단위는 권면(선불전자지급수단)이며, 따라서 고객이 전송요구 시 선택한 권면의 잔액정보, 자동충전정보 및 거래내역 등이 전송대상이 뒴
    - 권면상태가 '활동'인 권면만 전송요구 대상
    - (참고) 계정과 전자지급수단(권면) 관계
    1) 계정:권면=1:n (쿠팡, 핀크 등. 계정은 1개이고, 권면은 복수 개(예:쿠팡머니, 쿠팡캐시 등) 존재
    2) 계정:권면=n:1 (네어버 등. 계정은 복수 개이고, 권면은 한 개 존재(권면 하나로 복수 개의 계정이 나눠쓰는 형태))
    3) 계정:권면=1:1 (카카오 등. 계정 및 권면은 복수 개이고, 계정당 권면 한 개씩 존재)
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    fob_cnt 권면수 Y N(3)
    fob_list 권면목록 Y Object
    --fob_id 권면 ID Y aNS(64) 권면을 식별하기 위해 데이터 보유자가 부여한 권면의 고유 식별자
    --fob_name 권면명 Y AH(75) 권면의 발행자가 설정한 공식 명칭
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(권면)에 대해 개인신용정보 전송요구를 했는지 여부
    --reg_date 가입일자 Y DATE 권면별 최초 정보 생성일(ex. 권면 발행일, 회원 가입일)
    - CI 또는 주민등록번호 등 개인식별키 수집 이전의 금융정보는 전송요구대상에서 제외되어, 개인식별키 수집일자가 회원가입일보다 이후일 경우, 개인식별키 수집일자 전송
    --limit_amt 권면한도 Y N(5) 회웒에게 발행한 선불전자지급수단의 권면한도 (최대 200, 단위: 만원)
    - 실지명의 확인 안 된 무기명식 권면한도 : 50만원
    - 실지명의가 확인된 은행계좌와 연결하여 발행한 기명식 권면한도 : 최대 200만원
    - 본인확인이 안된(CI가 없는) 무기명 선불전자지급수단은 제외 (예: 선불 교통카드 등)
    --is_charge 자동충전 등록 여부 Y Boolean 권면에 등록된 자동충전 정보 유무
    (회신값이 "true"인 경우, 선불전자지급수단 자동충전정보 조회 API(전금-003) 호출 가능)
    --currency_code 톻화코드 N A(3) 외화 선불카드인 경우 해당 권면의 통화코드(ISO 4217 준용)
    - 외화 선불카드가 아닌 경우 미회신
    - 통화코드를 회신한 경우, 해당 권면의 금액 관련 항목들(전금-002 ~ 전금-004 API 내 총잔액, 충전포인트 잔액, 거래금액 등)은 통화코드에 해당하는 금액을 의미
    --account_cnt 계정수 N N(3) 계정이 존재하지 않는 기관의 경우 회신 안팜
    --account_list 계정목록 N Object
    ----account_id 계정식별값 N AH(60) 권면에 하나 또는 다수의 계정이 연결되어 있을 경우, 각 계정을 구별할 수 있는 Key(ex. 계정ID)
    - 네이버, 카카오 등 일부기관의 경우, 동일 개인식별값 내에 다수의 계정을 보유할 수 있으며, 계정별로 정보들이 축적되고 있기 때문에 계정을 식별할 수 있는 Key 회신 필요
    - 동일한 계정ID를 복수 개 사용하는 기관(예: 이베이코리아의 경우, 고객이 옥션, 지마켓 계정ID를 동일하게 사용하는 경우 존재)의 경우 계정ID_사이트명 등과 같이 고객이 식별가능한 값 회신

  • 선불전자지급수단 잔액정보 조회 v2 2022-10-19

    기본 정보
    API ID 전금-002 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/efin/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로부터 배포
    fob_id 권면 ID Y aNS(64) 데이터 보유자가 부여한 권면의 고유 식별자
    account_id 계정식별값 N AH(60) 권면 하나에 다수의 계정이 연결되어 있는 기관 (예: 네이버파이낸셜)의 경우 설정 (전금-001 API 회신된 account_id)
    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을 회신 또는 미회신
    total_balance_amt 총잔액 Y F(18,3) 선불전자지급수단 총 잔액 (복수의 계정이 연결되어 있고, 계정 별 잔액이 구별되는 경우 권면의 총 잔액 중 해당 계정에 할당된 잔액 값)
    charge_balance_amt 충전포인트 잔액 N F(18,3) 연결된 은행계좌를 통하여 충전한 금액 중 잔액
    - 해당 기관만 회신
    - 전자금융업자 공통정보가 아님(유상충전, 무상적립 구별 안 되는 회사도 있음
    reserve_balance_amt 적립포인트 잔액 N F(18,3) 자사 또는 제휴사를 통하여 적립된 금액 중 잔액
    - 해당 기관만 회신
    - 전자금융업자 공통정보가 아님(유상충전, 무상적립 구별 안 되는 회사도 있음
    withdrawable_amt 출근 가능액 N F(18,3) 총잔액 중 출금할 수 있는 금액
    - 전금-001의 출금가능여부가 true인 경우 전송, false인 경우 미전송
    reserve_due_amt 적립예정 N F(18,3) 향후 일정기간내 적립 예정인 금액
    - 해당 기관만 회신
    - 일부 전자금융업자만 제공하는 정로 공통정보가 아님
    exp_due_amt 소멸예정 N F(18,3) M+2개월내 소멸 예정인 금액
    - 카드포인트와 동일하게 소멸
    - M+2월 내 소멸될 총 포인트 표시

  • 선불전자지급수단 잔액정보 조회 v1 2022-10-19

    기본 정보
    API ID 전금-002 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/efin/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로부터 배포
    fob_id 권면 ID Y aNS(64) 데이터 보유자가 부여한 권면의 고유 식별자
    account_id 계정식별값 N AH(60) 권면 하나에 다수의 계정이 연결되어 있는 기관 (예: 네이버파이낸셜)의 경우 설정 (전금-001 API 회신된 account_id)
    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을 회신 또는 미회신
    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 소멸예정 N F(18,3) M+2개월내 소멸 예정인 금액
    - 카드포인트와 동일하게 소멸
    - M+2월 내 소멸될 총 포인트 표시

  • 선불전자지급수단 자동충전정보 조회 v2 2022-10-19

    기본 정보
    API ID 전금-003 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/efin/prepaid/charge
    설명 정보주체가 가입한 선불전자지급수단의 자동충전정보 조회
    - 하나의 권면에 복수개의 자동충전정보가 있는 경우가 존재하여 List로 회신
    기준시점 현재 시점
    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로부터 배포
    fob_id 권면 ID Y aNS(64) 데이터 보유자가 부여한 권면의 고유 식별자
    account_id 계정식별값 N AH(60) 권면 하나에 다수의 계정이 연결되어 있는 기관 (예: 네이버파이낸셜)의 경우 설정 (전금-001 API 회신된 account_id)
    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을 회신 또는 미회신
    charge_cnt 해당권면 충전정보 수 N N(3)
    charge_list 충전정보목록 N Object
    --charge_org_code 충전지불수단기관 (코드) N aN(8) 자동충전을 위해 등록된 결제(충전)수단을 발행한 금융기관의 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    --charge_account_num 충전지불수단식별키 N AH(60) 자동충전을 위해 등록된 결제(충전)수단을 식별하기 위한 값- 1. 카드: 카드번호(마스킹 포함)
    - 2. 은행: 계좌번호
    - 3. 선불(머니): 선불지급수단명
    - 4. 무통장: "무통장"
    - 5. 기타: "기타"
    - 해당 충전지불수단이 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신
    --charge_option 충전조건 (코드) Y aN(2) 선불전자지급수단의 잔액을 특정 기준에 따라 자동충전하기 위한 조건
    - <코드값>
    01: 월정액 자동충전 (충전 기준날짜, 충전금액 핑요)
    02: 기준하한 자동충전 (충전 기준금액, 충전금액 필요)
    99: 기타
    --charge_day 기준날짜 N aN(2) 충전 기준날짜 (날짜 'DD' 2자리)
    - charge_option이 01일 경우
    --charge_base_amt 기준금액 N F(18,3) 하한 기준금액
    - charge_option이 02일 경우
    --charge_amt 충전금액 N F(18,3) 충전될 금액
    - charge_option이 01 또는 02일 경우

  • 선불전자지급수단 자동충전정보 조회 v1 2022-10-19

    기본 정보
    API ID 전금-003 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/efin/prepaid/charge
    설명 정보주체가 가입한 선불전자지급수단의 자동충전정보 조회
    - 하나의 권면에 복수개의 자동충전정보가 있는 경우가 존재하여 List로 회신
    기준시점 현재 시점
    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로부터 배포
    fob_id 권면 ID Y aNS(64) 데이터 보유자가 부여한 권면의 고유 식별자
    account_id 계정식별값 N AH(60) 권면 하나에 다수의 계정이 연결되어 있는 기관 (예: 네이버파이낸셜)의 경우 설정 (전금-001 API 회신된 account_id)
    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을 회신 또는 미회신
    charge_cnt 해당권면 충전정보 수 N N(3)
    charge_list 충전정보목록 N Object
    --charge_org_code 충전지불수단기관 (코드) N aN(8) 자동충전을 위해 등록된 결제(충전)수단을 발행한 금융기관의 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    --charge_account_num 충전지불수단식별키 N AH(60) 자동충전을 위해 등록된 결제(충전)수단을 식별하기 위한 값- 1. 카드: 카드번호(마스킹 포함)
    - 2. 은행: 계좌번호
    - 3. 선불(머니): 선불지급수단명
    - 4. 무통장: "무통장"
    - 5. 기타: "기타"
    - 해당 충전지불수단이 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신
    --charge_option 충전조건 (코드) Y aN(2) 선불전자지급수단의 잔액을 특정 기준에 따라 자동충전하기 위한 조건
    - <코드값>
    01: 월정액 자동충전 (충전 기준날짜, 충전금액 핑요)
    02: 기준하한 자동충전 (충전 기준금액, 충전금액 필요)
    99: 기타
    --charge_day 기준날짜 N aN(2) 충전 기준날짜 (날짜 'DD' 2자리)
    - charge_option이 01일 경우
    --charge_base_amt 기준금액 N F(18,3) 하한 기준금액
    - charge_option이 02일 경우
    --charge_amt 충전금액 N F(18,3) 충전될 금액
    - charge_option이 01 또는 02일 경우

  • 선불 거래내역 조회 v2 2022-10-19

    기본 정보
    API ID 전금-004 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/efin/prepaid/transactions
    설명 조회 기간 동안 발생한 정보주체의 선불 거래내역 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - 선불전자지급수단업을 영위하는 기관(선불업자) 중 결제시스템이 없으나 결제정보를 가지고 있는 경우 전금-004를 통해 결제정보 전송
    - 거래유형(코드): 결제(5501), 결제취소(5502)
    - 선불전자지급수단업과 전자지급결제대행업을 영위하는 기관(겸업사)의 경우, 선불수단이 포함된 복합결제의 정보(예: 선불+카드 결제)를 전금-004와 전금-103 양 쪽으로 전송
    - 전금-004 거래유형(코드): 결제(5501), 결제취소(5502)
    - 전금-103 결제유형(코드): 결제(01), 결제취소(02)
    - '주문번호'항목으로 같은 결제거래를 판별
    기준시점 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로부터 배포
    fob_id 권면 ID Y aNS(64) 데이터 보유자가 부여한 권면의 고유 식별자
    account_id 계정식별값 N AH(60) 권면 하나에 다수의 계정이 연결되어 있는 기관 (예: 네이버파이낸셜)의 경우 설정 (전금-001 API 회신된 account_id)
    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_type 거래유형 (코드) Y aN(4) 해당 거래의 구분 코드
    - [첨부9] 선불지급수단정보업 거래 유형 코드
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 해당 거래가 이루어진 일시(YYYYMMDDhhmmss)
    - 시각 정보가 없을 경우 거래일자인 YYYYMMDD 회신(일부 기관의 경우 거래일자+거래번호로 관리
    --trans_no 거래번호 N aNS(64) 해당 일자의 거래 특정 번호
    - 거래일시 또는 거래일자를 일자(YYYYMMDD)로 제공하는 경우 거래번호 필수적으로 전송
    --trans_amt 거래금액 Y F(18,3) 해당 거래의 금액
    --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(명) 등
    - 카드번호일 경우는 카드업권 마스킹 규칙 준용
    - 해당 거래상대 식별값이 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신
    --trans_num 주문번호 Y aNS(128) 아래 조건에 부합하는 경우 결제건의 주문번호 전송
    - <조건>
    1) 정보제공자가 겸업사(선불업,결제업)며,
    2) 거래유형(코드)가 결제(5501) 또는 결제 취소(5502)며,
    3) 자사선불 활용 복합결제(예: 카드+선불 등)인 경우
    - 전금-103의 주문번호와 같은 값 전송
    --trans_memo 거래메모 N AH(30) 해당 거래의 부가 정보
    - 예 : 상품권명, 포인트명, 기타, 송금인/수취인명, 적립서비스명 등
    - 정보주체가 전송요구 시 거래메모 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_memo='true') 회신하고, 그렇지 않은 경우 미회신
    --merchant_name 가맹점명 N AH(75) 결제 또는 결제취소 가맹점명
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno='true') 회신하고, 그렇지 않은 경우 미회신
    --merchant_regno 가맹점사업자등록번호 N NS(12) 결제 또는 결제취소시, 가맹점의 사업자등록번호
    - “-” 포함
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    --trans_title 상품(구매)제목 N AH(300) 원장에 자장된 구매 내용의 제목 타이틀
    --trans_category 상품(구매)분류 (코드) N aN(2) 해당 결제를 통해 구매한 상품 또는 서비스의 구분
    - [첨부10] 상품(구매) 분류 코드 참조
    - 상품을 복수 개 구매하는 경우, 대표상품의 카테고리만 분류하여 회신
    - 정보주체가 전송요구 시 상품구매정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_category='true') 회신하고, 그렇지 않은 경우 미회신
    --pay_method 결제방법(코드) N aN(2) 온라인 결제, 오프라인 결제 구분
    <코드값>
    01 : 온라인 결제
    02 : 오프라인 결제
    --is_scheduled 정기결제여부 Y Boolean 정기(자동)결제로 이뤄진 거래 여부
    - 정기(자동)결제 서비스를 제공하지 않는 기관은 "false" 회신
    충전 중 자동충전에 해당하는 경우 true 전송

  • 선불 거래내역 조회 v1 2022-10-19

    기본 정보
    API ID 전금-004 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/efin/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로부터 배포
    fob_id 권면 ID Y aNS(64) 데이터 보유자가 부여한 권면의 고유 식별자
    account_id 계정식별값 N AH(60) 권면 하나에 다수의 계정이 연결되어 있는 기관 (예: 네이버파이낸셜)의 경우 설정 (전금-001 API 회신된 account_id)
    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_type 거래유형 (코드) Y aN(4) 해당 거래의 구분 코드
    - [첨부9] 전자금융업 거래유형 코드 중 선불지급수단정보에 해당
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 해당 거래가 이루어진 일시(YYYYMMDDhhmmss)
    - 시각 정보가 없을 경우 거래일자인 YYYYMMDD 회신(일부 기관의 경우 거래일자+거래번호로 관리
    --trans_no 거래번호 N aNS(64) 해당 일자의 거래 특정 번호
    (없을 경우 미회신)
    --trans_amt 거래금액 Y F(18,3) 해당 거래의 금액
    --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(명) 등
    - 카드번호일 경우는 카드업권 마스킹 규칙 준용
    - 해당 거래상대 식별값이 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신
    --trans_memo 거래메모 N AH(30) 해당 거래의 부가 정보
    - 예 : 상품권명, 포인트명, 기타, 송금인/수취인명, 적립서비스명 등
    - 정보주체가 전송요구 시 거래메모 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_memo='true') 회신하고, 그렇지 않은 경우 미회신
    --merchant_name 가맹점명 N AH(75) 결제 또는 결제취소 가맹점명
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno='true') 회신하고, 그렇지 않은 경우 미회신
    --trans_title 상품(구매)제목 N AH(300) 원장에 자장된 구매 내용의 제목 타이틀
    --trans_category 상품(구매)분류 (코드) N aN(2) 해당 결제를 통해 구매한 상품 또는 서비스의 구분
    - [첨부10] 상품(구매) 분류 코드 참조
    - 거래내역의 카테고리가 복수 개인 경우(상품을 복수 개 구매 등), 대표상품의 카테고리만 회신
    - 정보주체가 전송요구 시 상품구매정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_category='true') 회신하고, 그렇지 않은 경우 미회신
    --pay_method 결제방법(코드) N aN(2) 온라인 결제, 오프라인 결제 구분
    <코드값>
    01 : 온라인 결제
    02 : 오프라인 결제

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

    기본 정보
    API ID 전금-101 HTTP Method GET
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/efin/paid
    설명 정보주체가 가입한 계정 목록 조회
    - Pagination, 가입일 기준 오름차순
    - 계정상태가 ‘활동’인 계정만 전송요구 대상
    - 전송요구 단위는 계정이며, 따라서 고객이 전송요구 시 선택한 계정에 등록된 결제수단, 해당 계정에서 발생된 결제내역 등이 전송대상이 됨
    - 일부 기관(네이버, 카카오 등)의 경우 한 고객이 복수 개의 계정을 보유할 수 있어 List로 회신
    - 계정이 존재하지 않는 기관(토스 등)의 경우 규격에 명시된 정보들을 회신
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    account_cnt 계정수 Y N(3)
    account_list 계정목록 Y Object
    --sub_key Sub key Y aNS(64) 데이터 호출 Key의 용도로 정보제공자가 설정한 ID (계정ID Data 호출용)
    --account_id 계정식별값 Y AH(60) 고객이 서비스를 가입하기위해 설정한 ID로, 고객이 식별/인지가 가능한 값. 단, 마스킹 처리로 인하여 고객이 ID별 구분 불가한 것은 용인(계정ID 노출용)
    - 동록된 계정ID가 없을 경우, 고객의 이름, 전화번호 등 고객이 인지가능한 수준의 정보를 전송(마스킹 가능, 마스킹 정책은 각 정보제공자의 정책에 따름)
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계정)에 대해 개인신용정보 전송요구를 했는지 여부
    --reg_date 가입일 Y DATE 전송요구권이 적용되는 고객 계정 정보의 최초 생성일(ex. 회원가입일, CI 최초 수집일 등)
    - CI 또는 주민등록번호 등 개일 식별키 수집이전의 금융정보는 전송요구대상에서 제외되어, 개인식별키 수집일자가 회원가입일보다 이후일 경우, 개인식별키 수집일자 전송
    --is_pay 결제수단 등록 여부 Y Boolean 결제의 편의성을 위하여, 고객이 정보제공자의 서비스에 직접 등록해 놓은 결제수단의 존재 여부
    (회신값이 "true"인 경우, 해당 계정의 결제 수단 등록 정보 조회 API(전금-102) 호출 가능)

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

    기본 정보
    API ID 전금-101 HTTP Method GET
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/efin/paid
    설명 정보주체가 가입한 계정 목록 조회
    - Pagination, 가입일 기준 오름차순
    - 계정상태가 ‘활동’인 계정만 전송요구 대상
    - 전송요구 단위는 계정이며, 따라서 고객이 전송요구 시 선택한 계정에 등록된 결제수단, 해당 계정에서 발생된 결제내역 등이 전송대상이 됨
    - 일부 기관(네이버, 카카오 등)의 경우 한 고객이 복수 개의 계정을 보유할 수 있어 List로 회신
    - 계정이 존재하지 않는 기관(토스 등)의 경우 규격에 명시된 정보들을 회신
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    account_cnt 계정수 Y N(3)
    account_list 계정목록 Y Object
    --sub_key Sub key Y aNS(64) 데이터 호출 Key의 용도로 정보제공자가 설정한 ID (계정ID Data 호출용)
    --account_id 계정식별값 Y AH(60) 고객이 서비스를 가입하기위해 설정한 ID로, 고객이 식별/인지가 가능한 값. 단, 마스킹 처리로 인하여 고객이 ID별 구분 불가한 것은 용인(계정ID 노출용)
    - 동록된 계정ID가 없을 경우, 고객의 이름, 전화번호 등 고객이 인지가능한 수준의 정보를 전송(마스킹 가능, 마스킹 정책은 각 정보제공자의 정책에 따름)
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계정)에 대해 개인신용정보 전송요구를 했는지 여부
    --reg_date 가입일 Y DATE 전송요구권이 적용되는 고객 계정 정보의 최초 생성일(ex. 회원가입일, CI 최초 수집일 등)
    - CI 또는 주민등록번호 등 개일 식별키 수집이전의 금융정보는 전송요구대상에서 제외되어, 개인식별키 수집일자가 회원가입일보다 이후일 경우, 개인식별키 수집일자 전송
    --is_pay 결제수단 등록 여부 Y Boolean 결제의 편의성을 위하여, 고객이 정보제공자의 서비스에 직접 등록해 놓은 결제수단의 존재 여부
    (회신값이 "true"인 경우, 해당 계정의 결제 수단 등록 정보 조회 API(전금-102) 호출 가능)

  • 결제수단 등록 정보 조회 v2 2022-10-19

    기본 정보
    API ID 전금-102 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/efin/paid/methods
    설명 정보주체가 등록한 결제수단 등록 정보 조회(계정별 조회)
    기준시점 현재 시점
    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로부터 배포
    sub_key Sub key Y aNS(64) 데이터 호출 Key의 용도로 정보제공자가 설정한 ID (계정ID Data 호출용)
    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을 회신 또는 미회신
    pay_cnt 결제수단수 Y N(3) 고객이 등록 한 결제수단 수
    pay_list 결제수단목록 Y Object 계정별 복수개의 결제수단 존재 가능하여 List 회신
    --pay_org_code 결제수단 기관 (코드) N aN(8) 고객이 등록한 결제수단을 발행(제공)하는 기관의 코드 (예: 연결된 계좌를 발행한 은행의 기관코드 등)
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    --pay_type 결제수단식별코드 N aN(2) 결제에 사용된 결제수단의 식별 코드
    - <코드값>
    01: 카드
    02: 계좌
    03: 선불
    04: 무통장
    06: 휴대폰
    09: 기타수단
    --pay_id 결제수단 식별키 Y AH(60) 결제수단 식별코드 별 결제수단 정보
    - 결제수단 식별코드(pay_type) 값에 따라 결제수단 정보 회신
    예) 결제수단식별코드가 '01'인 경우 카드번호(마스킹 포함) 회신

    결제수단식별코드 '01': 카드번호(마스킹포함)
    결제수단식별코드 '02': 계좌번호
    결제수단식별코드 '03': 선불지급수단명
    결제수단식별코드 '04': "무통장" 전송
    결제수단식별코드 '06': "휴대폰" 전송
    결제수단식별코드 '09': 상세 기타수단명(예: 상품권명)
    - 카드번호 전송시, "-" 제외 후 123456*****1234(AMEX카드 외) 또는 123456*****1234(AMEX카드)로 (추가)마스킹하여 전송
    - 결제기관(카드사, 은행)과 일회성토큰 등으로 결제를 진행하거나 정보를 적재하지 않는 경우(예: 티머니, 우아한형제들): "불가" 전송
    - 계좌번호 전송시, "-" 제외 후 추가적으로 마스킹처리 하지 않고 전송
    --is_primary Primary 여부 N Boolean 해당 결제 수단의 primary 지정 여부
    - 정보제공자의 서비스 상에 고객이 주 결제수단을 특정하는 기능이 있을 경우에만 전송

  • 결제수단 등록 정보 조회 v1 2022-10-19

    기본 정보
    API ID 전금-102 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/efin/paid/methods
    설명 정보주체가 등록한 결제수단 등록 정보 조회(계정별 조회)
    기준시점 현재 시점
    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로부터 배포
    sub_key Sub key Y aNS(64) 데이터 호출 Key의 용도로 정보제공자가 설정한 ID (계정ID Data 호출용)
    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을 회신 또는 미회신
    pay_cnt 결제수단수 Y N(3) 고객이 등록 한 결제수단 수
    pay_list 결제수단목록 Y Object 계정별 복수개의 결제수단 존재 가능하여 List 회신
    --pay_org_code 결제수단 기관 (코드) N aN(8) 고객이 등록한 결제수단을 발행(제공)하는 기관의 코드 (예: 연결된 계좌를 발행한 은행의 기관코드 등)
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    --pay_id 결제수단 식별키 N AH(60) 해당 결제 수단을 식별할 수 있는 값(계좌번호, 카드번호(마스킹) 등)
    - 해당 결제수단이 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신
    --is_primary Primary 여부 N Boolean 해당 결제 수단의 primary 지정 여부
    - 정보제공자의 서비스 상에 고객이 주 결제수단을 특정하는 기능이 있을 경우에만 전송

  • 결제내역 조회 v2 2022-10-19

    기본 정보
    API ID 전금-103 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/efin/paid/transactions
    설명 조회 기간 동안 발생한 정보주체의 결제내역 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - 선불전자지급수단업을 영위하는 기관(선불업자) 중 결제시스템이 없으나 결제정보를 가지고 있는 경우 전금-004를 통해 결제정보 전송
    - 거래유형(코드): 결제(5501), 결제취소(5502)
    - 선불전자지급수단업과 전자지급결제대행업을 영위하는 기관(겸업사)의 경우, 선불수단이 포함된 복합결제의 정보(예: 선불+카드 결제)를 양쪽 API로(선불, 결제) 선불결제 정보 전송
    - 전금-004 거래유형(코드): 결제(5501), 결제취소(5502)
    - 전금-103 결제유형(코드): 결제(01), 결제취소(02)
    - '주문번호'항목으로 같은 결제거래를 판별
    기준시점 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로부터 배포
    sub_key Sub key Y aNS(64) 데이터 호출 Key의 용도로 정보제공자가 설정한 ID (계정ID Data 호출용)
    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_type 결제유형 (코드) Y aN(2) 해당 결제의 구분 코드
    - <코드값>
    01 : 결제
    02 : 결제취소
    03 : 부분취소
    --trans_num 주문번호 Y aNS(128) 해당 결제내역의 주문번호
    - 아래 조건에 부합하는 경우 동일 주문번호를 전금-004로 전송
    <조건>
    1) 정보제공자가 겸업사(선불업, 결제업)
    2) 자사선불 활용 복합결제(예:카드+선불)인 경우
    --trans_dtime 결제일시 또는 결제취소일시 Y DTIME 또는 DATE 결제 또는 결제취소(환불 포함) 일시(YYYYMMDDhhmmss)
    - 시각 정보가 없을 경우 결제일자(또는 결제취소일자)인 YYYYMMDD 회신 (일부 기관의 경우 결제일자+결제번호로 관리
    --trans_no 결제번호 N aNS(64) 해당 일자의 결제 특정 번호
    - 결제일시 또는 결제취소일시를 일지(YYYYMMDD)로 제공하는 경우 결제번호 전송
    --currency_code 통화코드 N A(3) 결제금액에 대한 통화코드 (ISO 4217 준용)- 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --trans_amt 결제금액 Y F(18,3) 결제 또는 결제취소 총 금액- 결제수단별 결제금액의 총 합은 고객이 해당 거래에 실제로 지출한 총 금액과 같아야 함(배송비 포함)
    --trans_org_code 결제수단 기관 (코드) N aN(8) 거래 대상 금융기관의 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    --pay_type 결제수단
    식별코드    		 Y aN(2) 결제에 사용된 결제수단의 식별 코드
    - <코드값>
    01: 카드
    02: 계좌
    03: 선불
    04: 무통장
    05: 타기관 간편결제
    06: 휴대폰
    09: 기타수단
    --pay_id 결제수단 식별키 Y AH(60) 결제수단 식별코드 별 결제수단 정보
    - 결제수단 식별코드(pay_type) 값에 따라 결제수단 정보 회신
    예) 결제수단식별코드가 '01'인 경우 카드번호(마스킹 포함) 회신

    결제수단식별코드 '01': 카드번호(마스킹 포함)
    결제수단식별코드 '02': 계좌번호
    결제수단식별코드 '03': 선불지급수단명
    결제수단식별코드 '04': '무통장' 전송
    결제수단식별코드 '05': 타기관 갈편결제명(예:ㅇㅇ페이)
    결제수단식별코드 '06': '휴대폰' 전송
    결제수단식별코드 '09': 상세 기타수단명(예: 상품권명, 포인트명)
    - 카드번호 전송시, '-' 제외 후 123456******1234(AMEX카드 외) 또는 123456******1234(AMEX카드(추가)마스킹하여 전송
    - 결제기관(카드사,은행)과 일회성토큰 등으로 결제를 진행하거나 정보를 적재하지 않는 경우(예: 티머니, 우아한형제들): '불가' 전송
    - 계좌번호 전송시, '-' 제외 후 추가적으로 마스킹처리 하지 않고 전송
    --approved_num 카드승인번호 N aN(21) 카드사 또는 타 결제기관에서 수취한 승인번호
    - 결제수단식별코드(pay_type)가 '01'인 경우 전송
    - 카드승인번호를 전달받지 않거나(예: 구글, 우아한형제들, 롯데e커머스), 카드승인번호가 있으나 고객CI가 없는 기관의 경우(예:웰컴페이먼츠): '00000000' 전송
    --card_name 카드명 N AH(300) 카드사 또는 타 결제기관에서 수취한 카드상품명
    - 결제수단식별코드(pay_type)가 '01'인 경우 전송
    - 카드번호가 마스킹됨에 따라 카드명을 전송하여 수신자의 이해를 도움
    --total_install_cnt 할부개월 N N(5) 할부개월수
    - 일시불 또는 카드 외 결제 수단인 경우 회신 안 함
    --trans_memo 거래메모 N AH(30) 해당 거래의 부가 정보
    - 예 : 송금인/수취인명, 적립서비스명 등
    - 정보주체가 전송요구 시 거래메모 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_memo='true') 회신하고, 그렇지 않은 경우 미회신
    --merchant_name 가맹점명 N AH(75) 결제 또는 결제취소 가맹점명
    - 가명점과의 관계에 따라 대표가명점인 PG명만 나올 수 있음
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno='true') 회신하고, 그렇지 않은 경우 미회신
    --merchant_regno 가맹점 사업자등록번호 N NS(12) 가맹점의 사업자등록번호
    - “-” 포함
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    --trans_title 상품(구매)제목 N AH(300) 원장에 저장된 구매 내용의 제목 타이틀
    --trans_category 상품(구매)분류 (코드) N aN(2) 해당 결제를 통해 구매한 상품 또는 서비스의 구분
    - [첨부10] 상품(구매) 분류 코드 참조
    - 상품을 복수개 구매하는 경우, 대표상품의 카테고리로 분류하여 회신
    - 정보주체가 전송요구 시 상품구매정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_category='true') 회신하고, 그렇지 않은 경우 미회신
    --pay_method 결제방법(코드) Y aN(2) 온라인 결제, 오프라인 결제 구분
    <코드값>
    01 : 온라인 결제
    02 : 오프라인 결제

  • 결제내역 조회 v1 2022-10-19

    기본 정보
    API ID 전금-103 HTTP Method POST
    API 제공자 전금업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/efin/paid/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로부터 배포
    sub_key Sub key Y aNS(64) 데이터 호출 Key의 용도로 정보제공자가 설정한 ID (계정ID Data 호출용)
    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_type 결제유형 (코드) Y aN(4) 해당 결제의 구분 코드
    - [첨부9] 전자금융업 거래유형 코드 중 전자결제정보에 해당
    --trans_num 주문번호 Y aNS(128) 해당 결제내역의 주문번호
    --trans_dtime 결제일시 또는 결제취소일시 Y DTIME 또는 DATE 결제 또는 결제취소(환불 포함) 일시(YYYYMMDDhhmmss)
    - 시각 정보가 없을 경우 결제일자(또는 결제취소일자)인 YYYYMMDD 회신 (일부 기관의 경우 결제일자+결제번호로 관리
    --trans_no 결제번호 N aNS(64) 해당 일자의 결제 특정 번호
    (없을 경우 미회신)
    --currency_code 통화코드 N A(3) 결제금액에 대한 통화코드 (ISO 4217 준용)- 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --trans_amt 결제금액 Y F(18,3) 결제 또는 결제취소 총 금액
    --trans_org_code 결제수단 기관 (코드) N aN(8) 거래 대상 금융기관의 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    --pay_id 결제수단 식별키 N AH(60) 결제에 사용된 결제수단의 식별 값
    - <식별값>
    카드: 카드번호(마스킹포함)
    은행: 계좌번호
    선불(머니): 선불지급수단명
    무통장: "무통장"
    기타: "기타"
    - 해당 결제수단이 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신
    --total_install_cnt 할부개월 N N(5) 할부개월수
    - 일시불 또는 카드 외 결제 수단인 경우 회신 안 함
    --trans_memo 거래메모 N AH(30) 해당 거래의 부가 정보
    - 예 : 상품권명, 포인트명, 기타, 송금인/수취인명, 적립서비스명 등
    - 정보주체가 전송요구 시 거래메모 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_memo='true') 회신하고, 그렇지 않은 경우 미회신
    --merchant_name 가맹점명 N AH(75) 결제 또는 결제취소 가맹점명
    - 가명점과의 관계에 따라 대표가명점인 PG명만 나올 수 있음
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno='true') 회신하고, 그렇지 않은 경우 미회신
    --merchant_regno 가맹점 사업자등록번호 N aN(12) 가맹점의 사업자등록번호
    - “-” 포함
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    --trans_title 상품(구매)제목 Y AH(300) 원장에 저장된 구매 내용의 제목 타이틀
    --trans_category 상품(구매)분류 (코드) N aN(2) 해당 결제를 통해 구매한 상품 또는 서비스의 구분
    - [첨부10] 상품(구매) 분류 코드 참조
    - 거래내역의 카테고리가 복수 개인 경우(상품을 복수 개 구매 등), 대표상품의 카테고리만 회신
    - 정보주체가 전송요구 시 상품구매정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_trans_category='true') 회신하고, 그렇지 않은 경우 미회신
    --pay_method 결제방법(코드) Y aN(2) 온라인 결제, 오프라인 결제 구분
    <코드값>
    01 : 온라인 결제
    02 : 오프라인 결제

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

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