API공통부
기본정보
- 요청 : API 전문 요청 시, 공통부의 Header와 함께 요청값을 전송합니다.
- 응답 : API 전문 응답 시, 공통부의 Header와 함께 응답값을 전송합니다.
NH API 입·출력 Layout
요청
| Element | 한글명 | Type | Length | optional | Description |
|---|---|---|---|---|---|
| Header | 공통부 | ||||
| ApiNm | API 명 | 필드 | 100 | 필수 | 테스트 API 명 |
| Tsymd | 전송일자 | 필드 | 8 | 필수 | API 호출일자 (YYYYMMDD) , 테스트일로 변경 |
| Trtm | 전송시각 | 필드 | 6 | 필수 | API 전송시각 (HHMMSS), 테스트시각으로 변경 |
| Iscd | 기관코드 | 필드 | 6 | 필수 |
-기관약정 시 발급된 ‘핀테크 기관코드’를 말함 -“마이페이지 > 서비스 관리 > 기관코드” 로 변경 |
| FintechApsno | 핀테크 앱 일련번호 | 필드 | 3 | 필수 |
-핀테크서비스 약정 시 발급된 ‘핀테크 앱 일련번호’ -테스트 과정에서는 ‘001’로 고정되며 핀테크 서비스 약정시 발급된 ‘핀테크 앱 일련번호’로 교체해야 함 |
| APISvcCd | API서비스코드 | 필드 | 20 | 필수 |
-핀테크서비스 약정 시 신청한 ‘API 서비스 코드’ -테스트과정에서는 ‘DrawingTransferA’로 고정되며 핀테크 서비스 약정시 발급된 ‘핀테크 API서비스코드’로 교체해야 함 |
| Istuno | 기관거래고유번호 | 필드 | 20 | 필수 |
-핀테크서비스별 & 전송일자별 거래고유번호 채번 -테스트과정에서는 API요청시 사용자가 항상 새로운 번호로 임의 채번해야함. (예 : 000000, 000001 …) |
| AccessToken | 인증키 | 필드 | 64 | 필수 | “마이페이지 > 서비스 관리 > 인증키” 로 변경 |
응답
| Element | 한글명 | Type | Length | optional | Description |
|---|---|---|---|---|---|
| Header | 공통부 | ||||
| ApiNm | API 명 | 필드 | 100 | 필수 | 테스트 API 명 |
| Tsymd | 전송일자 | 필드 | 8 | 필수 | API 호출일자 (YYYYMMDD) , 테스트일로 변경 |
| Trtm | 전송시각 | 필드 | 6 | 필수 | API 전송시각 (HHMMSS), 테스트시각으로 변경 |
| Iscd | 기관코드 | 필드 | 6 | 필수 |
기관약정 시 발급된 ‘핀테크 기관코드’를 말함 “마이페이지 > 서비스 관리 > 기관코드” 로 변경 |
| FintechApsno | 핀테크 앱 일련번호 | 필드 | 3 | 필수 |
-핀테크서비스 약정 시 발급된 ‘핀테크 앱 일련번호’ -테스트 과정에서는 ‘001’로 고정되며 핀테크 서비스 약정시 발급된 ‘핀테크 앱 일련번호’로 교체해야 함 |
| APISvcCd | API서비스코드 | 필드 | 20 | 필수 |
-핀테크서비스 약정 시 신청한 ‘API 서비스 코드’ -테스트과정에서는 ‘DrawingTransferA’로 고정되며 핀테크 서비스 약정시 발급된 ‘핀테크 API서비스코드’로 교체해야 함 |
| Istuno | 기관거래고유번호 | 필드 | 20 | 필수 |
-핀테크서비스별 & 전송일자별 거래고유번호 채번 -테스트과정에서는 변경안해도 됨 |
| Rpcd | 응답코드 | 필드 | 5 | 필수 | |
| Rsms | 응답메세지 | 필드 | 100 | 필수 |