오픈API
ATM/지점통합정보조회
고객이 설정한 지도 화면 상에 있는 ATM과 지점의 목록을 조회하는 API입니다.
요청메시지 URL
| HTTP URL | https://openapi.finmap.or.kr/v1.0/kftc/inquiry/brch_atm_lists |
|---|---|
| HTTP Method | POST |
| Content-Type (요청) | application/json; charset=UTF-8 |
| Content-Type (응답) | application/json; charset=UTF-8 |
요청 메시지 명세
| HTTP | 항목 | 필수 | TYPE(길이) | 설명 | |
|---|---|---|---|---|---|
| Header | Authorization | Y | - | Access Token [scope = finmap] | |
| Body | start_latitude | Y | N(4,10) | 시작점 위도 | |
| start_longitude | Y | N(4,10) | 시작점 경도 | ||
| end_latitude | Y | N(4,10) | 끝점 위도 | ||
| end_longitude | Y | N(4,10) | 끝점 경도 | ||
| brch_inqr_yn | Y | A(1) | 지점조회여부 - 조회:Y, 조회안함:N |
||
| atm_inqr_yn | Y | A(1) | ATM조회여부 - 조회:Y, 조회안함:N |
||
| mob_cash_card_psb_yn | Y | A(1) | 모바일현금카드 이용 가능 검색 - 모바일현금카드이용가능만:Y , 전체:N |
||
| brch_srch_yn | N | A(1) | 지점맞춤검색여부 - 검색:Y, 검색안함(전체):N |
||
| brch_cond | N | - | 지점맞춤검색조건부 : 반복구아님
- 지점맞춤검색여부가 Y인 경우 사용 - 기관 검색은 합집합 그 외 조건은 교집합 검색 |
||
| -- open_yn | N | A(1) | 현재운영여부 - 운영중:Y, 조건해당없음:N |
||
| -- whlchr_psb_yn | N | A(1) | 휠체어이용가능여부 - 이용가능:Y, 조건해당없음:N |
||
| -- brch_astc_06_yn | N | A(1) | PB센터전담여부 - 운영함:Y, 조건해당없음:N |
||
| -- brch_astc_01_yn | N | A(1) | 외국인근로자특화점포여부 - 특화점포:Y, 조건해당없음:N |
||
| -- ptsh_icld_yn | N | A(1) | 제휴지점포함여부 - 포함:Y, 불포함:N |
||
| -- org_code_srch_yn | N | A(1) | 기관검색조건여부 - 기관검색함:Y, 조건해당없음:N |
||
| -- org_code_srch | N | Array N(3) |
검색기관 : 반복구(최대40개)
- 기관검색조건여부가 Y인 경우 사용 - 검색여부 Y인 서비스에 대해 합집합 검색 |
||
| atm_srch_yn | N | A(1) | ATM맞춤검색여부 - 검색:Y, 검색안함(전체):N |
||
| atm_cond | N | - | ATM맞춤검색조건부 : 반복구 아님
- ATM맞춤검색여부가 Y인 경우 사용 - 기관, 지원언어 검색은 합집합 그 외 조건은 교집합 검색 |
||
| -- open_yn | N | A(1) | 현재운영여부 - 운영중:Y, 조건해당없음:N |
||
| -- whlchr_psb_yn | N | A(1) | 휠체어이용가능여부 - 이용가능:Y, 조건해당없음:N |
||
| -- ptsh_icld_yn | N | A(1) | 제휴ATM포함여부 - 포함:Y, 불포함:N |
||
| -- org_code_srch_yn | N | A(1) | 기관검색조건여부 - 검색:Y, 검색안함(전체):N |
||
| -- org_code_srch | N | Array N(3) |
검색기관 : 반복구(최대40개)
- 기관검색조건여부가 Y인 경우 사용 - 검색여부 Y인 서비스에 대해 합집합 검색 |
||
| -- prvd_svc_srch_yn | N | A(1) | 제공서비스검색여부 - 검색:Y, 검색안함(전체):N |
||
| -- prvd_svc_cond | N | - | 제공서비스선택 : 반복구 아님
- 제공서비스검색조건여부가 Y인 경우 사용 - 검색여부 Y인 서비스에 대해 교집합 검색 |
||
| ---- cash_wdrl_psb_yn | N | A(1) | 현금인출 | - 제공:Y - 조건해당없음:N |
|
| ---- cash_dps_psb_yn | N | A(1) | 현금입금 | ||
| ---- acnt_trns_psb_yn | N | A(1) | 계좌이체 | ||
| ---- bkbo_psb_yn | N | A(1) | 통장이용 | ||
| ---- cadv_psb_yn | N | A(1) | 현금서비스 | ||
| ---- putb_mnrv_psb_yn | N | A(1) | 공과금수납 | ||
| ---- puboffr_psb_yn | N | A(1) | 공모주청약 | ||
| -- spt_lang_srch_yn | N | A(1) | 지원언어검색여부 - 검색:Y, 검색안함(전체):N |
||
| -- spt_lang_cond | N | - | 지원언어선택 : 반복구 아님
- 지원언어검색조건여부가 Y인 경우 사용 - 검색여부Y인 언어에 대해 합집합 검색 |
||
| ---- kor_psb_yn | N | A(1) | 한국어 | - 지원:Y - 조건해당없음:N |
|
| ---- eng_psb_yn | N | A(1) | 영어 | ||
| ---- chn_psb_yn | N | A(1) | 중국어 | ||
| ---- jpn_psb_yn | N | A(1) | 일본어 | ||
| ---- vnm_psb_yn | N | A(1) | 베트남어 | ||
| ---- idn_psb_yn | N | A(1) | 인도네시아어 | ||
| ---- tha_psb_yn | N | A(1) | 타이어 | ||
| ---- phl_psb_yn | N | A(1) | 필리핀어 | ||
| ---- rus_psb_yn | N | A(1) | 러시아어 | ||
| ---- khm_psb_yn | N | A(1) | 캄보디아어 | ||
| ---- bgd_psb_yn | N | A(1) | 방글라데시어 | ||
| ---- mng_psb_yn | N | A(1) | 몽골어 | ||
| ---- npl_psb_yn | N | A(1) | 네팔어 | ||
| ---- lka_psb_yn | N | A(1) | 스리랑카어 | ||
| ---- mmr_psb_yn | N | A(1) | 미얀마어 | ||
| ---- ind_psb_yn | N | A(1) | 인도어 | ||
| ---- pak_psb_yn | N | A(1) | 파키스탄어 | ||
| ---- fra_psb_yn | N | A(1) | 프랑스어 | ||
| ---- deu_psb_yn | N | A(1) | 독일어 | ||
| ---- esp_psb_yn | N | A(1) | 스페인어 | ||
요청 메시지 형태
- 위치기반 조회 시
{
“start_latitude”: "123.4567",
“start_longitude“: "123.4567",
“end_latitude”: "456.1234",
“end_longitude”: "456.1234",
“brch_inqr_yn“: "Y",
“atm_inqr_yn”: "Y",
“mob_cash_card_psb_yn”: "N"
}
- 맞춤정보 조회 시 (지점 제외, 현재 운영 중인 한국어/중국어 사용 가능한 산업, 기업은행 ATM만 조회)
{
“start_latitude”: "123.4567",
“start_longitude“: "123.4567",
“end_latitude”: "456.1234",
“end_longitude”: "456.1234",
“brch_inqr_yn“: "Y",
“atm_inqr_yn”: "Y",
“mob_cash_card_psb_yn”: "N",
“atm_srch_yn”: "Y",
"atm_cond":
{ "open_yn": "Y",
“org_code_srch_yn” : “Y”,
“org_code_srch” : [“002”, “003”],
“spt_lang_srch_yn”: "Y",
"spt_lang_cond":
{ "kor_psb_yn": "Y",
"chn_psb_yn": "Y"}
}
}
응답 메시지 명세
| HTTP | 항목 | 필수 | TYPE(길이) | 설명 |
|---|---|---|---|---|
| Body | api_tran_id | Y | aNS(40) | 거래고유번호(API) |
| api_tran_dtm | Y | N(17) | 거래일시(밀리세컨드) | |
| rsp_code | Y | AN(3) | 응답코드(API) | |
| rsp_message | N | AH(200) | 응답메시지(API) | |
| brch_cnt | Y | N(2) | 지점건수, 0~20 | |
| atm_cnt | Y | N(2) | ATM건수, 0~20 | |
| brch_list | N | 지점내역 : 반복구(최대20개) - brch_cnt가 0일 경우 미사용 |
||
| -- trns_org_code | Y | N(3) | 전송기관코드 | |
| -- org_type_code | Y | N(3) | 한 기관 내 다수법인 코드가 구분된 경우 사용 예) 수협 007/009 다수법인구분 없는 경우 전송기관코드와 동일 수수료 조회시 기준코드 |
|
| -- brch_code | Y | N(7) | 지점코드 | |
| -- dup_brch_code | Y | N(2) | 중복구분코드 | |
| -- brch_name | Y | AHN(80) | 지점명 | |
| -- brch_latitude | Y | N(4.10) | 위도 | |
| -- brch_longitude | Y | N(4.10) | 경도 | |
| -- clse_schd_yn | Y | A(1) | 폐쇄예정여부 - 해당:Y, 해당안함:N |
|
| -- clse_schd_dt | Y | N(8) | 폐쇄예정일 - 해당사항 없는 경우 ALL ZERO |
|
| -- sbst_brch1_code | N | N(7) | 대체지점1 | |
| -- sbst_brch1_latitude | N | N(4.10) | 대체지점1 위치 위도 | |
| -- sbst_brch1_longitude | N | N(4.10) | 대체지점1 위치 경도 | |
| -- sbst_brch2_code | N | N(7) | 대체지점2 | |
| -- sbst_brch2_latitude | N | N(4.10) | 대체지점2 위치 위도 | |
| -- sbst_brch2_longitude | N | N(4.10) | 대체지점2 위치 경도 | |
| atm_list | N | ATM내역 : 반복구(최대20개) - atm_cnt가 0일 경우 미사용 |
||
| -- trns_org_code | Y | N(3) | 전송기관코드 | |
| -- org_type_code | Y | N(3) | 한 기관 내 다수법인 코드가 구분된 경우 사용
예) 수협 007/009 다수법인구분 없는 경우 전송기관코드와 동일 수수료 조회시 기준코드 |
|
| -- atm_no | Y | AN(11) | 단말번호 | |
| -- dup_atm_no | Y | N(2) | 중복ATM번호 | |
| -- atm_name | Y | AHN(80) | ATM명 | |
| -- atm_latitude | Y | N(4.10) | 위치 위도 | |
| -- atm_longitude | Y | N(4.10) | 위치 경도 | |
| -- cd_van_type_code | Y | AN(3) | CD VAN 기기구분
- null:은행, null아님:VAN사 - 001:단독제휴, 002:멀티제휴, 003:VAN단말 |
|
| -- mob_cash_card_psb_yn | Y | A(1) | 모바일현금카드사용여부 - 가능:Y, 불가능:N, 불분명:A |
|
| -- istl_loc_type_code | Y | AN(3) | 설치장소구분코드 |
응답 메시지 형태
{
"api_tran_id": "2ffd133a-d17a-431d-a6a5",
"api_tran_dtm": "20190910101921567",
"rsp_code": "000",
"rsp_message": "",
"brch_cnt": "20",
"atm_cnt": "20",
"brch_list": [
{ "trns_org_code": "002",
"org_type_code": "002",
"brch_code": "0021234",
"dup_brch_code": "00",
"brch_name": "산업은행정자역지점",
"brch_latitude": "123.4567",
"brch_longitude": "234.5678",
"clse_schd_yn": "Y",
"clse_schd_dt": "20211001",
"sbst_brch1_code": "0023333",
"sbst_brch1_latitude": "123.6666",
"sbst_brch1_longitude": "234.7777"},
{ "trns_org_code": "003",
"org_type_code": "003",
"brch_code": "0031234",
"dup_brch_code": "01",
"brch_name": "기업은행정자역지점",
"brch_latitude": "123.4567",
"brch_longitude": "234.5678",
"clse_schd_yn": "N",
"clse_schd_dt": "00000000"},
{ … },
…
{ … }
],
"atm_list": [
{ "trns_org_code": "002",
"org_type_code": "002",
"atm_no": "0021234CD01",
"dup_atm_no": "00",
"atm_name": “산업은행결제원분당센터",
"atm_latitude": "123.4567",
"atm_longitude": "234.5678",
“cd_van_type_code”: “”,
"mob_cash_card_psb_yn": "Y",
"istl_loc_type_code": "I" },
{ … },
…
{ … }
]
}
본관 : 06220 서울특별시 강남구 테헤란로 202(역삼동)
분당센터 : 13556 경기도 성남시 분당구 정자일로213번길 9(정자동)
Copyright ⓒ 2019 KFTC (Korea Financial Telecommunications & Clearings Institute)
All rights reserved.
