알림

알림 메세지가 들어가는 영역입니다.

메뉴 건너띄기
상단메뉴 바로가기 왼쪽메뉴 바로가기 본문 바로가기

마이페이지

API Document

1. Overview

본 문서는 “오픈뱅킹” 에서 제공하는 오픈 API 명세를 기술합니다. 오픈뱅킹 이용승인을 받은 핀테크기업(이하 “이용기관”)은 오픈뱅킹이 제공하는 오픈 API를 활용하여 이용기관용 응용프로그램(이하 “앱”)을 개발할 수 있습니다.

Terms of service: www.openapi.openbanking.or.kr

1.1. URI scheme

Host: openapi.openbanking.or.kr BasePath: / Schemes: HTTPS

1.2. Tags

  • /account: 계좌

  • /bank: 참가은행

  • /inquiry: 조회

  • /oauth/2.0: OAuth 2.0

  • /transfer: 이체

  • /user: 사용자

  • /return: 자금반환

2. Resources

Insert title here

2.1. /account

계좌

2.1.1. 잔액조회(핀테크번호)

GET v2.0/account/balance/fin_num
Description

사용자 계좌의 잔액을 조회합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

fintech_use_num

핀테크이용번호

true

string

QueryParameter

tran_dtime

요청일시

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/account/balance/fin_num

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.2. 잔액조회(계좌번호)

POST v2.0/account/balance/acnt_num
Description

사용자 계좌의 잔액을 조회합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

bank_code_std

개설기관.표준코드

true

string

QueryParameter

account_num

계좌번호

true

string

QueryParameter

user_seq_no

사용자일련번호

true

string

QueryParameter

tran_dtime

요청일시

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/account/balance/acnt_num

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.3. 계좌해지

POST v2.0/account/cancel
Description

오픈뱅킹에 등록된 사용자의 계좌를 해지(등록삭제 및 동의해지)합니다. 계좌해지는 참가은행에 등록된 내역까지 해지합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

scope

서비스구분(inquiry : 조회서비스, transfer : 출금서비스)

true

string

QueryParameter

fintech_use_num

핀테크이용번호

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/account/cancel

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.4. 등록계좌조회

GET v2.0/account/list
Description

사용자의 등록된 계좌목록을 조회합니다. 해지계좌 포함여부 및 정렬순서를 지정할 수 있습니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

user_seq_no

사용자일련번호

true

string

QueryParameter

include_cancel_yn

해지계좌포함여부(Y:해지계좌포함, N:해지계좌불포함)

true

string

QueryParameter

sort_order

정렬순서(D:Descending, A:Ascending)

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/account/list

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.5. 거래내역조회(핀테크번호)

GET v2.0/account/transaction_list/fin_num
Description

사용자가 등록한 계좌의 거래내역을 조회합니다. 등록된 핀테크이용번호로 요청하는 경우(/fin_num)와 실 계좌번호로 요청하는 경우(/acnt_num)의 두 가지 기능을 각각 제공합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

fintech_use_num

핀테크이용번호

true

string

QueryParameter

inquiry_type

조회구분코드(A:All, I:입금, O:출금)

true

string

QueryParameter

inquiry_base

조회기준코드(D:일자, T:시간)

true

string

QueryParameter

from_date

조회시작일자

true

string

QueryParameter

from_time

조회시작시간

true

string

QueryParameter

to_date

조회종료일자

true

string

QueryParameter

to_time

조회종료시간

true

string

QueryParameter

sort_order

정렬순서(D:Descending,A:Ascending)

true

string

QueryParameter

tran_dtime

요청일시

true

string

QueryParameter

befor_inquiry_trace_info

직전조회추적정보

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/account/transaction_list/fin_num

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.6. 거래내역조회(계좌번호)

POST v2.0/account/transaction_list/acnt_num
Description

사용자가 등록한 계좌의 거래내역을 조회합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

bank_code_std

개설기관.표준코드

true

string

QueryParameter

account_num

계좌번호

true

string

QueryParameter

inquiry_type

조회구분코드(A:All, I:입금, O:출금)

true

string

QueryParameter

inquiry_base

조회기준코드(D:일자, T:시간)

true

string

QueryParameter

from_date

조회시작일자

true

string

QueryParameter

from_time

조회시작시간

true

string

QueryParameter

to_date

조회종료일자

true

string

QueryParameter

to_time

조회종료시간

true

string

QueryParameter

sort_order

정렬순서(D:Descending,A:Ascending)

true

string

QueryParameter

tran_dtime

요청일시

true

string

QueryParameter

befor_inquiry_trace_info

직전조회추적정보

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/account/transaction_list/acnt_num

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.7. 계좌정보변경

POST v2.0/account/update_info
Description

등록된 계좌의 별명을 변경합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

fintech_use_num

핀테크이용번호

true

string

QueryParameter

account_alias

변경코자하는 계좌별명

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/account/update_info

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

Insert title here

2.2. /bank

참가은행

2.2.1. 참가은행상태조회

GET v2.0/bank/status
Description

이용기관이 참가은행의 서비스 상태(거래가능, 장애, 개시이전, 종료 등)를 확인합니다.

Parameters
Type Name Description Required Schema Default
Responses
HTTP Code Description Schema

200

OK

RES v2.0/bank/status

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

Insert title here

2.3. /inquiry

조회

2.3.1. 계좌실명조회

POST v2.0/inquiry/real_name
Description

이용기관이 특정 계좌의 계좌번호와 예금주 실명번호를 보유하고 있는 경우 해당 계좌의 유효성 및 예금주성명을 확인합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

bank_code_std

개설기관.표준코드

true

string

QueryParameter

account_num

계좌번호

true

string

QueryParameter

account_holder_info_type

예금주 실명번호 구분코드

true

string

QueryParameter

account_holder_info

예금주 실명번호

false

string

QueryParameter

tran_dtime

요청일시

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/inquiry/real_name

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.3.2. 송금인정보조회

POST v2.0/inquiry/remit_list
Description

소액해외송금업자의 경우에 외화송금을 위하여 이용기관의 수취계좌로 입금한 송금인의 성명과 계좌번호를 확인하여 송금인의 신분을 확인할 의무가 있습니다. 기 등록된 수취계좌에 대하여 특정 기간 동안 입금된 송금인 성명과 계좌번호 내역을 전달합니다. 소액해외송금업자인 경우에만 이용신청이 가능합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

bank_code_std

조회하고자 하는 이용기관수취계좌의 개설기관.표준코드

true

string

QueryParameter

account_num

조회하고자 하는 이용기관수취계좌의 계좌번호

true

string

QueryParameter

from_date

조회시작일자

true

string

QueryParameter

from_time

조회시작시간

true

string

QueryParameter

to_date

조회종료일자

true

string

QueryParameter

to_time

조회종료시간

true

string

QueryParameter

sort_order

정렬순서(D:Descending, A:Ascending)

true

string

QueryParameter

befor_inquiry_trace_info

직전조회추적정보

false

string

QueryParameter

tran_dtime

요청일시

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/inquiry/remit_list

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.3.3. 수취조회

POST v2.0/inquiry/receive
Description

이용기관이 입금이체 요청 전 수취계좌의 입금가능여부 및 수취인성명을 사전에 조회합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

cntr_account_type

약정 계좌/계정구분

true

string

QueryParameter

cntr_account_num

약정 계좌/계정번호

true

string

QueryParameter

bank_code_std

입금은행.표준코드

false

string

QueryParameter

account_num

계좌번호

false

string

QueryParameter

fintech_use_num

핀테크이용번호

false

string

QueryParameter

print_content

입금계좌인자내역

true

string

QueryParameter

tran_amt

거래금액

true

string

QueryParameter

req_client_name

요청고객성명

true

string

QueryParameter

req_client_bank_code

요청고객계좌 개설기관.표준코드

true

string

QueryParameter

req_client_account_num

요청고객계좌번호

true

string

QueryParameter

req_client_fintech_use_num

요청고객핀테크이용번호

true

string

QueryParameter

req_client_num

요청고객회원번호

true

string

QueryParameter

transfer_purpose

이체용도

true

string

QueryParameter

sub_frnc_name

하위가맹점명

true

string

QueryParameter

sub_frnc_num

하위가맹점번호

true

string

QueryParameter

sub_frnc_business_num

하위가맹점 사업자등록번호

true

string

QueryParameter

cms_num

CMS 번호

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/inquiry/receive

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.3.4. 이상금융거래 탐지내역 조회

POST v2.0/inquiry/fds_detect
Description

이용기관과 관련된 이상금융거래 탐지내역을 조회합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

inquiry_date

조회일자

true

string

QueryParameter

from_time

조회시작시간

true

string

QueryParameter

to_time

조회종료시간

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/inquiry/fds_detect

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

Insert title here

2.4. /oauth

oauth2.0

2.4.1. 사용자인증

GET oauth/2.0/authorize
Description

사용자인증(OAuth 2.0)은 3-legged 인증과 2-legged 인증으로 구분됩니다. 3-legged 인증은 사용자가 이용기관의 앱을 통하여 오픈뱅킹 서비스에 접근하기 위한 인증 기능을 제공합니다. 사용자는 오픈뱅킹(Service Provider)의 인증 페이지에서 휴대폰 본인인증 및 ARS 동의를 통하여 인증하고, 이용기관은 사용자에 대한 Access Token을 얻음으로써 사용자의 인증을 획득합니다. 2-legged 인증은 사용자의 개입 없이 단순히 이용기관이 자신에 대한 인증정보(Client ID, Client Secret)를 가지고 인증함으로써, 오픈뱅킹으로부터 이용기관에 대한 Access Token을 획득하는 것을 의미합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

response_type

OAuth 2.0 인증 요청 시 반환되는 형태

true

string

code

QueryParameter

client_id

오픈뱅킹에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

redirect_uri

사용자인증이 성공하면 이용기관으로 연결되는 URL

true

string

QueryParameter

scope

Access Token 권한 범위(다중 scope 가능)

true

string

QueryParameter

client_info

이용기관이 셋팅하는 임의의 정보

false

string

QueryParameter

state

CSRF 보안위협에 대응하기 위해 이용기관이 셋팅하는 난수값

true

string

QueryParameter

auth_type

사용자인증타입 구분(0:최초인증, 1:재인증, 2:인증생략)

true

string

QueryParameter

lang

다국어 설정

false

string

QueryParameter

edit_option

입력란의 수정가능 여부(on:수정가능)(미지정 시 기본값: "on")

false

string

QueryParameter

bg_color

배경색 지정 (HEX 색상코드)

false

string

QueryParameter

txt_color

글자색 지정 (HEX 색상코드)

false

string

QueryParameter

btn1_color

확인버튼색 지정 (HEX 색상코드)

false

string

QueryParameter

btn2_color

취소버튼색 지정 (HEX 색상코드)

false

string

QueryParameter

account_hold_auth_yn

계좌소유인증 사용여부

false

string

Responses
HTTP Code Description Schema

200

OK

RES oauth/2.0/authorize

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.4.2-1. 사용자 토큰발급(3-legged)

POST oauth/2.0/token
Description

사용자인증 API를 통하여 Authorization Code를 획득(사용자의 동의를 받았다는 의미)한 이후에 이 code값을 이용하여 토큰을 발급받는 API입니다. 3-legged 인증이 아닌 2-legged, 갱신(refresh)의 경우는 호출 scheme이 다소 상이합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

code

사용자인증 성공 후 획득한 Authorization Code

true

string

QueryParameter

client_id

오픈뱅킹에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

client_secret

오픈뱅킹에서 발급한 이용기관 앱의 Client Secret

true

string

QueryParameter

redirect_uri

Access Token을 전달받을 Callback URL

true

string

QueryParameter

grant_type

3-legged 인증을 위한 권한부여 방식 지정

true

string

authorization_code

Responses
HTTP Code Description Schema

200

OK

RES oauth/2.0/token(3-legged)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.4.2-2. 이용기관 토큰발급(2-legged)

POST oauth/2.0/token
Description

사용자의 개입이 없는 2-legged 인증의 경우에는 scope=oob로 정의되며, 사용자인증 API의 호출 없이 바로 /token API를 호출하여 토큰을 획득한다.

Parameters
Type Name Description Required Schema Default

QueryParameter

client_id

오픈뱅킹에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

client_secret

오픈뱅킹에서 발급한 이용기관 앱의 Client Secret

true

string

QueryParameter

scope

Access Token 권한 범위

true

string

oob

QueryParameter

grant_type

2-legged 인증을 위한 권한부여 방식 지정

true

string

client_credentials

Responses
HTTP Code Description Schema

200

OK

RES oauth/2.0/token(2-legged)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.4.2-3. 자체인증 이용기관 토큰발급(2-legged)

POST oauth/2.0/token
Description

자체인증 이용기관 2-legged 인증의 경우에는 scope=sa로 정의되며, 사용자인증 API의 호출 없이 바로 /token API를 호출하여 토큰을 획득한다.

Parameters
Type Name Description Required Schema Default

QueryParameter

client_id

오픈뱅킹에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

client_secret

오픈뱅킹에서 발급한 이용기관 앱의 Client Secret

true

string

QueryParameter

scope

Access Token 권한 범위

true

string

sa

QueryParameter

grant_type

2-legged 인증을 위한 권한부여 방식 지정

true

string

client_credentials

Responses
HTTP Code Description Schema

200

OK

RES oauth/2.0/token(2-legged)(자체인증)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.4.2-4. 사용자 토큰갱신(Refresh Token 사용)

POST oauth/2.0/token
Description

Access Token 발급 시 함께 받았던 Refresh Token을 사용하여 토큰의 유효기간을 갱신한다.

Parameters
Type Name Description Required Schema Default

QueryParameter

client_id

오픈뱅킹에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

client_secret

오픈뱅킹에서 발급한 이용기관 앱의 Client Secret

true

string

QueryParameter

refresh_token

토큰발급 시 받은 Access Token 갱신용 토큰

true

string

QueryParameter

scope

Access Token 권한 범위

true

string

QueryParameter

grant_type

토큰 갱신을 위한 권한부여 방식 지정

true

string

Responses
HTTP Code Description Schema

200

OK

RES oauth/2.0/token(RefreshToken)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.4.3. 계좌등록확인

GET oauth/2.0/authorize_account
Description

사용자인증을 통하여 이미 등록된 계좌에 대해서 재확인 및 출금 재동의/금융정보 제3자제공 재동의를 하고 접속토큰을 재발급 받는 API이며, 상황에 따라 3가지 호출 scheme을 제공합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

response_type

OAuth 2.0 인증 요청 시 반환되는 형태

true

string

code

QueryParameter

client_id

오픈뱅킹에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

redirect_uri

사용자인증이 성공하면 이용기관으로 연결되는 URL

true

string

QueryParameter

scope

Access Token 권한 범위(다중 scope 가능)

true

string

QueryParameter

client_info

이용기관이 셋팅하는 임의의 정보

false

string

QueryParameter

state

CSRF 보안위협에 대응하기 위해 이용기관이 셋팅하는 난수값

true

string

QueryParameter

auth_type

사용자인증타입 구분(0:최초인증, 1:재인증, 2:인증생략)

true

string

QueryParameter

lang

다국어 설정

false

string

QueryParameter

edit_option

입력란의 수정가능 여부(on:수정가능)(미지정 시 기본값: "on")

false

string

QueryParameter

bg_color

배경색 지정 (HEX 색상코드)

false

string

QueryParameter

txt_color

글자색 지정 (HEX 색상코드)

false

string

QueryParameter

btn1_color

확인버튼색 지정 (HEX 색상코드)

false

string

QueryParameter

btn2_color

취소버튼색 지정 (HEX 색상코드)

false

string

Responses
HTTP Code Description Schema

200

OK

RES oauth/2.0/authorize_account

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

Insert title here

2.5. /transfer

이체

2.5.1. 출금이체(핀테크번호)

POST /v2.0/transfer/withdraw/fin_num
Description

이용기관이 등록된 한 개의 사용자 계좌로부터 대금을 출금합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

cntr_account_type

약정 계좌/계정 구분(N:계좌, C:계정)

true

string

QueryParameter

cntr_account_num

약정 계좌/계정 번호

true

string

QueryParameter

dps_print_content

입금계좌인자내역

true

string

QueryParameter

fintech_use_num

출금계좌핀테크이용번호

true

string

QueryParameter

wd_print_content

출금계좌인자내역

false

string

QueryParameter

tran_amt

거래금액

true

string

QueryParameter

tran_dtime

요청일시

true

string

QueryParameter

req_client_name

요청고객성명

true

string

QueryParameter

req_client_bank_code

요청고객계좌 개설기관.표준코드

false

string

QueryParameter

req_client_account_num

요청고객계좌번호

false

string

QueryParameter

req_client_fintech_use_num

요청고객핀테크이용번호

false

string

QueryParameter

req_client_num

요청고객회원번호

true

string

QueryParameter

transfer_purpose

이체용도(TR:송금, ST:결제, RC:충전Z)

true

string

QueryParameter

sub_frnc_name

하위가맹점명

false

string

QueryParameter

sub_frnc_num

하위가맹점번호

false

string

QueryParameter

sub_frnc_business_num

하위가맹점 사업자등록번호

false

string

QueryParameter

recv_client_name

최종수취고객성명

false

string

QueryParameter

recv_client_bank_code

최종수취고객계좌 개설기관.표준코드

false

string

QueryParameter

recv_client_account_num

최종수취고객계좌번호

false

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/transfer/withdraw/fin_num

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.5.2. 출금이체(계좌번호)

POST /v2.0/transfer/withdraw/acnt_num
Description

이용기관이 등록된 한 개의 사용자 계좌로부터 대금을 출금합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

cntr_account_type

약정 계좌/계정 구분(N:계좌, C:계정)

true

string

QueryParameter

cntr_account_num

약정 계좌/계정 번호

true

string

QueryParameter

dps_print_content

입금계좌인자내역

true

string

QueryParameter

wd_bank_code_std

출금은행.표준코드

true

string

QueryParameter

wd_account_num

출금계좌번호

true

string

QueryParameter

wd_print_content

출금계좌인자내역

false

string

QueryParameter

tran_amt

거래금액

true

string

QueryParameter

user_seq_no

사용자일련번호

true

string

QueryParameter

tran_dtime

요청일시

true

string

QueryParameter

req_client_name

요청고객성명

true

string

QueryParameter

req_client_bank_code

요청고객계좌 개설기관.표준코드

false

string

QueryParameter

req_client_account_num

요청고객계좌번호

false

string

QueryParameter

req_client_fintech_use_num

요청고객핀테크이용번호

false

string

QueryParameter

req_client_num

요청고객회원번호

true

string

QueryParameter

transfer_purpose

이체용도(TR:송금, ST:결제, RC:충전Z)

true

string

QueryParameter

sub_frnc_name

하위가맹점명

false

string

QueryParameter

sub_frnc_num

하위가맹점번호

false

string

QueryParameter

sub_frnc_business_num

하위가맹점 사업자등록번호

false

string

QueryParameter

recv_client_name

최종수취고객성명

false

string

QueryParameter

recv_client_bank_code

최종수취고객계좌 개설기관.표준코드

false

string

QueryParameter

recv_client_account_num

최종수취고객계좌번호

false

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/transfer/withdraw/acnt_num

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.5.3. 입금이체(핀테크번호)

POST /v2.0/transfer/deposit/fin_num
Description

이용기관이 복수개의 계좌로 대금을 송금합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

cntr_account_type

약정 계좌/계정 구분(N:계좌, C:계정)

true

string

QueryParameter

cntr_account_num

약정 계좌/계정 번호

true

string

QueryParameter

wd_pass_phrase

입금이체용 암호문구

true

string

QueryParameter

wd_print_content

출금계좌인자내역

true

string

QueryParameter

name_check_option

수취인성명 검증 여부(on:검증함)

true

string

on

QueryParameter

sub_frnc_name

하위가맹점명

false

string

QueryParameter

sub_frnc_num

하위가맹점번호

false

string

QueryParameter

sub_frnc_business_num

하위가맹점 사업자등록번호

false

string

QueryParameter

tran_dtime

요청일시

true

string

QueryParameter

req_cnt

입금요청건수

true

string

QueryParameter

REQ_LIST v2.0/transfer/deposit/fin_num

입금요청목록

true

array

Responses
HTTP Code Description Schema

200

OK

RES v2.0/transfer/deposit/fin_num

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.5.4. 입금이체(계좌번호)

POST /v2.0/transfer/deposit/acnt_num
Description

이용기관이 복수개의 계좌로 대금을 송금합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

cntr_account_type

약정 계좌/계정 구분(N:계좌, C:계정)

true

string

QueryParameter

cntr_account_num

약정 계좌/계정 번호

true

string

QueryParameter

wd_pass_phrase

입금이체용 암호문구

true

string

QueryParameter

wd_print_content

출금계좌인자내역

true

string

QueryParameter

name_check_option

수취인성명 검증 여부(on:검증함)

true

string

on

QueryParameter

sub_frnc_name

하위가맹점명

false

string

QueryParameter

sub_frnc_num

하위가맹점번호

false

string

QueryParameter

sub_frnc_business_num

하위가맹점 사업자등록번호

false

string

QueryParameter

tran_dtime

요청일시

true

string

QueryParameter

req_cnt

입금요청건수

true

string

QueryParameter

REQ_LIST v2.0/transfer/deposit/acnt_num

입금요청목록

true

array

Responses
HTTP Code Description Schema

200

OK

RES v2.0/transfer/deposit/acnt_num

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.5.5. 이체결과조회

POST /v2.0/transfer/result
Description

이용기관이 출금이체 혹은 입금이체 후 이체결과를 다시 확인합니다. 이체 시 비정상적인 응답코드를 받았을 경우나 응답을 받지 못했을 경우 등 이체결과 확인이 필요한 경우 사용하는 용도입니다. 단, 1개월 이내의 이체 건에 대해서만 확인이 가능합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

check_type

1:출금이체, 2:입금이체

true

string

QueryParameter

tran_dtime

요청일시

true

string

QueryParameter

req_cnt

요청건수

true

string

QueryParameter

REQ_LIST v2.0/transfer/result

요청목록

true

array

Responses
HTTP Code Description Schema

200

OK

RES v2.0/transfer/result

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

Insert title here

2.6. /user

사용자

2.6.1. 사용자정보조회

GET v2.0/user/me
Description

사용자의 고객정보 및 계좌목록을 조회합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

user_seq_no

사용자일련번호

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/user/me

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.6.2. 사용자로그인연결동의해제

POST v2.0/user/unlink
Description

이용기관과 사용자 간의 연결을 해제합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

client_use_code

이용기관코드

true

string

QueryParameter

user_seq_no

사용자일련번호

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/user/unlink

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.6.3. 사용자탈퇴

POST v2.0/user/close
Description

이용기관에 등록된 모든 계좌를 해지(등록해지 및 동의해지)하고 오픈뱅킹에 등록된 사용자를 탈퇴합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

client_use_code

이용기관코드

true

string

QueryParameter

user_seq_no

사용자일련번호

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/user/close

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.6.4. 사용자계좌등록

POST v2.0/user/register
Description

자체인증 이용기관이 사용자의 계좌를 등록합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

bank_code_std

등록계좌개설기관.표준코드

true

string

QueryParameter

register_account_num

등록계좌번호

true

string

QueryParameter

user_info

생년월일 (8자리) (주민등록번호 등록 기준)

true

string

QueryParameter

user_name

사용자명

true

string

QueryParameter

user_ci

CI(Connect Info)

true

string

QueryParameter

user_email

이메일주소

false

string

QueryParameter

scope

서비스구분(inquiry : 조회서비스, transfer : 출금서비스)

true

string

QueryParameter

info_prvd_agmt_yn

제3자정보제공동의여부

false

string

QueryParameter

wd_agmt_yn

출금동의여부

false

string

QueryParameter

agmt_data_type

동의자료 구분 (1:서면, 2:공인인증, 3: 일반인증4:녹취, 5:ARS, 6:기타)

false

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/user/register

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

Insert title here

2.7. /return

자금반환

2.7.1. 자금반환 청구

POST v2.0/return/claim
Description

완료된 입금이체에 대해 자금반환을 청구합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

bank_tran_id

은행거래고유번호

true

string

QueryParameter

org_bank_tran_date

원거래 거래일자

true

string

QueryParameter

org_bank_tran_id

원거래 거래고유번호

true

string

QueryParameter

org_dps_bank_code_std

원거래 입금기관.표준코드

false

string

QueryParameter

org_dps_account_num

원거래 입금계좌번호

false

string

QueryParameter

org_dps_fintech_use_num

원거래 입금핀테크이용번호

false

string

QueryParameter

org_tran_amt

거래금액(청구금액)

true

string

QueryParameter

org_wd_bank_code_std

원거래 출금기관.표준코드

true

string

QueryParameter

claim_code

청구사유코드

true

string

QueryParameter

claim_message

청구사유

false

string

QueryParameter

total_return_yn

전액반환여부

true

string

QueryParameter

return_account_num

반환금액 입금계좌

true

string

QueryParameter

use_org_contact

이용기관 담당자 연락처

true

string

QueryParameter

use_org_email

이용기관 담당자 이메일주소

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/return/claim

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.7.2. 자금반환 결과조회

POST v2.0/return/result
Description

자금반환 요청 후 자금반환 결과를 확인합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

claim_bank_tran_date

청구 요청 거래일자

true

string

QueryParameter

claim_bank_tran_id

청구 요청 거래고유번호

true

string

Responses
HTTP Code Description Schema

200

OK

RES v2.0/return/result

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

3. Security

Insert title here

3.1. apiKey

Type : apiKey
Name : api_key
In : HEADER

3.2. 기관인증

Type : oauth2
Flow : application
Token URL : https://openapi.openbanking.or.kr/oauth/2.0/token

Name Description

oob

참가은행상태조회, 계좌실명조회 ,송금인정보조회 , 입금이체(핀테크), 입금이체(계좌), 이체결과조회

3.3. 사용자인증

Name Description

transfer

출금이체(핀테크)

inquiry

잔액조회(핀테크), 거래내역조회(핀테크)

login

계좌해지, 등록계좌조회, 계좌정보변경, 사용자정보조회, 사용자로그인연결동의해제, 사용자탈퇴

3.4. 자체인증

Type : oauth2
Flow : application
Token URL : https://openapi.openbanking.or.kr/oauth/2.0/token

Name Description

sa

잔액조회(핀테크), 잔액조회(계좌), 계좌해지, 등록계좌조회 ,거래내역조회(핀테크), 거래내역조회(계좌), 참가은행상태조회, 계좌실명조회 , 송금인정보조회, 출금이체(핀테크), 출금이체(계좌), 입금이체(핀테크), 입금이체(계좌), 이체결과조회, 사용자정보조회, 사용자탈퇴, 사용자계좌등록

4. Definitions

Insert title here

4.1.1. RES v2.0/account/balance/fin_num

잔액조회(핀테크번호) 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

fintech_use_num

핀테크이용번호

true

string

balance_amt

계좌잔액(-금액가능)

true

string

available_amt

출금가능금액

true

string

account_type

계좌종류(1:수시입출금, 2:예적금, 6:수익증권)

true

string

product_name

상품명

true

string

4.1.2. RES v2.0/account/balance/acnt_num

잔액조회(계좌번호) 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

account_num

계좌번호

true

string

balance_amt

계좌잔액(-금액가능)

true

string

available_amt

출금가능금액

true

string

account_type

계좌종류(1:수시입출금, 2:예적금, 6:수익증권)

true

string

product_name

상품명

true

string

4.1.3. RES v2.0/account/cancel

계좌해지 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

4.1.4. RES v2.0/account/list

등록계좌조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

user_name

사용자명

true

string

res_cnt

사용자 등록계좌 개수

true

string

res_list

사용자 등록계좌 목록

true

RES.LIST v2.0/account/list
array

4.1.4-2. RES.LIST v2.0/account/list

등록계좌조회 응답 리스트 요소

Name Description Required Schema Default

fintech_use_num

핀테크이용번호

true

string

account_alias

계좌별명(Alias)

true

string

bank_code_std

출금(개설)기관.대표코드

true

string

bank_code_sub

출금(개설)기관.점별코드

true

string

bank_name

출금(개설)기관명

true

string

account_num(선택)

계좌번호

true

string

account_num_masked

마스킹된 출력용 계좌번호

true

string

account_holder_name

계좌예금주명

true

string

account_type

계좌구분(P:개인)

true

string

inquiry_agree_yn

조회서비스 동의여부

true

string

inquiry_agree_dtime

조회서비스 동의일시

true

string

transfer_agree_yn

출금서비스 동의여부

true

string

transfer_agree_dtime

출금서비스 동의일시

true

string

account_state

계좌상태(01:사용, 09:해지)

true

string

4.1.5-1. RES v2.0/account/transaction_list/fin_num

거래내역조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

fintech_use_num

핀테크이용번호

true

string

balance_amt

계좌잔액(-금액가능)

true

string

page_record_cnt

현재페이지 레코드건수

true

string

next_page_yn

다음페이지 존재여부

true

string

befor_inquiry_trace_info

직전조회추적정보

true

string

res_list

조회된 거래내역

true

RES.LIST v2.0/account/transaction_list/fin_num
array

4.1.5-2. RES.LIST v2.0/account/transaction_list/fin_num

거래내역조회 응답 리스트 요소

Name Description Required Schema Default

tran_date

거래일자

true

string

tran_time

거래시간

true

string

inout_type

입출금구분(입금, 출금, 지급, 기타)

true

string

tran_type

거래구분

true

string

print_content

통장인자내용

true

string

tran_amt

거래금액

true

string

after_balance_amt

거래후잔액(-금액가능)

true

string

branch_name

거래점명

true

string

4.1.6-1. RES v2.0/account/transaction_list/acnt_num

거래내역조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

account_num

계좌번호

true

string

balance_amt

계좌잔액(-금액가능)

true

string

page_record_cnt

현재페이지 레코드건수

true

string

next_page_yn

다음페이지 존재여부

true

string

befor_inquiry_trace_info

직전조회추적정보

true

string

res_list

조회된 거래내역

true

RES.LIST v2.0/account/transaction_list/acnt_num
array

4.1.6-2. RES.LIST v2.0/account/transaction_list/acnt_num

거래내역조회 응답 리스트 요소

Name Description Required Schema Default

tran_date

거래일자

true

string

tran_time

거래시간

true

string

inout_type

입출금구분(입금, 출금, 지급, 기타)

true

string

tran_type

거래구분

true

string

print_content

통장인자내용

true

string

tran_amt

거래금액

true

string

after_balance_amt

거래후잔액(-금액가능)

true

string

branch_name

거래점명

true

string

4.1.7. RES v2.0/account/update_info

계좌정보변경 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

fintech_use_num

핀테크이용번호

true

string

account_alias

변경된 계좌별명

true

string

Insert title here

4.2.1. RES v2.0/bank/status

참가은행상태조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

res_cnt

참가은행개수

true

string

res_list

참가은행 목록

true

RES.LIST v2.0/bank/status
array

4.2.1-2. RES.LIST v2.0/bank/status

참가은행 상태조회 응답 리스트 요소

Name Description Required Schema Default

bank_code_std

참가은행.표준코드

true

string

bank_name

참가은행명

true

string

bank_status

참가은행상태(Y:거래가능, D:장애,L:개시이전, F:종료예고상태,A:집계상태, E:종료)

true

string

Insert title here

4.3.1. RES v2.0/inquiry/real_name

계좌실명조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

bank_code_std

개설기관.표준코드

true

string

bank_code_sub

개설기관.점별코드

true

string

bank_name

개설기관명

true

string

account_num

계좌번호

true

string

account_holder_info_type

예금주 실명번호 구분코드

true

string

account_holder_info

예금주 실명번호

true

string

account_holder_name

예금주성명

true

string

account_type

계좌종류(1:수시입출금, 2:예적금, 6:수익증권)

true

string

4.3.2-1. RES v2.0/inquiry/remit_list

송금인정보조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

bank_code_std

조회된 이용기관수취계좌의 개설기관.표준코드

true

string

account_num

조회된 이용기관수취계좌의 계좌번호

true

string

balance_amt

계좌잔액(-금액가능)

true

string

total_record_cnt

총 조회건수

true

string

page_record_cnt

현재페이지 레코드건수

true

string

next_page_yn

다음페이지 존재여부

true

string

befor_inquiry_trace_info

직전조회 추적정보

true

string

res_list

조회된 송금내역

true

RES.LIST v2.0/inquiry/remit_list
array

4.3.2-2. RES.LIST v2.0/inquiry/remit_list

송급인정보조회 응답 리스트 요소

Name Description Required Schema Default

tran_date

거래일자

true

string

tran_time

거래시간

true

string

tran_type

거래구분

true

string

print_content

통장인자내용

true

string

tran_amt

거래금액

true

string

after_balance_amt

거래 후 잔액(-금액가능)

true

string

branch_name

거래점명

true

string

remitter_name

계좌예금주명

true

string

remitter_bank_code

송금한 계좌의 은행코드

true

string

remitter_account_num

송금한 계좌번호

true

string

4.3.3. RES v2.0/inquiry/receive

수취조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

bank_code_std

입금기관.표준코드

true

string

bank_code_sub

입금기관.점별코드

true

string

bank_name

입금기관명

true

string

account_num

입금계좌번호

true

string

account_num_masked

입금계좌번호(출력용)

true

string

print_content

입금계좌인자내역

true

string

account_holder_name

수취인성명

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

wd_bank_code_std

출금(개설)기관.표준코드

true

string

wd_bank_name

출금(개설)기관명

true

string

wd_account_num

출금계좌번호

true

string

tran_amt

거래금액

true

string

cms_num

CMS 번호

true

string

4.3.3-1. RES v2.0/inquiry/fds_detect

이상금융거래 탐지내역 조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

cnt_exceed_yn

탐지내역 건수 초과여부

true

string

res_cnt

이상금융거래 탐지 건수

true

string

res_list

탐지 목록

true

RES.LIST v2.0/inquiry/fds_detect
array

4.3.3-2. RES.LIST v2.0/inquiry/fds_detect

이상금융거래 탐지내역 조회 응답 리스트 요소

Name Description Required Schema Default

detect_time

탐지 시간

true

string

policy_rule

이상금융거래 탐지 정책룰

true

string

user_seq_no

사용자일련번호

true

string

bank_code

참가은행.표준코드

true

string

account_num

계좌번호

true

string

fintech_use_num

핀테크이용번호

true

string

tran_amt

거래금액

true

string

Insert title here

4.4.1. RES oauth/2.0/authorize

사용자인증 응답

Name Description Required Schema Default

code

사용자인증 성공 시 반환되는 코드

true

string

scope

Access Token 권한 범위 (다중 scope 가능)

true

string

client_info

요청 시 이용기관이 셋팅한 client_info 값을 그대로 전달

true

string

state

요청 시 이용기관이 셋팅한 state 값을 그대로 전달

true

string

4.4.2-1. RES oauth/2.0/token(3-legged)

사용자 토큰발급 응답

Name Description Required Schema Default

access_token

오픈뱅킹에서 발행된 Access Token

true

string

token_type

Access Token 유형

true

string

Bearer

expires_in

Access Token 만료 기간(초)

true

string

refresh_token

Access Token 갱신 시 사용하는 Refresh Token

true

string

scope

Access Token 권한 범위(사용자인증 시 요청했던 권한 범위와 동일)

true

string

user_seq_no

사용자일련번호

true

string

4.4.2-2. RES oauth/2.0/token(2-legged)

이용기관 토큰발급 응답

Name Description Required Schema Default

access_token

오픈뱅킹에서 발행된 Access Token

true

string

token_type

Access Token 유형

true

string

Bearer

expires_in

Access Token 만료 기간(초)

true

string

scope

Access Token 권한 범위

true

string

oob

client_use_code

이용기관코드

true

string

4.4.2-3. RES oauth/2.0/token(2-legged)(자체인증)

자체인증 이용기관 토큰발급 응답

Name Description Required Schema Default

access_token

오픈뱅킹에서 발행된 Access Token

true

string

token_type

Access Token 유형

true

string

Bearer

expires_in

Access Token 만료 기간(초)

true

string

scope

Access Token 권한 범위

true

string

sa

client_use_code

이용기관코드

true

string

4.4.2-4. RES oauth/2.0/token(RefreshToken)

사용자 토큰갱신 응답

Name Description Required Schema Default

access_token

오픈뱅킹에서 발행된 Access Token

true

string

token_type

Access Token 유형

true

string

Bearer

expires_in

Access Token 만료 기간(초)

true

string

refresh_token

Access Token 갱신 시 사용하는 Refresh Token

true

string

scope

Access Token 권한 범위

true

string

user_seq_no

사용자일련번호

true

string

4.4.3. RES oauth/2.0/authorize_account

계좌등록확인 응답

Name Description Required Schema Default

code

사용자인증 성공 시 반환되는 코드

true

string

scope

Access Token 권한 범위 (다중 scope 가능)

true

string

client_info

요청 시 이용기관이 셋팅한 client_info 값을 그대로 전달

true

string

state

요청 시 이용기관이 셋팅한 state 값을 그대로 전달

true

string

Insert title here

4.5.1. RES v2.0/transfer/withdraw/fin_num

출금이체(핀테크번호) 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

dps_bank_code_std

입금기관.표준코드

true

string

dps_bank_code_sub

입금기관.점별코드

true

string

dps_bank_name

입금기관명

true

string

dps_account_num_masked

입금계좌번호(출력용)

true

string

dps_print_content

입금계좌인자내역

true

string

dps_account_holder_name

수취인성명

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

fintech_use_num

출금계좌핀테크이용번호

true

string

account_alias

출금계좌별명(Alias)

true

string

bank_code_std

출금(개설)기관.표준코드

true

string

bank_code_sub

출금(개설)기관.점별코드

true

string

bank_name

출금(개설)기관명

true

string

account_num_masked

출금계좌번호(출력용)

true

string

print_content

출금계좌인자내역

true

string

account_holder_name

송금인성명

true

string

tran_amt

거래금액

true

string

wd_limit_remain_amt

출금한도잔여금액

true

string

4.5.2. RES v2.0/transfer/withdraw/acnt_num

출금이체(계좌번호) 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

dps_bank_code_std

입금기관.표준코드

true

string

dps_bank_code_sub

입금기관.점별코드

true

string

dps_bank_name

입금기관명

true

string

dps_account_num_masked

입금계좌번호(출력용)

true

string

dps_print_content

입금계좌인자내역

true

string

dps_account_holder_name

수취인성명

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

account_num

출금계좌번호

true

string

account_alias

출금계좌별명(Alias)

true

string

bank_code_std

출금(개설)기관.표준코드

true

string

bank_code_sub

출금(개설)기관.점별코드

true

string

bank_name

출금(개설)기관명

true

string

account_num_masked

출금계좌번호(출력용)

true

string

print_content

출금계좌인자내역

true

string

account_holder_name

송금인성명

true

string

tran_amt

거래금액

true

string

wd_limit_remain_amt

출금한도잔여금액

true

string

4.5.3-1. REQ_LIST v2.0/transfer/deposit/fin_num

입금이체(핀테크번호) 요청

Name Description Required Schema Default

tran_no

거래순번

true

string

bank_tran_id

은행거래고유번호

true

string

fintech_use_num

핀테크이용번호

true

string

print_content

입금계좌인자내역

true

string

tran_amt

거래금액

true

string

req_client_name

요청고객성명

true

string

req_client_bank_code

요청고객계좌 개설기관.표준코드

false

string

req_client_account_num

요청고객계좌번호

false

string

req_client_fintech_use_num

요청고객핀테크이용번호

false

string

req_client_num

요청고객회원번호

true

string

transfer_purpose

이체용도(TR:송금, ST:결제, AU:인증)

true

string

4.5.3-2. RES v2.0/transfer/deposit/fin_num

입금이체(핀테크번호) 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

wd_bank_code_std

출금기관.표준코드

true

string

wd_bank_code_sub

출금기관.점별코드

true

string

wd_bank_name

출금기관명

true

string

wd_account_num_masked

출금계좌번호(출력용)

true

string

wd_print_content

출금계좌인자내역

true

string

wd_account_holder_name

송금인성명

true

string

res_cnt

입금건수

true

string

RES_LIST v2.0/transfer/deposit/fin_num

입금목록

true

array

4.5.3-3. RES_LIST v2.0/transfer/deposit/fin_num

입금이체(핀테크번호) 응답

Name Description Required Schema Default

tran_no

거래순번

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

fintech_use_num

핀테크이용번호

true

string

account_alias

계좌별명(Alias)

true

string

bank_code_std

입금(개설)기관.표준코드

true

string

bank_code_sub

입금(개설)기관.점별코드

true

string

bank_name

입금(개설)기관명

true

string

account_num_masked

입금계좌번호(출력용)

true

string

print_content

입금계좌인자내역

true

string

account_holder_name

수취인성명

true

string

tran_amt

거래금액

true

string

4.5.4-1. REQ_LIST v2.0/transfer/deposit/acnt_num

입금이체(계좌번호) 요청

Name Description Required Schema Default

tran_no

거래순번

true

string

bank_tran_id

은행거래고유번호

true

string

bank_code_std

입금은행.표준코드

true

string

account_num

계좌번호

true

string

account_holder_name

입금계좌예금주명

true

string

print_content

입금계좌인자내역

true

string

tran_amt

거래금액

true

string

req_client_name

요청고객성명

true

string

req_client_bank_code

요청고객계좌 개설기관.표준코드

false

string

req_client_account_num

요청고객계좌번호

false

string

req_client_fintech_use_num

요청고객핀테크이용번호

false

string

req_client_num

요청고객회원번호

true

string

transfer_purpose

이체용도(TR:송금, ST:결제, AU:인증)

true

string

4.5.4-2. RES v2.0/transfer/deposit/acnt_num

입금이체(계좌번호) 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

wd_bank_code_std

출금기관.표준코드

true

string

wd_bank_code_sub

출금기관.점별코드

true

string

wd_bank_name

출금기관명

true

string

wd_account_num_masked

출금계좌번호(출력용)

true

string

wd_print_content

출금계좌인자내역

true

string

wd_account_holder_name

송금인성명

true

string

res_cnt

입금건수

true

string

RES_LIST v2.0/transfer/deposit/acnt_num

입금목록

true

array

4.5.4-3. RES_LIST v2.0/transfer/deposit/acnt_num

입금이체(계좌번호) 응답

Name Description Required Schema Default

tran_no

거래순번

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

bank_code_std

입금(개설)기관.표준코드

true

string

bank_code_sub

입금(개설)기관.점별코드

true

string

bank_name

입금(개설)기관명

true

string

account_num

입금계좌번호

true

string

account_num_masked

입금계좌번호(출력용)

true

string

print_content

입금계좌인자내역

true

string

account_holder_name

수취인성명

true

string

tran_amt

거래금액

true

string

4.5.5-1. REQ_LIST v2.0/transfer/result

이체결과조회 요청

Name Description Required Schema Default

tran_no

거래순번

true

string

org_bank_tran_id

원거래 거래고유번호(참가은행)

true

string

org_bank_tran_date

원거래 거래일자(참가은행)

true

string

org_tran_amt

원거래 거래금액

true

string

4.5.5-2. RES v2.0/transfer/result

이체결과조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

res_cnt

이체건수

true

string

RES_LIST v2.0/transfer/result

이체목록

true

array

4.5.5-3. RES_LIST v2.0/transfer/result

이체결과조회 응답

Name Description Required Schema Default

tran_no

거래순번

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

wd_bank_code_std

출금기관.표준코드

true

string

wd_bank_code_sub

출금기관.점별코드

true

string

wd_bank_name

출금기관명

true

string

wd_fintech_use_num

출금계좌 핀테크이용번호

true

string

wd_account_num_masked

출금계좌번호(출력용)

true

string

wd_print_content

출금계좌인자내역

true

string

wd_account_holder_name

송금인성명

true

string

dps_bank_code_std

입금(개설)기관.표준코드

true

string

dps_bank_code_sub

입금(개설)기관.점별코드

true

string

dps_bank_name

입금(개설)기관명

true

string

dps_fintech_use_num

입금계좌 핀테크이용번호

true

string

dps_account_num_masked

입금계좌번호(출력용)

true

string

dps_print_content

입금계좌인자내역

true

string

dps_account_holder_name

수취인성명

true

string

tran_amt

거래금액

true

string

Insert title here

4.6.1. RES v2.0/user/me

사용자정보조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

user_seq_no

사용자일련번호

true

string

user_ci

CI(Connect Info)

true

string

user_name

고객명

true

string

user_info

생년월일

true

string

user_gender

성별

true

string

user_cell_no

휴대폰번호

true

string

user_email

이메일주소

true

string

res_cnt

등록된 계좌 개수

true

string

res_list

등록된 계좌 목록

true

RES.LIST v2.0/user/me
array

4.6.1-2. RES.LIST v2.0/user/me

사용자정보조회 응답 리스트 요소

Name Description Required Schema Default

fintech_use_num

핀테크이용번호

true

string

account_alias

계좌별명(Alias)

true

string

bank_code_std

출금(개설)기관.대표코드

true

string

bank_code_sub

출금(개설)기관.점별코드

true

string

bank_name

출금(개설)기관명

true

string

account_num(선택)

계좌번호

true

string

account_num_masked

마스킹된 출력용 계좌번호

true

string

account_holder_name

계좌예금주명

true

string

account_type

계좌구분(P:개인)

true

string

inquiry_agree_yn

조회서비스 동의여부

true

string

inquiry_agree_dtime

조회서비스 동의일시

true

string

transfer_agree_yn

출금서비스 동의여부

true

string

transfer_agree_dtime

출금서비스 동의일시

true

string

payer_num

납부자번호

true

string

사용자로그인연결동의해제 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

user_seq_no

사용자일련번호

true

string

4.6.3. RES v2.0/user/close

사용자탈퇴 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

4.6.4. RES v2.0/user/register

사용자계좌등록 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

user_seq_no

사용자일련번호

true

string

fintech_use_num

핀테크이용번호

true

string

payer_num

납부자번호

true

string

Insert title here

4.7.1. RES v2.0/return/claim

자금반환 청구 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

dps_bank_code_std

입금기관.표준코드

true

string

bank_tran_id

거래고유번호(참가은행)

true

string

bank_tran_date

거래일자(참가은행)

true

string

bank_code_tran

응답코드를 부여한 참가은행.표준코드

true

string

bank_rsp_code

응답코드(참가은행)

true

string

bank_rsp_message

응답메시지(참가은행)

true

string

wd_bank_code_std

출금(개설)기관.표준코드

true

string

wd_bank_code_sub

출금(개설)기관.점별코드

true

string

wd_bank_name

출금(개설)기관명

true

string

org_bank_tran_date

원거래 거래일자

true

string

org_bank_tran_id

원거래 거래고유번호

true

string

org_dps_bank_code_std

원거래 입금기관.표준코드

true

string

org_dps_account_num

원거래 입금계좌번호

true

string

org_dps_fintech_use_num

원거래 입금핀테크이용번호

true

string

org_tran_amt

원거래 거래금액

true

string

return_account_num

반환금액 입금계좌

true

string

4.7.2. RES v2.0/return/result

자금반환 결과조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

api_tran_dtm

거래일시(밀리세컨드)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

claim_bank_tran_date

청구 요청 거래일자

true

string

claim_bank_tran_id

청구 요청 거래고유번호

true

string

claim_normal_yn

청구 요청 정상여부

true

string

claim_bank_rsp_code

청구 요청 응답코드(참가은행)

true

string

return_yn

자금반환여부

true

string

return_fail_code

자금반환불가사유코드

true

string

return_fail_message

자금반환불가사유

true

string

total_return_yn

전액반환여부

true

string

return_amt

반환금액

true

string

return_date

반환일자

true

string