1.1. 상점 등록
용어정의
•
사용자 ”가맹점”을 통해 바로계좌결제를 통해 결제를 시도하는 회원
•
가맹점 하이픈의 “바로계좌결제”를 이용하는 상점
•
HTTP Header Information
URL | 요청 도메인 + /merchant/notify |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
전제조건: 이용사 자체 백오피스 사용/ 이용사에 상점이 이미 등록된 상태에서 상점을 추가하는 경우
sequenceDiagram autonumber 이용사플랫폼(app/web) ->> 이용사(Server): 상점등록 요청 이용사(Server) ->> 하이픈: 상점등록 API 호출 하이픈 -->> 이용사(Server): 정상 이용사(Server) -->> 이용사플랫폼(app/web): 정상, 상점등록 완료
Mermaid
복사
회원관리 비정상 case
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | rqsDscd | 요청구분코드 | Y | String | C :등록, U : 수정 |
2 | uscoSno | 이용사일련번호 | Y | bigint | |
3 | mrstNo | 상점번호 | Y | bigint | 이용사에서 관리되는 상점번호 |
4 | mrstNm | 상점명 | Y | String | |
5 | mrstTpcd | 상점유형코드 | Y | String | 10:대표상점,
20:하위상점,
30:일반상점 |
6 | rpstMrstNo | 대표상점일련번호 | Y | bigint | mrstTpcd가 ‘10’,’30’인 경우 공란, ‘20’인 경우 필수 |
7 | mrstStcd | 상점상태코드 | Y | String | 00:사용, 10:중지, 99:해지 |
8 | bzprNo | 사업자번호 | Y | String | |
9 | rpsrNm | 대표자명 | Y | String | |
10 | rpstTlno | 대표전화번호 | N | String | AES암호화 |
11 | rpsrEml | 대표이메일 | Y | String | AES암호화 |
12 | rpsrMbtlNo | 대표휴대전화번호 | Y | String | AES암호화 |
13 | zip | 우편번호 | Y | String | |
14 | adr | 주소 | Y | String | |
15 | dtlAdr | 상세주소 | Y | String | |
18 | aplStDt | 영업시작일자 | N | String | 미입력시 등록당일 |
19 | aplEndDt | 영업종료일자 | N | String | 미입력시 9999년 12월 31일 |
20 | xclDfryBkcd | 정산지급 은행코드 | Y | String | |
21 | xclDfryAcno | 정산지급 계좌번호 | Y | String | AES암호화 |
22 | xclDfryDpwn | 정산지급 예금주 | Y | String | |
23 | xclDfryFrq | 정산지급 주기 | N | String | |
24 | xclTgtCd | 정산대상 코드 | Y | String | 1:개별상점 정산, 2:대표상점 정산 |
25 | bscFee | 기본 수수료율 | N | bigint | default : 1.5 |
26 | mnmFee | 건당 최소 수수 | N | bigint | default : 0 |
27 | xclStCd | 정산상태코드 | N | String | 1:정상, 2:중지 / default : 1 |
{
"rqsDscd": "요청구분코드",
"uscoSno": "이용사일련번호",
"mrstNo":"상점번호",
"mrstNm": "상점명",
"mrstTpcd": "상점유형코드",
"rpstMrstSno": "대표상점일련번호",
"bzprNo": "사업자번호",
"rpsrNm": "대표자명",
"rpstTlno": "대표자전화번호",
"rpsrEml": "대표자이메일",
"rpsrMbtlNo": "대표자휴대폰번호",
"zip": "우편번호",
"adr": "주소",
"dtlAdr": "상세주소",
"bztpCd": "업종코드",
"bscnNm": "업태명",
"aplStDt": "적용시작일자",
"aplEndDt": "적용종료일자"
"xclDfryBkcd": "정산지급 은행코드",
"xclDfryAcno": "정산지급 계좌번호",
"xclDfryDpwn": "정산지급 예금주",
"xclDfryFrq": "정산지급 주기",
"xclTgtCd": "정산대상코드",
"bscFee": "기본 수수료율",
"mnmFee": "건당최소수수료"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | sucsFalr | Y | String | 성공 실패 여부 | |
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | |
3 | rsltMesg | Y | String | 응답 메시지 | |
4 | rsltObj | N | JSON | API별 응답 데이터 | |
4-1 | rqsDscd | 요청구분코드 | Y | string | C :등록, U : 수정 |
4-2 | uscoSno | 이용사일련번호 | Y | bigint | |
4-3 | mrstNo | 상점번호 | Y | bigint | |
4-4 | mrstNm | 상점명 | Y | string | |
4-5 | mrstTpcd | 상점유형코드 | Y | string | 10:대표상점, 20:하위상점, 30:일반상점 |
4-6 | rpstMrstSno | 대표상점일련번호 | Y | bigint | mrstTpcd가 ‘10’,’30’인 경우 공란, ‘20’인 경우 필수 |
4-7 | mrstStcd | 상점상태코드 | Y | string | 00:사용, 10:중지, 99:해지 |
4-8 | bzprNo | 사업자번호 | Y | string | |
4-9 | rpsrNm | 대표자명 | Y | string | |
4-10 | rpstTlno | 대표전화번호 | N | string | AES암호화 |
4-11 | rpsrEml | 대표이메일 | Y | string | AES암호화 |
4-12 | rpsrMbtlNo | 대표휴대전화번호 | Y | string | AES암호화 |
4-13 | zip | 우편번호 | Y | string | |
4-14 | adr | 주소 | Y | string | |
4-15 | dtlAdr | 상세주소 | Y | string | |
4-16 | bztpCd | 업종코드 | N | string | |
4-17 | bscnNm | 업태명 | N | string | |
4-18 | aplStDt | 영업시작일자 | N | string | 미입력시 등록당일 |
4-19 | aplEndDt | 영업종료일자 | N | string | 미입력시 9999년 12월 31일 |
4-20 | xclDfryBkcd | 정산지급 은행코드 | Y | string | |
4-21 | xclDfryAcno | 정산지급 계좌번호 | Y | string | AES암호화 |
4-22 | xclDfryDpwn | 정산지급 예금주 | Y | string | |
4-23 | xclDfryFrq | 정산지급 주기 | Y | string | |
4-24 | xclTgtCd | 정산대상 코드 | Y | string | 1:개별상점 정산, 2:대표상점 정산 |
4-25 | bscFee | 기본 수수료율 | N | bigint | bscFee 또는 mnmFee 필수값 |
4-26 | mnmFee | 건당 최소 수수 | N | bigint | bscFee 또는 mnmFee 필수값 |
4-27 | xclStCd | 정산상태코드 | Y | string | 1:정상, 2:중지 |
{
"sucsFalr": "성공실패여부(success/fail)",
"rsltCd": "응답코드",
"rsltMesg": "응답메시지",
"rsltObj": {
"rqsDscd": "요청구분코드",
"uscoSno": "이용사일련번호",
"mrstNo": "상점번호",
"mrstNm": "상점명",
"mrstTpcd": "상점유형코드",
"rpstMrstSno": "대표상점일련번호",
"bzprNo": "사업자번호",
"rpsrNm": "대표자명",
"rpstTlno": "대표자전화번호",
"rpsrEml": "대표자이메일",
"rpsrMbtlNo": "대표자휴대폰번호",
"zip": "우편번호",
"adr": "주소",
"dtlAdr": "상세주소",
"bztpCd": "업종코드",
"bscnNm": "업태명",
"aplStDt": "적용시작일자",
"aplEndDt": "적용종료일자",
"xclDfryBkcd": "정산지급 은행코드",
"xclDfryAcno": "정산지급 계좌번호",
"xclDfryDpwn": "정산지급 예금주",
"xclDfryFrq": "정산지급 주기",
"xclTgtCd": "정산대상코드",
"bscFee": "기본 수수료율",
"mnmFee": "건당최소수수료",
"lat": "위도",
"lng": "경도"
}
}
JSON
복사