알림

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

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

마이페이지

1. Overview

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

Terms of service: www.open-platform.or.kr

1.1. URI scheme

Host: testapi.open-platform.or.kr BasePath: / Schemes: HTTPS

1.2. Tags

  • /bank: 참가은행

  • /oauth/2.0: OAuth 2.0

  • /account: 계좌

  • /transfer: 이체

  • /user: 사용자

  • /inquiry: 조회

2. Resources

2.1. /account

계좌

2.1.1. 등록계좌목록조회

GET /account/list
Description

사용자가 하나의 이용기관에 대하여 오픈플랫폼에 등록한 계좌(조회/출금)의 목록을 조회합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

user_seq_no

사용자일련번호

true

string

QueryParameter

include_cancel_yn

해지계좌포함여부

false

string

QueryParameter

sort_order

정렬순서

false

string

Responses
HTTP Code Description Schema

200

OK

RES /account/list

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.2. 거래내역조회

GET /account/transaction_list
Description

사용자 계좌의 거래내역을 조회합니다. (1페이지 최대 25건)

Parameters
Type Name Description Required Schema Default

QueryParameter

fintech_use_num

핀테크이용번호

true

string

QueryParameter

inquiry_type

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

true

string

QueryParameter

from_date

조회시작일자

true

string

QueryParameter

to_date

조회종료일자

true

string

QueryParameter

sort_order

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

true

string

QueryParameter

page_index

페이지번호

true

string

QueryParameter

tran_dtime

요청일시

true

string

QueryParameter

befor_inquiry_trace_info

직전 조회 추적 정보

false

string

QueryParameter

list_tran_seqno

최종 거래내역 순번

false

string

Responses
HTTP Code Description Schema

200

OK

RES /account/transaction_list

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.3. 계좌정보변경

POST /account/update_info
Description

사용자 계좌의 별명을 갱신합니다.

Parameters
Type Name Description Required Schema Default

BodyParameter

params

params

true

REQ /account/update_info

Responses
HTTP Code Description Schema

200

OK

RES /account/update_info

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.4. 계좌해지

POST /account/cancel
Description

사용자 계좌에 연결된 서비스(조회/출금)를 해지합니다.

Parameters
Type Name Description Required Schema Default

BodyParameter

params

params

true

계좌해지 요청

Responses
HTTP Code Description Schema

200

OK

RES /account/cancel

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.1.5. 잔액조회

GET /account/balance
Description

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

Parameters
Type Name Description Required Schema Default

QueryParameter

fintech_use_num

핀테크이용번호

true

string

QueryParameter

tran_dtime

요청일시

true

string

Responses
HTTP Code Description Schema

200

OK

RES /account/balance

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.2. /bank

참가은행

2.2.1. 참가은행상태조회

GET /bank/status
Description

참가은행의 서비스 상태(거래가능, 개시전/종료처리, 장애)를 확인합니다.

Responses
HTTP Code Description Schema

200

OK

RES /bank/status

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.3. /inquiry

조회

2.3.1. 계좌실명조회

POST /inquiry/real_name
Description

특정 계좌번호의 실명 및 예금주 생년월일(혹은 사업자등록번호)이 맞는지 확인합니다.

Parameters
Type Name Description Required Schema Default

BodyParameter

params

params

true

REQ /inquiry/real_name

Responses
HTTP Code Description Schema

200

OK

RES /inquiry/real_name

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.4. /oauth/2.0

OAuth 2.0

2.4.1. 계좌등록확인

GET /oauth/2.0/authorize_account
Description

등록이 완료된 계좌들을 확인하거나 동의를 갱신합니다. (OAuth 2.0 3-legged)

Parameters
Type Name Description Required Schema Default

QueryParameter

response_type

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

true

string

QueryParameter

client_id

오픈플랫폼에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

redirect_uri

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

true

string

QueryParameter

scope

Access Token 권한

true

string

QueryParameter

client_info

이용기관이 셋팅하는 임의의 정보. Callback 호출 시 그대로 전달됨

true

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

2.4.2. AccessToken획득

POST /oauth/2.0/token
Description

Access Token을 획득합니다. (OAuth 2.0 3-legged / 2-legged)

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_uri

true

string

QueryParameter

grant_type

Access Token을 허용하기 위한 값

true

string

Responses
HTTP Code Description Schema

200

OK

RES /oauth/2.0/token

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/x-www-form-urlencoded

Produces
  • application/json

2.4.3. 사용자인증

GET /oauth/2.0/authorize2
Description

인증 절차를 간소화하여 회원가입 및 계좌등록을 한 번에 수행할 수 있도록 만든 API (OAuth 2.0 3-legged)

Parameters
Type Name Description Required Schema Default

QueryParameter

response_type

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

true

string

QueryParameter

client_id

오픈플랫폼에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

redirect_uri

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

true

string

QueryParameter

scope

Access Token 권한

true

string

QueryParameter

client_info

이용기관이 셋팅하는 임의의 정보. Callback 호출 시 그대로 전달됨

true

string

QueryParameter

auth_type

사용자인증 타입 구분

true

string

QueryParameter

bg_color

프로바이더 페이지 배경 색상

true

string

QueryParameter

txt_color

프로바이더 페이지 텍스트 색상

true

string

QueryParameter

btn1_color

프로바이더 페이지 버튼1 색상

true

string

QueryParameter

btn2_color

프로바이더 페이지 버튼2 색상

true

string

Responses
HTTP Code Description Schema

200

OK

RES /oauth/2.0/authorize2

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.4.4. 계좌등록

GET /oauth/2.0/register_account
Description

사용자 로그인 연결이 완료된 이후에 서비스 이용(조회/출금)을 위한 계좌를 등록합니다. (OAuth 2.0 3-legged)

Parameters
Type Name Description Required Schema Default

QueryParameter

response_type

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

true

string

QueryParameter

client_id

오픈플랫폼에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

redirect_uri

Access Token을 전달받을 callback_uri

true

string

QueryParameter

scope

inquiry: 조회서비스용 계좌등록, transfer: 출금서비스용 계좌등록

true

string

QueryParameter

client_info

이용기관이 셋팅하는 임의의 정보. Callback 호출 시 그대로 전달됨

true

string

Responses
HTTP Code Description Schema

200

OK

RES /oauth/2.0/register_account

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.4.5. 계좌등록확인2

GET /oauth/2.0/authorize_account2
Description

개선된 인증절차에 의한 계좌등록확인 API (OAuth 2.0 3-legged)

Parameters
Type Name Description Required Schema Default

QueryParameter

response_type

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

true

string

QueryParameter

client_id

오픈플랫폼에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

redirect_uri

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

true

string

QueryParameter

scope

Access Token 권한

true

string

QueryParameter

client_info

이용기관이 셋팅하는 임의의 정보. Callback 호출 시 그대로 전달됨

true

string

QueryParameter

auth_type

사용자인증 타입 구분

true

string

QueryParameter

bg_color

프로바이더 페이지 배경 색상

true

string

QueryParameter

txt_color

프로바이더 페이지 텍스트 색상

true

string

QueryParameter

btn1_color

프로바이더 페이지 버튼1 색상

true

string

QueryParameter

btn2_color

프로바이더 페이지 버튼2 색상

true

string

Responses
HTTP Code Description Schema

200

OK

RES /oauth/2.0/authorize_account2

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.4.6. 사용자로그인연결

GET /oauth/2.0/authorize
Description

사용자의 로그인 아이디를 이용기관의 앱과 연결합니다. (OAuth 2.0 3-legged)

Parameters
Type Name Description Required Schema Default

QueryParameter

response_type

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

true

string

QueryParameter

client_id

오픈플랫폼에서 발급한 이용기관 앱의 Client ID

true

string

QueryParameter

redirect_uri

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

true

string

QueryParameter

scope

Access Token 권한

true

string

QueryParameter

client_info

이용기관이 셋팅하는 임의의 정보. Callback 호출 시 그대로 전달됨

true

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.5. /transfer

이체

2.5.1. 이체API처리조회

POST /transfer/recheck
Description

입금이체, 출금이체 시 API 호출에 대한 응답을 정상적으로 수신하지 못한 경우에, 다시 API 처리결과를 확인합니다.

Parameters
Type Name Description Required Schema Default

BodyParameter

params

params

true

REQ /transfer/recheck

Responses
HTTP Code Description Schema

200

OK

RES /transfer/recheck

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

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

POST /transfer/deposit2
Description

계좌번호를 지정하여 수취인 계좌로 자금을 입금합니다.

Parameters
Type Name Description Required Schema Default

BodyParameter

params

params

true

REQ /transfer/deposit2

Responses
HTTP Code Description Schema

200

OK

RES /transfer/deposit2

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

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

POST /transfer/deposit
Description

핀테크이용번호를 지정하여 수취인 계좌로 자금을 입금합니다.

Parameters
Type Name Description Required Schema Default

BodyParameter

params

params

true

REQ /transfer/deposit

Responses
HTTP Code Description Schema

200

OK

RES /transfer/deposit

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.5.4. 이체결과조회

POST /transfer/result
Description

출금이체, 입금이체 시 처리결과의 정상여부를 확인하지 못한 거래건의 결과를 다시 확인합니다.

Parameters
Type Name Description Required Schema Default

BodyParameter

params

params

true

REQ /transfer/result

Responses
HTTP Code Description Schema

200

OK

RES /transfer/result

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.5.5. 출금이체

POST /transfer/withdraw
Description

사용자가 출금등록한 계좌로부터 자금을 실시간 출금합니다.

Parameters
Type Name Description Required Schema Default

BodyParameter

params

params

true

REQ /transfer/withdraw

Responses
HTTP Code Description Schema

200

OK

RES /transfer/withdraw

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.6. /user

사용자

2.6.1. 사용자로그인연결해제

POST /user/unlink
Description

로그인 연결된 사용자의 아이디를 해당 이용기관으로부터 연결 해제합니다.

Parameters
Type Name Description Required Schema Default

BodyParameter

params

params

true

REQ /user/unlink

Responses
HTTP Code Description Schema

200

OK

RES /user/unlink

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

2.6.2. 사용자정보조회

GET /user/me
Description

로그인 연결된 사용자의 정보를 조회합니다.

Parameters
Type Name Description Required Schema Default

QueryParameter

user_seq_no

사용자일련번호

true

string

Responses
HTTP Code Description Schema

200

OK

RES /user/me

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

3. Security

3.1. apiKey

Type : apiKey
Name : api_key
In : HEADER

3.2. 기관인증

Type : oauth2
Flow : application
Token URL : https://testapi.open-platform.or.kr/oauth/2.0/token

Name Description

oob

입금이체,이체결과조회,계좌실명조회,참가기관상태조회

3.3. 사용자인증

Name Description

transfer

출금이체,계좌변경,계좌해지

inquiry

잔액조회,거래내역조회,계좌변경,계좌해지

login

사용자인증,계좌등록

4. Definitions

4.1. REQ /account/update_info

계좌정보변경 요청

Name Description Required Schema Default

fintech_use_num

핀테크이용번호

true

string

account_alias

변경코자하는 계좌별명

true

string

4.2. REQ /inquiry/real_name

계좌실명조회 요청

Name Description Required Schema Default

bank_code_std

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

true

string

account_num

계좌번호

true

string

account_holder_info

예금주 인증정보

true

string

tran_dtime

요청일시

true

string

4.3. REQ /transfer/deposit

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

Name Description Required Schema Default

wd_pass_phrase

이용기관 입금이체용 암호문구

true

string

wd_print_content

출금계좌인자내역

true

string

tran_dtime

요청일시

true

string

req_cnt

입금요청건수

true

string

req_list

입금요청 리스트

true

REQ.LIST /transfer/deposit array

4.4. REQ /transfer/deposit2

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

Name Description Required Schema Default

wd_pass_phrase

이용기관 입금이체용 암호문구

true

string

wd_print_content

출금계좌인자내역

true

string

tran_dtime

요청일시

true

string

req_cnt

입금요청건수

true

string

req_list

입금요청 리스트

true

REQ.LIST /transfer/deposit2 array

4.5. REQ /transfer/recheck

이체API처리조회 요청

Name Description Required Schema Default

check_type

이체구분 (1:출금이체, 2:입금이체)

true

string

tran_dtime

요청일시

true

string

req_cnt

요청건수

true

string

req_list

요청 리스트

true

REQ.LIST /transfer/recheck array

4.6. REQ /transfer/result

이체결과조회 요청

Name Description Required Schema Default

check_type

이체구분 (1:출금이체, 2:입금이체)

true

string

tran_dtime

요청일시

true

string

req_cnt

요청건수

true

string

req_list

요청 리스트

true

REQ.LIST /transfer/result array

4.7. REQ /transfer/withdraw

출금이체 요청

Name Description Required Schema Default

dps_print_content

입금계좌인자내역

true

string

fintech_use_num

핀테크이용번호

true

string

print_content

출금계좌인자내역

true

string

tran_amt

거래금액

true

string

tran_dtime

요청일시

true

string

cms_no

CMS번호

false

string

사용자로그인연결해제 요청

Name Description Required Schema Default

client_use_code

이용기관코드

true

string

user_seq_no

사용자일련번호

true

string

4.9. REQ.LIST /transfer/deposit

입금이체(핀테크이용번호) 요청 리스트 요소

Name Description Required Schema Default

tran_no

거래순번

true

string

fintech_use_num

핀테크이용번호

true

string

print_content

입금계좌인자내역

true

string

tran_amt

거래금액

true

string

cms_no

CMS번호

false

string

4.10. REQ.LIST /transfer/deposit2

입금이체(계좌번호) 요청 리스트 요소

Name Description Required Schema Default

tran_no

거래순번

true

string

bank_code_std

입금은행.표준코드

true

string

account_num

계좌번호

true

string

account_holder_name

입금계좌주명

true

string

print_content

입금계좌인자내역

true

string

tran_amt

거래금액

true

string

cms_no

CMS번호

false

string

4.11. REQ.LIST /transfer/recheck

이체API처리조회 요청 리스트 요소

Name Description Required Schema Default

tran_no

거래순번

false

string

org_tran_dtime

원거래요청일시

false

string

org_req_gubun

원거래 요청계좌지정방식구분 (1:핀테크이용번호, 2:계좌번호)

false

string

bank_code_std

원거래 은행 대표코드

false

string

account_num

원거래 입출금계좌번호

false

string

print_content

원거래 입출금계좌인자내역

false

string

fintech_use_num

원거래 핀테크이용번호

false

string

org_tran_amt

원거래 거래금액

false

string

4.12. REQ.LIST /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.13. RES /account/balance

잔액조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

bank_tran_id

거래고유번호(참가기관)

false

string

bank_tran_date

거래일자(참가기관)

false

string

bank_code_tran

응답코드를 부여한 참가기관 표준코드

false

string

bank_rsp_code

응답코드(참가기관)

false

string

bank_rsp_message

응답메시지(참가기관)

false

string

fintech_use_num

핀테크이용번호

false

string

balance_amt

계좌잔액(-금액가능)

false

string

available_amt

출금가능금액

false

string

account_type

계좌종류

false

string

product_name

상품명

false

string

4.14. RES /account/cancel

계좌해지 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

bank_tran_id

거래고유번호(참가기관)

false

string

bank_tran_date

거래일자(참가기관)

false

string

bank_code_tran

응답코드를 부여한 참가기관.표준코드

false

string

bank_rsp_code

응답코드(참가기관)

false

string

bank_rsp_message

응답메시지(참가기관)

false

string

4.15. RES /account/list

등록계좌목록조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

user_name

고객명

false

string

res_cnt

사용자 등록계좌 개수(해지계좌포함)

false

string

res_list

사용자 계좌 목록(해지계좌포함)

false

RES.LIST /account/list array

4.16. RES /account/transaction_list

거래내역조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

true

string

rsp_code

응답코드(API)

true

string

rsp_message

응답메시지(API)

true

string

api_tran_dtm

거래일시

true

string

bank_tran_id

거래고유번호(참가기관)

false

string

bank_tran_date

거래일자(참가기관)

false

string

bank_code_tran

응답코드를 부여한 참가기관.표준코드

false

string

bank_rsp_code

응답코드(참가기관)

false

string

bank_rsp_message

응답메시지(참가기관)

false

string

fintech_use_num

핀테크이용번호

false

string

balance_amt

계좌잔액(-금액가능)

false

string

page_index_use_yn

페이지 Index 기능 사용여부

false

string

page_index

페이지 번호

false

string

total_record_cnt

총 조회건수

false

string

page_record_cnt

현재페이지 레코드 건수

false

string

next_page_yn

다음 페이지 존재여부

false

string

res_list

조회된 거래내역

false

RES.LIST /account/transaction_list array

4.17. RES /account/update_info

계좌정보변경 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

fintech_use_num

핀테크이용번호

false

string

account_alias

변경된 계좌별명

false

string

4.18. RES /bank/status

참가기관상태조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

res_cnt

참가기관개수

false

string

res_list

조회된 참가기관 상태

false

RES.LIST /bank/status array

4.19. RES /inquiry/real_name

계좌실명조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

bank_tran_id

거래고유번호(참가기관)

false

string

bank_tran_date

거래일자(참가기관)

false

string

bank_code_tran

응답코드를 부여한 참가기관 표준코드

false

string

bank_rsp_code

응답코드(참가기관)

false

string

bank_rsp_message

응답메시지(참가기관)

false

string

bank_code_std

개설기관.표준코드

false

string

bank_code_sub

개설기관.점별코드

false

string

bank_name

개설기관명

false

string

account_num

계좌번호

false

string

account_holder_info

예금주인증정보

false

string

account_holder_name

예금주성명

false

string

4.20. RES /oauth/2.0/authorize

사용자로그인연결 응답

Name Description Required Schema Default

code

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

false

string

scope

인증된 사용자의 권한

false

string

client_info

이용기관이 셋팅하는 임의의 정보. Callback 호출 시 그대로 전달됨

false

string

4.21. RES /oauth/2.0/authorize2

사용자인증 응답

Name Description Required Schema Default

code

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

false

string

scope

인증된 사용자의 권한

false

string

client_info

이용기관이 셋팅하는 임의의 정보. Callback 호출 시 그대로 전달됨

false

string

4.22. RES /oauth/2.0/authorize_account

계좌등록확인 응답

Name Description Required Schema Default

code

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

false

string

scope

인증된 사용자의 권한

false

string

client_info

요청 시 이용기관이 셋팅한 정보를 그대로 전달

false

string

4.23. RES /oauth/2.0/authorize_account2

계좌등록확인2 응답

Name Description Required Schema Default

code

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

false

string

scope

인증된 사용자의 권한

false

string

client_info

요청 시 이용기관이 셋팅한 정보를 그대로 전달

false

string

4.24. RES /oauth/2.0/register_account

계좌등록 응답

Name Description Required Schema Default

code

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

false

string

scope

inquiry: 조회서비스, transfer: 출금서비스

false

string

client_info

이용기관이 셋팅하는 임의의 정보. Callback 호출 시 그대로 전달됨

false

string

4.25. RES /oauth/2.0/token

AccessToken획득 응답

Name Description Required Schema Default

access_token

오픈플랫폼에서 발행된 access_token

false

string

token_type

access_token 유형

false

string

expires_in

토큰 만료기간

false

string

scope

인증된 사용자의 권한

false

string

user_seq_no

사용자일련번호

false

string

4.26. RES /transfer/deposit

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

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

wd_bank_code_std

출금기관.표준코드

false

string

wd_bank_code_sub

출금기관.점별코드

false

string

wd_bank_name

출금기관명

false

string

wd_account_num_masked

출금계좌번호(출력용)

false

string

wd_print_content

출금계좌인자내역

false

string

wd_account_holder_name

송금인성명

false

string

res_cnt

입금건수

false

string

res_list

입금 리스트

false

RES.LIST /transfer/deposit array

4.27. RES /transfer/deposit2

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

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

wd_bank_code_std

출금기관.표준코드

false

string

wd_bank_code_sub

출금기관.점별코드

false

string

wd_bank_name

출금기관명

false

string

wd_account_num_masked

출금계좌번호(출력용)

false

string

wd_print_content

출금계좌인자내역

false

string

wd_account_holder_name

송금인성명

false

string

res_cnt

입금건수

false

string

res_list

입금 리스트

false

RES.LIST /transfer/deposit2 array

4.28. RES /transfer/recheck

이체API처리조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

res_cnt

이체건수

false

string

res_list

이체 리스트

false

RES.LIST /transfer/recheck array

4.29. RES /transfer/result

이체결과조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

res_cnt

이체건수

false

string

res_list

이체 리스트

false

RES.LIST /transfer/result array

4.30. RES /transfer/withdraw

출금이체 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

dps_bank_code_std

입금기관.표준코드

false

string

dps_bank_code_sub

입금기관.점별코드

false

string

dps_bank_name

입금기관명

false

string

dps_account_num_masked

입금계좌번호(출력용)

false

string

dps_print_content

입금계좌인자내역

false

string

dps_account_holder_name

수취인성명

false

string

bank_tran_id

거래고유번호(참가기관)

false

string

bank_tran_date

거래일자(참가기관)

false

string

bank_code_tran

응답코드를 부여한 참가기관 표준코드

false

string

bank_rsp_code

응답코드(참가기관)

false

string

bank_rsp_message

응답메시지(참가기관)

false

string

fintech_use_num

출금계좌핀테크이용번호

false

string

account_alias

출금계좌별명(Alias)

false

string

bank_code_std

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

false

string

bank_code_sub

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

false

string

bank_name

출금(개설)기관명

false

string

account_num_masked

출금계좌번호(출력용)

false

string

print_content

출금계좌인자내역

false

string

tran_amt

거래금액

false

string

account_holder_name

송금인 성명

false

string

4.31. RES /user/me

사용자정보조회 응답

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

user_name

고객명

false

string

res_cnt

등록요청한 계좌 개수

false

string

res_list

등록요청한 계좌 목록

false

RES.LIST /user/me array

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

Name Description Required Schema Default

api_tran_id

거래고유번호(API)

false

string

rsp_code

응답코드(API)

false

string

rsp_message

응답메시지(API)

false

string

api_tran_dtm

거래일시

false

string

user_seq_no

사용자일련번호

false

string

4.33. RES.LIST /account/list

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

Name Description Required Schema Default

fintech_use_num

핀테크이용번호

false

string

account_alias

계좌별명(Alias)

false

string

bank_code_std

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

false

string

bank_code_sub

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

false

string

bank_name

출금(개설)기관명

false

string

account_num_masked

마스킹된 계좌번호

false

string

account_holder_name

예금주명

false

string

account_type

계좌구분(1:개인, 2:법인)

false

string

inquiry_agree_yn

조회서비스 동의여부

false

string

inquiry_agree_dtime

조회서비스 동의일시

false

string

transfer_agree_yn

출금서비스 동의여부

false

string

transfer_agree_dtime

출금서비스 동의일시

false

string

account_state

계좌상태

false

string

4.34. RES.LIST /account/transaction_list

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

Name Description Required Schema Default

tran_date

거래일자

false

string

tran_time

거래시간

false

string

inout_type

입출금구분(입금/출금)

false

string

tran_type

거래구분

false

string

print_content

통장인자내용

false

string

tran_amt

거래금액

false

string

after_balance_amt

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

false

string

branch_name

거래점명

false

string

4.35. RES.LIST /bank/status

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

Name Description Required Schema Default

bank_code_std

참가기관.표준코드

true

string

bank_name

참가기관명

true

string

bank_status

참가기관상태(Y:거래가능, D:장애, L:개시이전, E:종료처리중)

true

string

4.36. RES.LIST /transfer/deposit

입금이체(핀테크이용번호) 응답 리스트 요소

Name Description Required Schema Default

tran_no

거래순번

false

string

bank_tran_id

거래고유번호(참가기관)

false

string

bank_tran_date

거래일자(참가기관)

false

string

bank_code_tran

응답코드를 부여한 참가기관 표준코드

false

string

bank_rsp_code

응답코드(참가기관)

false

string

bank_rsp_message

응답메시지(참가기관)

false

string

fintech_use_num

핀테크이용번호

false

string

account_alias

출금계좌별명(Alias)

false

string

bank_code_std

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

false

string

bank_code_sub

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

false

string

bank_name

입금(개설)기관명

false

string

account_num_masked

입금계좌번호(출력용)

false

string

print_content

입금계좌인자내역

false

string

account_holder_name

수취인 성명

false

string

tran_amt

거래금액

false

string

4.37. RES.LIST /transfer/deposit2

입금이체(계좌번호) 응답 리스트 요소

Name Description Required Schema Default

tran_no

거래순번

false

string

bank_tran_id

거래고유번호(참가기관)

false

string

bank_tran_date

거래일자(참가기관)

false

string

bank_code_tran

응답코드를 부여한 참가기관 표준코드

false

string

bank_rsp_code

응답코드(참가기관)

false

string

bank_rsp_message

응답메시지(참가기관)

false

string

bank_code_std

입금기관.대표코드

false

string

bank_code_sub

입금기관.점별코드

false

string

bank_name

입금기관명

false

string

account_num

입금계좌번호

false

string

account_num_masked

입금계좌번호(출력용)

false

string

dps_print_content

입금계좌인자내역

false

string

tran_amt

거래금액

false

string

account_holder_name

수취인성명

false

string

4.38. RES.LIST /transfer/recheck

이체API처리조회 응답 리스트 요소

Name Description Required Schema Default

tran_no

거래순번

false

string

bank_tran_id

거래고유번호(참가기관)

false

string

bank_tran_date

거래일자(참가기관)

false

string

bank_code_tran

응답코드를 부여한 참가기관 표준코드

false

string

bank_rsp_code

응답코드(참가기관)

false

string

bank_rsp_message

응답메시지(참가기관)

false

string

wd_bank_code_std

출금기관.표준코드

false

string

wd_bank_code_sub

출금기관.점별코드

false

string

wd_bank_name

출금기관명

false

string

wd_fintech_use_num

출금계좌 핀테크이용번호

false

string

wd_account_num_masked

출금계좌번호(출력용)

false

string

wd_print_content

출금계좌인자내역

false

string

wd_account_holder_name

송금인 성명

false

string

dps_bank_code_std

입금기관.표준코드

false

string

dps_bank_code_sub

입금기관.점별코드

false

string

dps_bank_name

입금기관명

false

string

dps_fintech_use_num

입금계좌 핀테크이용번호

false

string

dps_account_num_masked

입금계좌번호(출력용)

false

string

dps_print_content

입금계좌인자내역

false

string

dps_account_holder_name

수취인 성명

false

string

tran_amt

거래금액

false

string

4.39. RES.LIST /transfer/result

이체결과조회 응답 리스트 요소

Name Description Required Schema Default

tran_no

거래순번

false

string

bank_tran_id

거래고유번호(참가기관)

false

string

bank_tran_date

거래일자(참가기관)

false

string

bank_code_tran

응답코드를 부여한 참가기관 표준코드

false

string

bank_rsp_code

응답코드(참가기관)

false

string

bank_rsp_message

응답메시지(참가기관)

false

string

wd_bank_code_std

출금기관.표준코드

false

string

wd_bank_code_sub

출금기관.점별코드

false

string

wd_bank_name

출금기관명

false

string

wd_fintech_use_num

출금계좌 핀테크이용번호

false

string

wd_account_num_masked

출금계좌번호(출력용)

false

string

wd_print_content

출금계좌인자내역

false

string

wd_account_holder_name

송금인 성명

false

string

dps_bank_code_std

입금기관.표준코드

false

string

dps_bank_code_sub

입금기관.점별코드

false

string

dps_bank_name

입금기관명

false

string

dps_fintech_use_num

입금계좌 핀테크이용번호

false

string

dps_account_num_masked

입금계좌번호(출력용)

false

string

dps_print_content

입금계좌인자내역

false

string

dps_account_holder_name

수취인 성명

false

string

tran_amt

거래금액

false

string

4.40. RES.LIST /user/me

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

Name Description Required Schema Default

fintech_use_num

핀테크이용번호

false

string

account_alias

계좌별명(Alias)

false

string

bank_code_std

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

false

string

bank_code_sub

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

false

string

bank_name

출금(개설)기관명

false

string

account_num_masked

마스킹된 계좌번호

false

string

account_holder_name

예금주명

false

string

account_type

계좌구분(1:개인, 2:법인)

false

string

inquiry_agree_yn

조회서비스 동의여부

false

string

inquiry_agree_dtime

조회서비스 동의일시

false

string

transfer_agree_yn

출금서비스 동의여부

false

string

transfer_agree_dtime

출금서비스 동의일시

false

string

4.41. 계좌해지 요청

계좌해지

Name Description Required Schema Default

scope

inquiry:조회서비스, transfer:출금서비스

true

string

fintech_use_num

핀테크이용번호

true

string