금융보안원 로고

회원가입 로그인

API가이드

카드 업권 정보제공 API 규격

  • 선불카드 목록 조회 (은행, 카드 공통) v1 2022-10-19

    기본 정보
    API ID 선불-001 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/prepaid
    설명 정보주체가 가입한 선불카드 목록 조회
    - Pagination, “발급일자 또는 기명일자” 기준 내림차순
    - 본 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까지 설정 가능
    - 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 선불카드의 발급일자 또는 무기명 선불카드의 기명화 일자
    - CI 또는 주민등록번호 등 개인식별키 수집(기명화) 이전의 금융정보는 전송요구대상에서 제외됨에 따라, 발급 이후 기명화가 된 경우에는 기명일자를 전송
    --limit_amt 액면한도 또는 최대충전한도 Y N(5) 선불카드의 액면한도 또는 최대충전한도 (단위:만원)

  • 선불카드 목록 조회 (은행, 카드 공통) v2 2022-10-19

    기본 정보
    API ID 선불-001 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/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 HTTP Method POST
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/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월 내 소멸될 총 포인트 표시

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

    기본 정보
    API ID 선불-002 HTTP Method POST
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/prepaid/balance
    설명 정보주체가 가입한 선불카드의 잔액정보 조회
    - 본 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로부터 배포
    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 HTTP Method POST
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/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(명) 등
    - 카드번호일 경우는 카드업권 마스킹 규칙 준용
    - 해당 거래상대 식별값이 정보주체 본인 소유가 확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신

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

    기본 정보
    API ID 선불-003 HTTP Method POST
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/prepaid/transactions
    설명 조회 기간 동안 발생한 정보주체의 선불카드 거래내역 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - 본 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로부터 배포
    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 HTTP Method POST
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/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) 해당 상환거래 금액 중 이자

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

    기본 정보
    API ID 선불-004 HTTP Method POST
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/prepaid/approval
    설명 정보주체가 보유한 선불카드별 승인내역(결제내역) 조회 (Pagination, 사용일시(승인인 경우 approvoed_dtime, 정정/취소인 경우 trans_dtime) 기준 내림차순)
    - 조회 시작일자/종료일자 기간 내에 승인내역 뿐만 아니라 정정/취소내역도 회신 필요 (즉, from_date <= 승인일자(승인일시의 YYYYMMDD에 해당) <= to_date를 만족하는 승인내역뿐만 아니라, from_date <= 정정/취소일자(“정정 또는 승인취소 일시”의 YYYYMMDD에 해당) <= to_date를 만족하는 정정내역 및 취소내역 회신 필요)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - 본 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로부터 배포
    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(8) 카드 승인 시 각 사에서 발행한 번호
    --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) 해당 상환거래 금액 중 이자

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

    기본 정보
    API ID 정보제공-공통-001 (카드) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자, 종합포털
    API 명 (URI) /card/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_uri API 명 Y aN(50) URI 계층구조 중 에 해당하는 정보 (예: /account, /accounts/deposit/basic 등)
    --api_code API 구분 코드 N AN(4) API 구분 코드

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

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

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

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

  • 카드 목록 조회 v1 2022-10-19

    기본 정보
    API ID 카드-001 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/cards
    설명 정보주체가 보유한 금융회사별 카드 목록(정상인 카드만, 본인카드만(가족카드 제외)) 조회
    - Pagination, 카드구분(코드) 기준 오름차순
    - 카드 식별자(card_id)는 데이터 보유자가 부여한 카드 고유 식별자로, 타 정보제공 API 호출 시 Primary Key로 사용
    - 다만, 카드 재발급 시 카드사에 따라 1)기존 카드 식별자를 그대로 유지(카드번호, 발급일자 등만 변경), 2) 새로운 카드 식별자를 발급하는 경우 존재.
    - 따라서, 마이데이터사업자(정보수신자)는 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 조회 타임스탬프 Y N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    card_cnt 보유카드수 Y N(3)
    card_list 보유카드목록 Y Object
    --card_id 카드 식별자 Y aN(64) 데이터 보유자가 부여한 카드의 고유 식별자
    (카드 기본정보, 국내 승인내역 및 해외 승인내역조회 API 호출 시 URI에 포함)
    --card_num 카드번호 Y NS(19) 개별 카드를 식별하기 위하여 부여된 16~19 자리 번호 (해외카드는 19자리 가능) 단, 카드정보 유출을 방지하기 위해 마스킹 처리 후 일부 번호만 제공("-" 제외)
    - AMEX 카드 외 : 111111******1111
    - AMEX 카드 : 123456******456
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(카드번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --card_name 카드상품명 Y AH(300) 상품명 이름이 긴 경우, 카드사 청구서 내 상품명으로 표기
    --card_member 본인/가족 구분(코드) Y N(1) 카드상품 계약자의 신용을 바탕으로 가족이 사용하는 카드인지 여부
    - 예를 들어 본인 명의로 배우자의 가족카드를 발급받는 경우, 본인이 카드 목록 조회 API(카드-001) 호출 시 해당 카드 정보는 회신되지 않으며, 배우자가 카드 목록 조회 시 회신(card_member를 2로 설정))
    가족카드(예:배우자)는 카드 기본정보 조회(카드-002),국내 승인내역 조회(카드-008)및 해외 승인내역 조회(카드-009)만 가능
    - <코드값>
    1 : 본인
    2 : 가족
    --card_type 카드 구분(코드) Y aN(2) 해당 카드상품의 종류
    - <코드값>
    01 : 신용
    02 : 체크(직불포함)
    03 : 소액신용체크(소액 신용결제 이용한도가 부여된 체크카드)
    - card_type이 '02'(체크(직불포함))인 경우, 카드 기본정보 조회(카드-002), 국내 승인내역 조회(카드-008) 및 해외 승인내역 조회(카드-009)만 가능

  • 카드 목록 조회 v2 2022-10-19

    기본 정보
    API ID 카드-001 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/cards
    설명 정보주체가 보유한 금융회사별 카드 목록(정상인 카드만, 본인카드만(가족카드 제외)) 조회
    - Pagination, 카드구분(코드) 기준 오름차순
    - 카드 식별자(card_id)는 데이터 보유자가 부여한 카드 고유 식별자로, 타 정보제공 API 호출 시 Primary Key로 사용
    - 다만, 카드 재발급 시 카드사에 따라 1)기존 카드 식별자를 그대로 유지(카드번호, 발급일자 등만 변경), 2) 새로운 카드 식별자를 발급하는 경우 존재.
    - 따라서, 마이데이터사업자(정보수신자)는 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 조회 타임스탬프 Y N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    card_cnt 보유카드수 Y N(3)
    card_list 보유카드목록 Y Object
    --card_id 카드 식별자 Y aN(64) 데이터 보유자가 부여한 카드의 고유 식별자
    (카드 기본정보, 국내 승인내역 및 해외 승인내역조회 API 호출 시 URI에 포함)
    --card_num 카드번호 Y NS(19) 개별 카드를 식별하기 위하여 부여된 16~19 자리 번호 (해외카드는 19자리 가능) 단, 카드정보 유출을 방지하기 위해 마스킹 처리 후 일부 번호만 제공("-" 제외)
    - AMEX 카드 외 : 111111******1111
    - AMEX 카드 : 123456******456
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(카드번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --card_name 카드상품명 Y AH(300) 상품명 이름이 긴 경우, 카드사 청구서 내 상품명으로 표기
    --card_member 본인/가족 구분(코드) Y N(1) 카드상품 계약자의 신용을 바탕으로 가족이 사용하는 카드인지 여부
    - 예를 들어 본인 명의로 배우자의 가족카드를 발급받는 경우, 본인이 카드 목록 조회 API(카드-001) 호출 시 해당 카드 정보는 회신되지 않으며, 배우자가 카드 목록 조회 시 회신(card_member를 2로 설정))
    가족카드(예:배우자)는 카드 기본정보 조회(카드-002),국내 승인내역 조회(카드-008)및 해외 승인내역 조회(카드-009)만 가능
    - <코드값>
    1 : 본인
    2 : 가족
    --card_type 카드 구분(코드) Y aN(2) 해당 카드상품의 종류
    - <코드값>
    01 : 신용
    02 : 체크(직불포함)
    03 : 소액신용체크(소액 신용결제 이용한도가 부여된 체크카드)
    - card_type이 '02'(체크(직불포함))인 경우, 카드 기본정보 조회(카드-002), 국내 승인내역 조회(카드-008) 및 해외 승인내역 조회(카드-009)
    국내 일별 카드 매입 이용정보(카드-014), 해외 일별 카드 매입 이용정보(카드-015)만 가능

  • 카드 기본정보 조회 v2 2022-10-19

    기본 정보
    API ID 카드-002 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/cards/{card_id}
    설명 정보주체가 보유한 카드별 기본 정보 조회
    기준시점 현재 시점
    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 유형
    Path card_id 카드식별자 Y
    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_trans_payable 교통 기능(여부) Y Boolean 대중교통의 육성 및 이용촉진에 관한 볍률에 따른 교통카드 기능 여부
    - true / false
    is_cash_card 현금카드기능(여부) Y Boolean ATM 등을 통해 현금을 입출금할 수 있는 카드 기능 여부
    - true / false
    linked_bank_code 결제은행(코드) N aN(8) 해당 카드대금이 결제되는 거래금융기관에 부여된 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    account_num 결제계좌번호 N aN(20) 해당 카드대금이 결제되는 거래금융기관의 계좌번호(해당 계좌번호가 정보 주체 본인의 소유가
    확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신)
    card_brand 카드브랜드(코드) Y aN(3) 결제를 위한 카드사 브랜드 코드
    - 카드브랜드가 카드브랜드가 기타 국내전용카드(D08)에 해당되는 경우, 해외 승인내역 조회(카드-009) 및 해외 카드매입정보 (매입취소정보) 조회(카드-015) 호출 불필요
    annual_fee 상품 연회비 Y N(15) 해당 카드상품을 사용하는데 지불하는 연간 비용
    - 기본연회비와 제휴연회비 합산금액
    issue_date 발급일자 Y DATE 카드 발급 시 해당 카드번호가 생성된 최근일자(최초 카드 발급 시 발급일자나 카드재발급 시 갱신되는 날짜를 의미)

  • 카드 기본정보 조회 v1 2022-10-19

    기본 정보
    API ID 카드-002 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/cards/{card_id}
    설명 정보주체가 보유한 카드별 기본 정보 조회
    기준시점 현재 시점
    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 유형
    Path card_id 카드식별자 Y
    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_trans_payable 교통 기능(여부) Y Boolean 대중교통의 육성 및 이용촉진에 관한 볍률에 따른 교통카드 기능 여부
    - true / false
    is_cash_card 현금카드기능(여부) Y Boolean ATM 등을 통해 현금을 입출금할 수 있는 카드 기능 여부
    - true / false
    linked_bank_code 결제은행(코드) N aN(8) 해당 카드대금이 결제되는 거래금융기관에 부여된 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    account_num 결제계좌번호 N aN(20) 해당 카드대금이 결제되는 거래금융기관의 계좌번호(해당 계좌번호가 정보 주체 본인의 소유가
    확인된 경우에만 회신하며, 확인이 불가하거나 타인의 소유일 경우에는 미회신)
    card_brand 카드브랜드(코드) Y aN(3) 결제를 위한 카드사 브랜드 코드
    - 카드브랜드가 카드브랜드가 기타 국내전용카드(D08)에 해당되는 경우, 해외 승인내역 조회(카드-009) 및 해외 카드매입정보 (매입취소정보) 조회(카드-015) 호출 불필요
    annual_fee 상품 연회비 Y N(15) 해당 카드상품을 사용하는데 지불하는 연간 비용
    - 기본연회비와 제휴연회비 합산금액
    issue_date 발급일자 Y DATE 카드 발급 시 해당 카드번호가 생성된 최근일자(최초 카드 발급 시 발급일자나 카드재발급 시 갱신되는 날짜를 의미)

  • 포인트 정보 조회 v2 2022-10-19

    기본 정보
    API ID 카드-003 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/points
    설명 정보주체가 보유한 포인트 정보 조회 (포인트 정보는 카드단위가 아닌 고객단위로 관리)
    기준시점 현재 시점
    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 조회 타임스탬프 Y N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    point_cnt 포인트수 Y N(2)
    point_list 포인트목록 Y Object
    --point_name 포인트명 Y AH(60) 각 사가 운영 중인 포인트명을 텍스트로 제공
    - 카드사용금액 및 사용처에 따라 적립된 포인트로 카드사가 관리 가능한 대표 포인트 (또는 자사 관리 포인트)
    - “카드사 제공 포인트 종류 및 포인트명” 상세 내용은 서비스가이드라인 참조
    --remain_point_amt 잔여포인트 Y N(12) 기준일자 현재 금융소비자가 사용할 수 있는 잔여 포인트
    - 카드사 별 포인트 적립시점이 상이할 수 있으나, 현재 시점 기준 카드사 별 사용가능한 잔여포인트를 회신
    - 여신협회 제공정보 기준과 동일
    --expiring_point_amt M+2월 소멸예정 포인트 Y N(12) 2개월 후 소멸예정포인트 (정수형)
    - 여신협회 제공정보 기준과 동일

  • 포인트 정보 조회 v1 2022-10-19

    기본 정보
    API ID 카드-003 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/points
    설명 정보주체가 보유한 포인트 정보 조회 (포인트 정보는 카드단위가 아닌 고객단위로 관리)
    기준시점 현재 시점
    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 조회 타임스탬프 Y N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    point_cnt 포인트수 Y N(2)
    point_list 포인트목록 Y Object
    --point_name 포인트명 Y AH(60) 각 사가 운영 중인 포인트명을 텍스트로 제공
    - 카드사용금액 및 사용처에 따라 적립된 포인트로 카드사가 관리 가능한 대표 포인트 (또는 자사 관리 포인트)
    - “카드사 제공 포인트 종류 및 포인트명” 상세 내용은 서비스가이드라인 참조
    --remain_point_amt 잔여포인트 Y N(12) 기준일자 현재 금융소비자가 사용할 수 있는 잔여 포인트
    - 카드사 별 포인트 적립시점이 상이할 수 있으나, 현재 시점 기준 카드사 별 사용가능한 잔여포인트를 회신
    - 여신협회 제공정보 기준과 동일
    --expiring_point_amt M+2월 소멸예정 포인트 Y N(12) 2개월 후 소멸예정포인트 (정수형)
    - 여신협회 제공정보 기준과 동일

  • 청구 기본정보 조회 v2 2022-10-19

    기본 정보
    API ID 카드-004 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/bills
    설명 정보주체가 보유한 청구 기본정보(월별 청구정보) 조회 (Pagination, 결제년월일 기준 내림차순)
    - 카드단위가 아닌, 고객단위로 청구 기본정보 조회
    - 청구금액에 선결제금액 반영기준은 카드사마다 상이하며, 본 API 전송시점에 각사의 기준에 따른 청구금액을 회신 (필요시 마이데이터 앱에 각 사의 기준에 대한 고지 등 반영)
    - 월별 청구금액에는 가족카드 금액도 포함(가족카드의 경우, 청구 기본정보 조회시에만 월별 청구금액에 반영되며, 그 외(승인내역 등)에는 정보주체의 개인신용정보가 아니므로 제외
    - 일부 기관(신한카드 등)의 경우 다원화(고객이 결제일을 여러개 가질 수 있도록 지원하는 개념, 고객:결제순번(결제일과 비슷한 개념):카드 = 1:m:n) 개념 존재. 따라서, 고객단위라고 하더라도 m개의 결제일 발생(m개의 결제일 : n개의 카드) 가능하기 때문에 회차정보(seqno)를 회신하는 경우 발생
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    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로부터 배포
    from_month 시작년월 Y N(6) 조회 시작월 (YYYYMM)
    to_month 종료년월 Y N(6) 조회 종료월 (YYYYMM)
    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] 페이지네이션 참조
    bill_cnt 청구목록수 Y N(3)
    bill_list 청구목록 Y Object
    --seqno 결제순번 N aN(30) 청구내역이 복수 개일 경우 각 청구내역을 식별하기 위한 순번
    - 결제순번(신한카드 등)으로 복수 개의 청구내역을 관리하는 기관의 경우 회신
    --charge_amt 월별 청구금액 Y N(15) 회원에게 청구한 월별 이용대금
    --charge_day 결제일 Y aN(2) 결제일 2자리
    --charge_month 청구년월 Y N(6) 청구서 기준월(YYYYMM)
    --paid_out_date 결제년월일 Y DATE 실제 결제일
    - 참고 : 결제일(charge_day)이 25일이라 하더라도, 결제일이 주말 등일 경우 실제 결제년월일(paid_out_date)은 결제일(charge_day)과 상이할 수 있음

  • 청구 기본정보 조회 v1 2022-10-19

    기본 정보
    API ID 카드-004 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/bills
    설명 정보주체가 보유한 청구 기본정보(월별 청구정보) 조회 (Pagination, 결제년월일 기준 내림차순)
    - 카드단위가 아닌, 고객단위로 청구 기본정보 조회
    - 청구금액에 선결제금액 반영기준은 카드사마다 상이하며, 본 API 전송시점에 각사의 기준에 따른 청구금액을 회신 (필요시 마이데이터 앱에 각 사의 기준에 대한 고지 등 반영)
    - 월별 청구금액에는 가족카드 금액도 포함(가족카드의 경우, 청구 기본정보 조회시에만 월별 청구금액에 반영되며, 그 외(승인내역 등)에는 정보주체의 개인신용정보가 아니므로 제외
    - 일부 기관(신한카드 등)의 경우 다원화(고객이 결제일을 여러개 가질 수 있도록 지원하는 개념, 고객:결제순번(결제일과 비슷한 개념):카드 = 1:m:n) 개념 존재. 따라서, 고객단위라고 하더라도 m개의 결제일 발생(m개의 결제일 : n개의 카드) 가능하기 때문에 회차정보(seqno)를 회신하는 경우 발생
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    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로부터 배포
    from_month 시작년월 Y N(6) 조회 시작월 (YYYYMM)
    to_month 종료년월 Y N(6) 조회 종료월 (YYYYMM)
    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] 페이지네이션 참조
    bill_cnt 청구목록수 Y N(3)
    bill_list 청구목록 Y Object
    --seqno 결제순번 N aN(6) 청구내역이 복수 개일 경우 각 청구내역을 식별하기 위한 순번
    - 결제순번(신한카드 등)으로 복수 개의 청구내역을 관리하는 기관의 경우 회신
    --charge_amt 월별 청구금액 Y N(15) 회원에게 청구한 월별 이용대금
    --charge_day 결제일 Y aN(2) 결제일 2자리
    --charge_month 청구년월 Y N(6) 청구서 기준월(YYYYMM)
    --paid_out_date 결제년월일 Y DATE 실제 결제일
    - 참고 : 결제일(charge_day)이 25일이라 하더라도, 결제일이 주말 등일 경우 실제 결제년월일(paid_out_date)은 결제일(charge_day)과 상이할 수 있음

  • 청구 추가정보 조회 v2 2022-10-19

    기본 정보
    API ID 카드-005 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/bills/detail
    설명 정보주체가 보유한 카드별/월별 청구 상세정보(청구 항목별 정보) 조회 (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로부터 배포
    seqno 결제순번 N aN(30) 결제순번(신한카드 등)으로 복수개의 청구내역을 관리하는 기관의 경우, 결제순번 명시
    charge_month 청구년월 Y N(6) 조회하고자 하는 청구년월
    - YYYYMM
    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] 페이지네이션 참조
    bill_detail_cnt 청구상세목록수 Y N(3)
    bill_detail_list 청구상세목록 Y Object
    --card_id 카드 식별자 Y aN(64) 청구서 내 복수개의 카드를 구분하기 위해 카드 식별자 회신
    --paid_dtime 사용일시 또는 사용일자 Y DTIME 또는 DATE 금융소비자가 물품을 구매하거나 용역을 제공받은 날짜와 시간 (YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 사용일자인 YYYYMMDD 회신 (사용일자 + 거래본호로 구분)
    --trans_no 거래번호 N aN(64) 해당 일자의 거래 특정 번호(없을 경우 미회신)
    - paid_dtime이 사용일자일 경우, 개별거래를 구분하기 위하여 해당 기관이 설정하는 거래번호
    --paid_amt 이용금액 Y F(18,3) 건별 이용 금액
    매입취소 금액이 청구금액보다 큰 경우 음수 표기 가능
    --currency_code 통화코드 (이용금액) N A(3) 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --merchant_name 가맹점명 N AH(75) 금융소비자가 물품을 구매하거나 용역을 제공받은 곳의 명칭
    - 정보주체가 전송요구 시 가맹점명 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    - 정보주체 거주지 정보를 회신할 경우 거주지 정보가 구체적으로 특정되지 않도록 일부 정보 마스킹 또는 삭제 등 비식별 조치하여 회신
    --merchant_regno 가맹점 사업자등록번호 N aN(12) 가맹점의 사업자등록번호
    - “-” 포함
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    - 해외 승인 등의 사유로 가맹점 정보 누락된 경우 미회신
    --credit_fee_amt 신용판매 수수료 Y N(15) 일시불/할부거래, 해외 이용수수료 및 연체수수료 등 일시불 거래로 인해 발생한 각종 수수료
    --total_install_cnt 전체 할부회차 N N(5) 나누어 상환하기로 계약한 원리금의 전체 회차
    - 일시불일 경우 미회신
    --cur_install_cnt 현재 할부회차 N N(5) 나누어 상환하기로 계약한 원리금의 현재 회차
    - 일시불일 경우 미회신
    --balance_amt 할부 결제 후 잔액 N N(15) 기준일 현재 나누어 상환하기로 계약한 원금의 잔액
    - 일시불일 경우 미회신
    --prod_type 상품구분(코드) Y aN(2) 상품구분 (일시불, 신판할부, 현금서비스)
    - <코드값>
    01 : 일시불
    02 : 신판할부
    03 : 현금서비스
    04 : 리볼링
    05 : 장기대출(카드론, 신용대출)
    06 : 연회비
    99 : 기타
    - 카드론의 경우 카드사 정책에 따라 결제에 정금액에 포함되는 경우 기재

  • 청구 추가정보 조회 v1 2022-10-19

    기본 정보
    API ID 카드-005 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/bills/detail
    설명 정보주체가 보유한 카드별/월별 청구 상세정보(청구 항목별 정보) 조회 (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로부터 배포
    seqno 결제순번 N aN(6) 결제순번(신한카드 등)으로 복수개의 청구내역을 관리하는 기관의 경우, 결제순번 명시
    charge_month 청구년월 Y N(6) 조회하고자 하는 청구년월
    - YYYYMM
    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] 페이지네이션 참조
    bill_detail_cnt 청구상세목록수 Y N(3)
    bill_detail_list 청구상세목록 Y Object
    --card_id 카드 식별자 Y aN(64) 청구서 내 복수개의 카드를 구분하기 위해 카드 식별자 회신
    --paid_dtime 사용일시 또는 사용일자 Y DTIME 또는 DATE 금융소비자가 물품을 구매하거나 용역을 제공받은 날짜와 시간 (YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 사용일자인 YYYYMMDD 회신 (사용일자 + 거래본호로 구분)
    --trans_no 거래번호 N aN(64) 해당 일자의 거래 특정 번호(없을 경우 미회신)
    - paid_dtime이 사용일자일 경우, 개별거래를 구분하기 위하여 해당 기관이 설정하는 거래번호
    --paid_amt 이용금액 Y F(18,3) 건별 이용 금액
    매입취소 금액이 청구금액보다 큰 경우 음수 표기 가능
    --currency_code 통화코드 (이용금액) N A(3) 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --merchant_name 가맹점명 N AH(75) 금융소비자가 물품을 구매하거나 용역을 제공받은 곳의 명칭
    - 정보주체가 전송요구 시 가맹점명 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    --merchant_regno 가맹점 사업자등록번호 N aN(12) 가맹점의 사업자등록번호
    - “-” 포함
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    - 해외 승인 등의 사유로 가맹점 정보 누락된 경우 미회신
    --credit_fee_amt 신용판매 수수료 Y N(15) 일시불/할부거래, 해외 이용수수료 및 연체수수료 등 일시불 거래로 인해 발생한 각종 수수료
    --total_install_cnt 전체 할부회차 N N(5) 나누어 상환하기로 계약한 원리금의 전체 회차
    - 일시불일 경우 미회신
    --cur_install_cnt 현재 할부회차 N N(5) 나누어 상환하기로 계약한 원리금의 현재 회차
    - 일시불일 경우 미회신
    --balance_amt 할부 결제 후 잔액 N N(15) 기준일 현재 나누어 상환하기로 계약한 원금의 잔액
    - 일시불일 경우 미회신
    --prod_type 상품구분(코드) Y aN(2) 상품구분 (일시불, 신판할부, 현금서비스)
    - <코드값>
    01 : 일시불
    02 : 신판할부
    03 : 현금서비스
    04 : 리볼링
    05 : 카드론
    06 : 연회비
    99 : 기타
    - 카드론의 경우 카드사 정책에 따라 결제에 정금액에 포함되는 경우 기재

  • 결제정보 조회 v2 2022-10-19

    기본 정보
    API ID 카드-006 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/payments
    설명 정보주체가 보유한 카드별 결제 기본정보(일별 결제예정 정보) 조회
    - 카드단위가 아닌, 고객단위로 결제정보 조회
    기준시점 현재 시점
    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_revolving 리볼링(여부) Y Boolean 정보주체(고객)가 리볼링 실행 중이거나, 해지했지만 잔액이 남아있는 경우 true 회신
    - true / false
    - is_revolving이 "true"인 경우, 리볼링 정보 조회 API(카드-007) 호출 가능
    pay_cnt 결제기본정보 목록수 Y N(3)
    pay_list 결제기본정보 목록 Y Object
    --seqno 결제순번 N aN(30) 결제순번(신한카드 등)으로 복수 개의 결제정보를 관리하는 기관의 경우, 결제순번 회신
    --pay_due_date 결제예정일 Y DATE 정보주체의 결제정보를 조회하는 시점에 대금을 납부해야할 가장 가까운 예정 날짜
    - 본 API 조회시점이 결제일일 경우, 결제예정일/결제예정금액은 이번 달(오늘 결제할) 결제정보를 회신
    --pay_amt 결제예정금액 Y N(15) 정보주체의 결제정보를 조회하는 시점에 대금을 납부해야할 가장 가까운 예정 날짜에 출금예정인 금액
    - 본 API 조회시점이 결제일일 경우, 결제예정일/결제예정금액은 이번 달(오늘 결제할) 결제정보를 회신
    - 일시불, 할부, 단기대출(현금서비스), 리볼링, 장기대출(카드론, 신용대출), 연회비 및 기타의 총합
    --lump_sum_amt 일시불 Y F(18,3) 일시불 결제예정금액
    --monthly_amt 할부 Y F(18,3) 할부 결제예정금액
    --loan_short_amt 단기대출(현금서비스) Y F(18,3) 단기대출 결제예정금액
    --revolving_amt 리볼빙 Y F(18,3) 리볼빙 결제예정금액
    --loan_long_amt 장기대출(카드론, 신용대출) Y F(18,3) 장기대출(카드론, 신용대출) 결제예정금액
    --etc_amt 연회비 및 기타 Y F(18,3) 연회비 및 기타 결제예정금액

  • 결제정보 조회 v1 2022-10-19

    기본 정보
    API ID 카드-006 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/payments
    설명 정보주체가 보유한 카드별 결제 기본정보(일별 결제예정 정보) 조회
    - 카드단위가 아닌, 고객단위로 결제정보 조회
    기준시점 현재 시점
    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_revolving 리볼링(여부) Y Boolean 정보주체(고객)가 리볼링 실행 중이거나, 해지했지만 잔액이 남아있는 경우 true 회신
    - true / false
    - is_revolving이 "true"인 경우, 리볼링 정보 조회 API(카드-007) 호출 가능
    pay_cnt 결제기본정보 목록수 Y N(3)
    pay_list 결제기본정보 목록 Y Object
    --seqno 결제순번 N aN(6) 결제순번(신한카드 등)으로 복수 개의 결제정보를 관리하는 기관의 경우, 결제순번 회신
    --pay_due_date 결제예정일 Y DATE 정보주체의 결제정보를 조회하는 시점에 대금을 납부해야할 가장 가까운 예정 날짜
    - 본 API 조회시점이 결제일일 경우, 결제예정일/결제예정금액은 이번 달(오늘 결제할) 결제정보를 회신
    --pay_amt 결제예정금액 Y N(15) 정보주체의 결제정보를 조회하는 시점에 대금을 납부해야할 가장 가까운 예정 날짜에 출금예정인 금액
    - 본 API 조회시점이 결제일일 경우, 결제예정일/결제예정금액은 이번 달(오늘 결제할) 결제정보를 회신
    - 일시불, 신판할부, 현금서비스, 리볼링은 기본적으로 포함, 나머지는 각 사별 정책에 따름(각 사별 정책은 서비스 가이드라인에 반영예정)

  • 리볼빙 정보 조회 v2 2022-10-19

    기본 정보
    API ID 카드-007 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/payments/revolving
    설명 정보주체의 리볼빙 정보 조회 (고객기준)
    기준시점 현재 시점
    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을 회신 또는 미회신
    revolving_cnt 리볼빙목록수 Y N(3)
    revolving_list 리볼빙목록 Y Object
    --req_date 리볼빙약정시작일 Y DATE 일부 결제금액 이월약정(리볼빙)이 시작되는 날짜
    --end_date 리볼빙약정종료일 Y DATE 일부 결제금액 이월약정(리볼빙)이 종료되는 날짜
    (해지신청시 종료일이 변경될 수 있음)
    --close_date 리볼빙해지일자 N DATE 일부 결제금액 이월약정(리볼빙) 해지한 날짜
    (해지시에만 전송)
    --min_pay_rate 최소결제비율 Y F(6,3) 월별로 금융기관에 결제해야 하는 최소한의 비율
    - 최소결제비율이 100%인 기관이 존재하며, 이 경우 "100" 회신
    --min_pay_amt 최소결제금액 Y N(15) 리볼빙의 최소청구원금과 5만원 중 큰 금액, 리볼빙 수수료 리볼빙 대상 외 금액의 합계
    --agreed_pay_rate 약정결제비율 N F(6,3) 회원이 카드사에 리볼빙 이용을 위해 선택한 결제비율
    --agreed_pay_amt 약정결제금액 N N(15) 회원이 카드사에 리볼빙 이용을 위해 선택한 결제금액
    - 약정결제비율이 없는 기관의 경우 약정결제 금액으로 제공(씨티은행 등)
    --remained_amt 리볼빙 이월잔액 Y N(15) 전송시점 기준 월별 일부결제금액 이월약정 이월잔액
    - 리볼링 100%(연결계좌잔고 부족한 경우 잔액만큼만 출금되며 나머지 이월) 포함 (리볼링 이월잔액 없는 경우는 0원으로 표시)

  • 리볼빙 정보 조회 v1 2022-10-19

    기본 정보
    API ID 카드-007 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/payments/revolving
    설명 정보주체의 리볼빙 정보 조회 (고객기준)
    기준시점 현재 시점
    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을 회신 또는 미회신
    revolving_cnt 리볼빙목록수 Y N(3)
    revolving_list 리볼빙목록 Y Object
    --req_date 신청일 Y DATE 회원이 일부 결제금액 이월약정(리볼빙)을 신청한 일자
    --min_pay_rate 최소결제비율 Y F(6,3) 월별로 금융기관에 결제해야 하는 최소한의 비율
    - 최소결제비율이 100%인 기관이 존재하며, 이 경우 "100" 회신
    --min_pay_amt 최소결제금액 Y N(15) 리볼빙의 최소청구원금과 5만원 중 큰 금액, 리볼빙 수수료 리볼빙 대상 외 금액의 합계
    --agreed_pay_rate 약정결제비율 N F(6,3) 회원이 카드사에 리볼빙 이용을 위해 선택한 결제비율
    --agreed_pay_amt 약정결제금액 N N(15) 회원이 카드사에 리볼빙 이용을 위해 선택한 결제금액
    - 약정결제비율이 없는 기관의 경우 약정결제 금액으로 제공(씨티은행 등)
    --remained_amt 리볼빙 이월잔액 Y N(15) 전송시점 기준 월별 일부결제금액 이월약정 이월잔액
    - 리볼링 100%(연결계좌잔고 부족한 경우 잔액만큼만 출금되며 나머지 이월) 포함 (리볼링 이월잔액 없는 경우는 0원으로 표시)

  • 국내 승인내역 조회 v2 2022-10-19

    기본 정보
    API ID 카드-008 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/cards/{card_id}/approval-domestic
    설명 정보주체가 보유한 카드별 국내 승인 상세정보(건별 카드 이용정보(일시불, 할부, 체크카드) 및 무승인매입 정보 포함하여 전송) 조회 (Pagination, 사용일시 기준 내림차순)
    - 조회 시작일자/종료일자 기간 내에 승인내역 뿐만 아니라 정정/취소내역도 회신 필요 (즉, from_date <= 승인일자(승인일시의 YYYYMMDD에 해당) <= to_date를 만족하는 승인내역뿐만 아니라, from_date <= 정정/취소일자(“정정 또는 승인취소 일시”의 YYYYMMDD에 해당) <= to_date를 만족하는 정정내역 및 취소내역 회신 필요)
    - 신용정보법 시행령 제 28조의3제4항에 의거, 최근 5년 이내 정보 제공- (무승인매입 정보) 최근 1년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    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 유형
    Path card_id 카드식별자 Y
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 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] 페이지네이션 참조
    approved_cnt 국내승인목록수 Y N(3)
    approved_list 국내승인목록 Y Object
    --approved_num 승인번호 Y aN(21) 카드 승인 시 각 카드사에서 발행한 번호
    --approved_dtime 승인일시 Y DTIME 금융소비자가 물품을 구매하거나 용역을 제공받은 날짜와 시간
    - 기업은행(카드), 농협카드의 경우 일배치 전송으로 무승인 매입일시를 배치전송시간으로 전송하며 실제 무승인 매입일시는 정정 또는 승인취소 일시(trans_dtime)로 전송
    --status 결제상태(코드) Y aN(2) 승인/승인취소/정정/무승인 매입
    - <코드값>
    01 : 승인,
    02 : 승인취소,
    03 : 정정,
    04 : 무승인 매입
    --pay_type 사용구분(신용/체크)(코드) Y aN(2) 해당 결제의 신용/체크 구분(결제타입)
    - <코드값>
    01 : 신용
    02 : 체크
    --trans_dtime 정정 또는 승인취소 일시 N DTIME 정정 또는 승인취소가 발생한 일시
    - 결제상태(코드)가 '02'인 경우 : 취소일시
    - 결제상태(코드)가 '03'인 경우 : 정정일시
    - 결제상태(코드)가 '04'이면서 기업은행(카드), 농협카드의 경우 : 무승인매입 발생일시 전송
    --merchant_name 가맹점명 N AH(75) 금융소비자가 물품을 구매하거나 용역을 제공받은 곳의 명칭
    - 정보주체가 전송요구 시 가맹점명 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno='true') 회신하고, 그렇지 않은 경우 미회신
    - 정보주체 거주지 정보를 회신할 경우 거주지 정보가 구체적으로 특정되지 않도록 일부 정보 마스킹 또는 삭제 등 비식별 조치하여 회신
    --merchant_regno 가맹점 사업자등록번호 N NS(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) 나누어 상환하기로 계약한 원리금의 전체 회차
    - 일시불일 경우 미회신

  • 국내 승인내역 조회 v1 2022-10-19

    기본 정보
    API ID 카드-008 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/cards/{card_id}/approval-domestic
    설명 정보주체가 보유한 카드별 국내 승인 상세정보(건별 카드 이용정보(일시불, 할부, 체크카드)) 조회 (Pagination, 사용일시 기준 내림차순)
    - 조회 시작일자/종료일자 기간 내에 승인내역 뿐만 아니라 정정/취소내역도 회신 필요 (즉, from_date <= 승인일자(승인일시의 YYYYMMDD에 해당) <= to_date를 만족하는 승인내역뿐만 아니라, from_date <= 정정/취소일자(“정정 또는 승인취소 일시”의 YYYYMMDD에 해당) <= to_date를 만족하는 정정내역 및 취소내역 회신 필요)
    - 신용정보법 시행령 제 28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    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 유형
    Path card_id 카드식별자 Y
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 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] 페이지네이션 참조
    approved_cnt 국내승인목록수 Y N(3)
    approved_list 국내승인목록 Y Object
    --approved_num 승인번호 Y aN(8) 카드 승인 시 각 카드사에서 발행한 번호
    --approved_dtime 승인일시 Y DTIME 금융소비자가 물품을 구매하거나 용역을 제공받은 날짜와 시간
    --status 결제상태(코드) Y aN(2) 승인/승인취소/정정
    - <코드값>
    01 : 승인,
    02 : 승인취소,
    03 : 정정
    --pay_type 사용구분(신용/체크)(코드) Y aN(2) 해당 결제의 신용/체크 구분(결제타입)
    - <코드값>
    01 : 신용
    02 : 체크
    --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) 나누어 상환하기로 계약한 원리금의 전체 회차
    - 일시불일 경우 미회신

  • 해외 승인내역 조회 v1 2022-10-19

    기본 정보
    API ID 카드-009 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/cards/{card_id}/approval-overseas
    설명 정보주체가 보유한 카드별 해외 승인 상세정보(건별 카드 이용정보(일시불, 할부, 체크카드)) 조회 (Pagination, 사용일시 기준 내림차순)
    - 조회 시작일자/종료일자 기간 내에 승인내역 뿐만 아니라 정정/취소내역도 회신 필요 (즉, from_date <= 승인일자(승인일시의 YYYYMMDD에 해당) <= to_date를 만족하는 승인내역뿐만 아니라, from_date <= 정정/취소일자(“정정 또는 승인취소 일시”의 YYYYMMDD에 해당) <= to_date를 만족하는 정정내역 및 취소내역 회신 필요)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    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 유형
    Path card_id 카드식별자 Y
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 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] 페이지네이션 참조
    approved_cnt 해외승인목록수 Y N(3)
    approved_list 해외승인목록 Y Object
    --approved_num 승인번호 Y aN(8) 카드 승인 시 각 카드사에서 발행한 번호
    --approved_dtime 승인일시 Y DTIME 금융소비자가 물품을 구매하거나 용역을 제공받은 날짜와 시간
    --status 결제상태(코드) Y aN(2) 승인/승인취소/정정
    - <코드값>
    01 : 승인
    02 : 승인취소
    03 : 정정
    --pay_type 사용구분(신용/체크)(코드) Y aN(2) 신용/체크(결제타입)
    - <코드값>
    01 : 신용
    02 : 체크
    --trans_dtime 정정 또는 승인취소 일시 N DTIME 정정 또는 승인취소가 발생한 일시
    - 결제상태(코드)가 '02'인 경우 : 취소일시
    - 결제상태(코드)가 '03'인 경우 : 정정일시
    --merchant_name 가맹점명 N AH(75) 금융소비자가 물품을 구매하거나 용역을 제공받은 곳의 명칭
    - 해외승인의 경우 가맹점명이 없는 경우가 존재하며, 이 경우 미회신
    - 정보주체가 전송요구 시 가맹점명 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno='true') 회신하고, 그렇지 않은 경우 미회신
    --approved_amt 이용금액 Y F(18,3) 가맹점에서 이용한 금액(결제 시 통화코드에 해당하는 금액)
    --modified_amt 정정후 금액 N F(18,3) 정정후 이용 금액
    - 결제상태(코드)가 '03'인 경우만 회신
    --country_code 결제(승인) 국가코드 Y A(2) 카드 승인 국가의 국가코드 (ISO 1366-1 alpha-2 준용)
    --currency_code 결제(승인) 시 통화코드 Y A(3) 카드 승인 시 선택한 통화코드(ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --krw_amt 원화 N N(15) 원화로 환산한 금액
    - 원화금액이 승인시점에 확정이 되는 기관의 경우 회신(매입시점에 확정되는 기관의 경우, 미회신)

  • 해외 승인내역 조회 v2 2022-10-19

    기본 정보
    API ID 카드-009 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/cards/{card_id}/approval-overseas
    설명 정보주체가 보유한 카드별 해외 승인 상세정보(건별 카드 이용정보(일시불, 할부, 체크카드) 및 무승인매입 정보 포함하여 전송) 조회 (Pagination, 사용일시 기준 내림차순)
    - 조회 시작일자/종료일자 기간 내에 승인내역 뿐만 아니라 정정/취소내역도 회신 필요 (즉, from_date <= 승인일자(승인일시의 YYYYMMDD에 해당) <= to_date를 만족하는 승인내역뿐만 아니라, from_date <= 정정/취소일자(“정정 또는 승인취소 일시”의 YYYYMMDD에 해당) <= to_date를 만족하는 정정내역 및 취소내역 회신 필요)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공 - (무승인매입 정보) 최근 1년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    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 유형
    Path card_id 카드식별자 Y
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 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] 페이지네이션 참조
    approved_cnt 해외승인목록수 Y N(3)
    approved_list 해외승인목록 Y Object
    --approved_num 승인번호 Y aN(21) 카드 승인 시 각 카드사에서 발행한 번호
    --approved_dtime 승인일시 Y DTIME 금융소비자가 물품을 구매하거나 용역을 제공받은 날짜와 시간
    - 기업은행(카드), 농협카드의 경우 일배치 전송으로 무승인 매입일시를 배치전송시간으로 전송하며 실제 무승인 매입일시는 정정 또는 승인취소 일시(trans_dtime)로 전송
    --status 결제상태(코드) Y aN(2) 승인/승인취소/정정/무승인 매입
    - <코드값>
    01 : 승인
    02 : 승인취소
    03 : 정정
    04 : 무승인 매입
    --pay_type 사용구분(신용/체크)(코드) Y aN(2) 신용/체크(결제타입)
    - <코드값>
    01 : 신용
    02 : 체크
    --trans_dtime 정정 또는 승인취소 일시 N DTIME 정정 또는 승인취소가 발생한 일시
    - 결제상태(코드)가 '02'인 경우 : 취소일시
    - 결제상태(코드)가 '03'인 경우 : 정정일시
    - 결제상태(코드)가 '04'이면서 기업은행(카드), 농협카드의 경우 : 무승인매입 발생일시 전송
    --merchant_name 가맹점명 N AH(75) 금융소비자가 물품을 구매하거나 용역을 제공받은 곳의 명칭
    - 해외승인의 경우 가맹점명이 없는 경우가 존재하며, 이 경우 미회신
    - 정보주체가 전송요구 시 가맹점명 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno='true') 회신하고, 그렇지 않은 경우 미회신
    --approved_amt 이용금액 Y F(18,3) 가맹점에서 이용한 금액(결제 시 통화코드에 해당하는 금액)
    --modified_amt 정정후 금액 N F(18,3) 정정후 이용 금액
    - 결제상태(코드)가 '03'인 경우만 회신
    --country_code 결제(승인) 국가코드 N A(2) 카드 승인 국가의 국가코드 (ISO 1366-1 alpha-2 준용)(정보 부재한 경우 미회신)
    --currency_code 결제(승인) 시 통화코드 Y A(3) 카드 승인 시 선택한 통화코드(ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --krw_amt 원화 N N(15) 원화로 환산한 금액
    - 원화금액이 승인시점에 확정이 되는 기관의 경우 회신(매입시점에 확정되는 기관의 경우, 미회신)
    - 정정 시 정정 후 금액을 원화로 전송

  • 대출상품 목록 조회 v1 2022-10-19

    기본 정보
    API ID 카드-010 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/loans
    설명 정보주체의 대출상품 목록 조회(단기, 장기대출을 실행하고 있는지 여부를 회신)
    기준시점 현재 시점
    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_loan_short_term 단기대출(여부) Y Boolean 정보주체(고객)가 단기대출 실행 중이거나, 해지했지만 잔액이 남아있는 경우 true 회신
    - true / false
    is_loan_long_term 장기대출(여부) Y Boolean 정보주체(고객)가 장기대출 실행 중이거나, 해지했지만 잔액이 남아있는 경우 true 회신
    - true / false

  • 대출상품 목록 조회 v2 2022-10-19

    기본 정보
    API ID 카드-010 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/loans
    설명 정보주체의 대출상품 목록 조회(단기, 장기대출을 실행하고 있는지 여부를 회신)
    기준시점 현재 시점
    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_loan_short_term 단기대출(여부) Y Boolean 정보주체(고객)가 단기대출 실행 중이거나, 해지했지만 잔액이 남아있는 경우 true 회신
    - true / false
    is_loan_long_term 장기대출(여부) Y Boolean 정보주체(고객)가 장기대출 실행 중이거나, 해지했지만 잔액이 남아있는 경우 true 회신
    - true / false

  • 단기대출 정보 조회 v1 2022-10-19

    기본 정보
    API ID 카드-011 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/loans/short-term
    설명 정보주체의 단기대출(현금서비스) 정보 조회 (고객기준)
    - 해외 현금서비스는 제공 대상에서 제외
    - 고객이 대출(단기/장기)을 해지했다고 하더라도, 대출잔액이 남아있으면 회신
    기준시점 현재 시점
    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을 회신 또는 미회신
    short_term_cnt 단기대출 목록수 Y N(3)
    short_term_list 단기대출목록 Y Object
    --loan_dtime 이용일시 Y DTIME 해당 단기대출상품(현금서비스)을 이용한 날짜와 시간
    --loan_amt 이용금액 (취급액) Y N(15) 해당 단기대출상품(현금서비스)을 이용한 금액 (매출이 발생한 금액)
    --balance_amt 단기대출잔액 Y N(15) 기준일자 현재 해당 단기 대출상품(현금서비스)에 상환해야 하는 잔여 금액 (부분납부가 가능하여 추가)
    --pay_due_date 결제예정일 Y DATE 해당 단기대출상품(현금서비스) 대금이 결제 계좌에서 출금되는 날짜
    --int_rate 이자율 Y F(5,3) 단기대출상품(현금서비스) 이용에 따른 이자율

  • 단기대출 정보 조회 v2 2022-10-19

    기본 정보
    API ID 카드-011 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/loans/short-term
    설명 정보주체의 단기대출(현금서비스) 정보 조회 (고객기준)
    - 해외 현금서비스는 제공 대상에서 제외
    - 고객이 대출(단기/장기)을 해지했다고 하더라도, 대출잔액이 남아있으면 회신
    기준시점 현재 시점
    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을 회신 또는 미회신
    short_term_cnt 단기대출 목록수 Y N(3)
    short_term_list 단기대출목록 Y Object
    --loan_dtime 이용일시 Y DTIME 해당 단기대출상품(현금서비스)을 이용한 날짜와 시간
    --loan_amt 이용금액 (취급액) Y N(15) 해당 단기대출상품(현금서비스)을 이용한 금액 (매출이 발생한 금액)
    --balance_amt 단기대출잔액 Y N(15) 기준일자 현재 해당 단기 대출상품(현금서비스)에 상환해야 하는 잔여 금액 (부분납부가 가능하여 추가)
    --pay_due_date 결제예정일 Y DATE 해당 단기대출상품(현금서비스) 대금이 결제 계좌에서 출금되는 날짜
    --int_rate 이자율 Y F(5,3) 단기대출상품(현금서비스) 이용에 따른 이자율
    --repay_org_code 상환기관(코드) N aN(8) (선택전송) 상환계좌번호의 소속 기관코드
    --repay_account_num 상환계좌번호 N aN(20) 상환계좌번호 (해당 계좌번호가 정보주체 본인의 소유가 확인된 경우에만 회신하며, 확인인이 불가하거나 타인의 소유일 경우에는 미회신)

  • 장기대출 정보 조회 v1 2022-10-19

    기본 정보
    API ID 카드-012 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/card/loans/long-term
    설명 정보주체의 장기대출(카드론) 정보 조회 (고객기준)
    - 고객이 대출(단기/장기)을 해지했다고 하더라도, 대출잔액이 남아있으면 회신
    기준시점 현재 시점
    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을 회신 또는 미회신
    long_term_cnt 장기대출 목록수 Y N(3)
    long_term_list 장기대출목록 Y Object
    --loan_dtime 대출일시 또는 대출일자 Y DTIME 또는 DATE 해당 대출이 실행된 날짜 또는 시간 (확정일자로 관리)
    - 카드사별 재확인 필요
    --loan_cnt 일자의 대출회차 N N(5) loan_dtime에 대출일시가 아닌 대출일자를 회신하는 경우, 당일에 여러 건 대출 시 대출일자만으로 구분이 힘들 수 있어 대출회차 회신 필요
    - 카드사별 재확인 필요
    --loan_type 대출종류 N AH(15) 해당 장기대출상품(카드론)의 종류 구분
    - 대출종류(상환방식)을 상품명으로 갈음이 가능한 기관의 경우 미회신
    --loan_name 상품명 Y AH(300) 해당 장기대출상품(카드론)의 이름(이지론, 직장인론 등)
    --loan_amt 이용금액 Y F(18,3) 해당 대출계약의 원금 전부
    - 취급액
    --int_rate 이자율 Y F(5,3) 장기대출상품(카드론) 이용에 따른 이자율
    --exp_date 만기일 Y DATE 해당 장기대출상품(카드론) 계약이 만기(종료)되는 날짜
    - 완납일
    --balance_amt 장기대출 잔액 Y F(18,3) 기준일자 현재 해당 장기대출상품(카드론)에 상환해야 하는 잔여 금액
    --repay_method 상환방법 (코드) Y aN(2) 장기대출상품(카드론)을 상환하는 방식(원리금균등분할상환, 만기일시상환 등)
    - [첨부4] 상환방식 코드
    --int_amt 상환액 중 이자 Y F(18,3) 해당 상환된 금액중 이자

  • 장기대출 정보 조회 v2 2022-10-19

    기본 정보
    API ID 카드-012 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/loans/long-term
    설명 정보주체의 장기대출(카드론) 정보 조회 (고객기준)
    - 고객이 대출(단기/장기)을 해지했다고 하더라도, 대출잔액이 남아있으면 회신
    기준시점 현재 시점
    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을 회신 또는 미회신
    long_term_cnt 장기대출 목록수 Y N(3)
    long_term_list 장기대출목록 Y Object
    --loan_num 대출번호 Y aN(20) 해당 대출 상품 식별을 위한 번호
    --loan_dtime 대출일시 또는 대출일자 Y DTIME 또는 DATE 해당 대출이 실행된 날짜 또는 시간 (확정일자로 관리)
    - 카드사별 재확인 필요
    --loan_cnt 일자의 대출회차 N N(5) loan_dtime에 대출일시가 아닌 대출일자를 회신하는 경우, 당일에 여러 건 대출 시 대출일자만으로 구분이 힘들 수 있어 대출회차 회신 필요
    - 카드사별 재확인 필요
    --loan_type 대출종류 N AH(15) 해당 장기대출상품(카드론, 신용대출)의 종류 구분
    - 대출종류(상환방식)을 상품명으로 갈음이 가능한 기관의 경우 미회신
    --loan_name 상품명 Y AH(300) 해당 장기대출상품(카드론, 신용대출)의 이름(이지론, 직장인론 등)
    --loan_amt 이용금액 Y F(18,3) 해당 대출계약의 원금 전부
    - 취급액
    --int_rate 이자율 Y F(5,3) 장기대출상품(카드론, 신용대출) 이용에 따른 이자율
    --exp_date 만기일 Y DATE 해당 장기대출상품(카드론, 신용대출) 계약이 만기(종료)되는 날짜
    - 완납일
    --balance_amt 장기대출 잔액 Y F(18,3) 기준일자 현재 해당 장기대출상품(카드론, 신용대출)에 상환해야 하는 잔여 금액
    --repay_method 상환방법 (코드) Y aN(2) 장기대출상품(카드론, 신용대출)을 상환하는 방식(원리금균등분할상환, 만기일시상환 등)
    - [첨부4] 상환방식 코드
    --int_amt 상환액 중 이자 Y F(18,3) 해당 상환된 금액중 이자
    --repay_org_code 상환기관(코드) N aN(8) (선택전송) 상환계좌번호의 소속 기관코드
    --repay_account_num 상환계좌번호 N aN(20) 상환계좌번호 (해당 계좌번호가 정보주체 본인의 소유가 확인된 경우에만 회신하며, 확인인이 불가하거나 타인의 소유일 경우에는 미회신)

  • 장기대출 거래내역 정보 조회 v2 2022-10-19

    기본 정보
    API ID 카드-013 HTTP Method POST
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/loans/long-term/transactions
    설명 정보주체가 계약한 장기대출 이자 납입 및 대출 원금 상황 내역 조회(Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - 일부 카드사에서 운영하는 '마이너스론'(은행 입출금계좌와 연계하여 사용하는 장기대출상품)상품의 경우, 거래내역을 입출금통장 거래내역과 구분하여 제공이 불가한 이슈로 거래내역에 대하여 빈(empty)리스트로 회신
    기준시점 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로부터 배포
    loan_num 대출번호 Y aN(20) 해당 대출 상품 식별을 위한 번호
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래목록수 Y N(3)
    trans_list 거래목록 Y <object>
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 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 거래금액 중 이자 N F(18,3) 해당 거래(상환) 금액 중 이자(환출이자 발생시 해당 금액을 감한 금액)
    - 정상이자 외 연체이자, 수수료등은 제반비용은 본 항목에 포함하여 회신

  • 국내 카드매입정보(매입취소정보) 조회 v2 2022-10-19

    기본 정보
    API ID 카드-014 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/cards/{card_id}/purchase-domestic
    설명 정보주체가 보유한 카드별 국내 카드매입정보(매입취소정보)조회(Pagination, 거래일시 기준 내림차순)
    - 최근 1년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    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 유형
    Path card_id 카드식별자 Y
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 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] 페이지네이션 참조
    purchase_cnt 국내매입목록수 Y N(3)
    purchase_list 국내매입목록 Y Object
    --purchase_num 매입번호 Y aN(32) 카드 매입시 각사에서 발행한 번호
    --purchase_date 매입일자 Y DATE 취소매출전표 매입일(FROM-TO 조회 기준 일자)
    --sales_date 매출일자 N DATE 매입취소시 취소발생 일자(취소 접수 일자)
    --pri_approved_num 원승인번호 N aN(21) 매입취소시 승인단계에서 각사가 발행한 번호
    - (DB구조나 시점 차이에 의해) 모든 매입건에 대해 원 승인정보 보유한 것이 아니므로 없는 경우 미전송(예시 : 강제취소)
    --pri_approved_dtime 원승인일시 N DTIME 매입취소시 원승인 발생 일시
    - (DB구조나 시점 차이에 의해) 모든 매입건에 대해 원 승인정보 보유한 것이 아니므로 없는 경우 미전송(예시 : 강제취소)
    --pri_approved_amt 원승인금액 N F(18,3) 매입취소시 승인단계에서 승인처리된 금액
    - (DB구조나 시점 차이에 의해) 모든 매입건에 대해 원 승인정보 보유한 것이 아니므로 없는 경우 미전송(예시 : 강제취소)
    --pay_type 사용구분(신용/체크)(코드) Y aN(2) 해당 결제의 신용/체크 구분(결제타입)
    - <코드값>
    01 : 신용
    02 : 체크
    --merchant_name 가맹점명 N AH(75) 금융소비자가 물품을 구매하거나 용역을 제공받은 곳의 명칭
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    --merchant_regno 가맹점 사업자등록번호 N NS(12) 가맹점의 사업자등록번호
    - “-” 포함
    - 정보주체가 전송요구 시 가맹점명/사업자등록번호 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    --approved_amt 이용금액 Y F(18,3) 가맹점에서 이용한 금액 (매입취소금액)
    - 양수로 회신
    --total_install_cnt 전체 할부회차 N N(5) 나누어 상환하기로 계약한 원리금의 전체 회차
    - 일시불일 경우 미회신

  • 해외 카드매입정보(매입취소정보) 조회 v2 2022-10-19

    기본 정보
    API ID 카드-015 HTTP Method GET
    API 제공자 카드업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/card/cards/{card_id}/purchase-overseas
    설명 정보주체가 보유한 카드별 해외 카드매입정보(매입취소정보)조회(Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공(금융당국 협의에 따라 변동 가능)
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    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 유형
    Path card_id 카드식별자 Y
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 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] 페이지네이션 참조
    purchase_cnt 해외매입목록수 Y N(3)
    purchase_list 해외매입목록 Y Object
    --purchase_num 매입번호 Y aN(32) 카드 매입시 각사에서 발행한 번호
    --purchase_date 매입일자 Y DATE 취소매출전표 매입일(FROM-TO 조회 기준 일자)
    --sales_date 매출일자 N DATE 취매입취소시 취소 발생 일자(취소 접수 일자)
    --pri_approved_num 원승인번호 N aN(21) 매입취소시 승인단계에서 각사가 발행한 번호
    - (DB구조나 시점 차이에 의해) 모든 매입건에 대해 원 승인정보 보유한 것이 아니므로 없는 경우 미전송(예시 : 강제취소)
    --pri_approved_dtime 원승인일시 N DTIME 매입취소시 원승인 발생 일시
    - (DB구조나 시점 차이에 의해) 모든 매입건에 대해 원 승인정보 보유한 것이 아니므로 없는 경우 미전송(예시 : 강제취소)
    --pri_approved_amt 원승인금액 N F(18,3) 매입취소시 승인단계에서 승인처리된 금액
    - (DB구조나 시점 차이에 의해) 모든 매입건에 대해 원 승인정보 보유한 것이 아니므로 없는 경우 미전송(예시 : 강제취소)
    --pri_krw_amt 원승인금액원화 N N(15) 원승인금액을 원화로 환산환 금액
    - 원화금액이 승인시점에 확정이 되는 기관의 경우 회신(매입시점에 확정되는 기관의 경우 미회신)
    --pri_currency_code 원승인금액 통화코드 N A(3) 원승인금액에 대한 통화코드
    --pay_type 사용구분(신용/체크)(코드) Y aN(2) 해당 결제의 신용/체크 구분(결제타입)
    - <코드값>
    01 : 신용
    02 : 체크
    --merchant_name 가맹점명 N AH(75) 금융소비자가 물품을 구매하거나 용역을 제공받은 곳의 명칭
    - 정보주체가 전송요구 시 가맹점명 정보를 전송요구한 경우 (정보제공-공통-002의 is_consent_merchant_name_regno=“true”) 회신하고, 그렇지 않은 경우 미회신
    --approved_amt 이용금액 Y F(18,3) 가맹점에서 이용한 금액 (매입취소금액)
    - 양수로 회신
    --country_code 결제(매입) 국가코드 N A(2) 카드 매입 국가의 국가코드 (ISO 1366-1 alpha-2 준용)(정보 부재한 경우 미회신)
    --currency_code 결제(매입) 시 통화코드 Y A(3) 카드 매입 시 선택한 통화코드 (ISO 4217 준용)
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)
    - 원승인금액의 통화코드와 동일
    --krw_amt 원화 N N(15) (선택전송)원화로 환산한 금액

Table of contents

카드 업권 정보제공 API 규격