1.요청 도메인
2.공통 전문 형식
•
JSON형식의 전문으로 서비스한다.
•
길이는 바이트(byte)단위 (숫자유형의 경우 길이 없음)
•
응답 시 sucsFair, procCd, rsltMesg 항목은 공통부이며, API별로 rsltObj가 달라짐
구분 | 필드명 | 유형 | 길이 | 필수 | 설명 |
요청 | data | JSON | Y | 요청 데이터 | |
응답 | sucsFalr | String | 7 | Y | 성공실패여부 |
응답 | procCd | String | 6 | Y | 응답코드
’HCO000’이 아닌 경우는 모두 오류입니다. |
응답 | rsltMesg | String | Y | 응답메시지 | |
응답 | rsltMesg | JSON | N | API별
응답데이터 |
3.요청 예시
•
로그인
{
"uscoSno": 1,
"mbtlNo": "01012341234",
"pwd": "12345"
}
JSON
복사
•
응답예시
{
"sucsFalr": "success",
"rsltCd": "HCO000",
"rsltMesg": "정상 처리 되었습니다.",
"rsltObj":
{ "uscoSno": 1,
"mbtlNo": "01012345678",
"acsTkn": "access token 값",
"rfshTkn": "refresh token 값" }
}
JSON
복사
API URI
바로계좌결제 API는 아래와 같은 API를 제공하며, 하나의 API는 하나의 웹 서비스 URI로 매핑됩니다.
접속 domain 정보
•
개발 - https://barodev.hyphen.im
•
운영 - https://baro.hyphen.im
API 명 | URI | HTTP Method | 토큰 여부 |
서명값생성(Non-UI) | domain + ‘/barotongjang/merchant/sign’ | POST | N |
결제등록(UI) | Webview 연동 | POST | N |
결제완료(Non-UI) | domain + ‘/barotongjang/settlement/approval/comfirm’ | POST | Y |
결제취소(Non-UI) | domain + ‘/barotongjang/settlement/cancel’ | POST | Y |
HTTP 헤더 추가 정보
필드명 | 필드값 | 필수여부 |
content-type | Application/json; charset=UTF-8 | Y |
Authorization | Bearer + space 1byte + token | Optional(토큰 필요 API인 경우 ‘Y’) |
정보 보호
데이터 송수신시 개인정보/중요 정보 필드에 대해서는 다음과 같은 암복호화를 수행하며 암호키는 별도 안내 합니다.
구분 | 항목 | 적용 | 키 인코딩 | 키 길이 | IV | 데이터인코딩 |
개인정보 | 알고리즘 | AES-256/CBC/PKCS5Padding | Hex | 32 byte(인코딩전) | 키 인코딩 후 앞 16byte | Base64 |
•
IV 설정 예
제공 될 암호화 키 492BE16564A3C02D4098591ED3107AA65CBD0240B6A7A08B4F76294D7BA54223
IV(Initial Vector) : 492BE16564A3C02D
테스트 상점번호 & 토큰 & 암호화 키