💸

3. 거래관리

이용사에서 발생한 거래내역을 하이픈에 등록하는 API 입니다.

sequenceDiagram
autonumber
사용자->>이용사플랫폼(app/web): 서비스요청
이용사플랫폼(app/web) ->> 이용사 : 거래 요청

alt 거래등록(NON UI)
이용사 ->> 하이픈 : 거래등록 API요청
하이픈 -->> 이용사: 거래등록 API응답
end
이용사 -->> 이용사플랫폼(app/web): 거래 응답
이용사플랫폼(app/web) -->> 사용자: 서비스 제공
Mermaid
복사

•

HTTP header information

URL	요청 도메인 + /settlement/notify
Method	POST
Content-Type	Application/json; charset=UTF-8
Authorization	Bearer + 스페이스 1byte + 이용사토큰

•

Request

No	항목	항목명	필수	TYPE	설명
1	rqsDscd	요청구분코드	Y	string	C : 등록
2	uscoSno	이용사일련번호	Y	bigint	별도 안내
3	mrstNo	상점번호	N	string	정산대상 거래 시 입력 (충전,충전취소,환불,환불취소,지급,지급취소 시 공백)
4	mbrID	회원ID	Y	string	이용사의 회원 ID
5	tmnNo	단말기번호	N	string
6	trDscd	거래구분코드	Y	string(2)	거래구분코드 sheet 참조
7	trDtlDscd	거래상세구분코드	Y	string(2)	거래구분코드 sheet 참조
8	lkgTrDtlDscd	연동거래상세구분코드	N	string(2)	거래구분코드 sheet 참조
9	trDt	거래일자	Y	string	YYYYMMDD
10	trTm	거래시각	Y	String	HHMMSS
11	trAprvNo	거래승인번호	Y	String(20)	미입력시 자동채번
12	rqsAmt	요청금액	Y	String	고객이 결제한 금액
13	pcsAmt	처리금액	Y	String	잔액처리금액 (실제로 회원 충전처리한 금액)
14	trAfRmd	거래 후 잔액	N	String
15	ordNo	주문번호	N	String(50)	이용사의 거래고유번호 입력
16	prdNm	상품명	N	String
17	trUnqNo	거래고유번호	N	String	PG사를 통한 거래 시 기관에서 발급한 거래의 고유번호
18	trIsttCd	거래기관코드	N	String	거래와 연관 된 기관코드 (정산, 인출 시 은행코드)
19	trInf	거래정보	N	string	거래와 연관 된 정보, 계좌번호 등 (AES-256 암호화) / 포인트ID
20	ogtrDt	원거래일자	N	string	YYYYMMDD 취소거래시만 사용
21	ogtrTm	원거래시각	N	string	HHMMSS 취소거래시만 사용
22	ogtrAprvNo	원거래승인번호	N	string	취소거래시만 사용
23	usPsbDt	사용가능일자	N	string	YYYYMMDD 포인트 거래시만 사용 미입력시 포인트지급정보관리 조회 후 존재하면 해당 정보로 설정 포인트지급정보관리 원장에도 없을 경우 현재일자 자동입력
24	extDt	소멸일자	N	string	YYYYMMDD

{
    "rqsDscd": "요청구분코드",
		"uscoSno": "이용사일련번호",
		"mrstSno": "상점일련번호",
		"mbrID": "회원일련번호",
		"tmnNo": "단말기번호",
		"trDscd": "거래구분코드",
		"trDtlDscd": "거래상세구분코드",
		"lkgTrDtlDscd": "연동거래상세구분코드",
		"trDt": "거래일자",
		"trTm": "거래시각",
		"trAprvNo": "거래승인번호",
		"rqsAmt": "요청금액 - 고객결제금액",
		"pcsAmt": "처리금액 - 실처리금액",
		"trAfRmd": "거래후잔액",
		"ordNo": "주문번호",
		"prdNm": "상품명",
		"trUnqNo": "거래고유번호",
		"trIsttCd": "거래기관코드",
		"trInf": "거래정보",
		"ogtrDt": "원거래일자",
		"ogtrTm": "원거래시각",
		"ogtrAprvNo": "원거래승인번호"
    
}
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 : 등록
4-2	uscoSno	이용사일련번호	Y	bigint	별도 안내
4-3	mrstNo	상점번호	Y	String	정산대상 거래 시 입력
4-4	mbrID	회원ID	Y	string	이용사의 회원 ID
4-5	tmnNo	단말기번호	N	String
4-6	trDscd	거래구분코드	Y	String	거래구분코드 sheet 참조
4-7	trDtlDscd	거래상세구분코드	Y	String	거래구분코드 sheet 참조
4-8	lkgTrDtlDscd	연동거래상세구분코드	N	String	거래구분코드 sheet 참조
4-9	trDt	거래일자	Y	String	YYYYMMDD 미입력시 현재일자
4-10	trTm	거래시각	Y	String	HHMMSS 미입력시 현재시각
4-11	trAprvNo	거래승인번호	Y	String	미입력시 자동채번
4-12	rqsAmt	요청금액	Y	String	고객이 결제한 금액
4-13	pcsAmt	처리금액	Y	String	잔액처리금액 (실제로 회원 충전처리한 금액)
4-14	trAfRmd	거래후 잔액	Y	String
4-15	ordNo	주문번호	N	String	이용사의 거래고유번호 입력, 하이픈 자동채번하도록 개발 예정
4-16	prdNm	상품명	N	String
4-17	trUnqNo	거래고유번호	N	String	PG사를 통한 거래 시 기관에서 발급한 거래의 고유번호
4-18	trIsttCd	거래기관코드	N	String	거래와 연관 된 기관코드(정산, 인출 시 은행코드)
4-19	trInf	거래정보	N	String	거래와 연관 된 정보, 계좌번호 등(AES-256 암호화)
4-20	ogtrDt	원거래일자	N	String	YYYYMMDD / 취소거래시 사용
4-21	ogtrTm	원거래시각	N	String	HHMMSS / 취소거래시 사용
4-22	ogtrAprvNo	원거래승인번호	N	String	취소거래시 사용
4-23	usPsbDt	사용가능일자	N	String	YYYYMMDD 포인트 거래시만 사용 미입력시 포인트지급정보관리 조회 후 존재 하면 해당 정보로 설정 포인트지급정보관리 원장에도 없을 경우 현재일자 자동입력
4-24	extDt	소멸일자	N	String	YYYYMMDD

{
    "sucsFalr": "success",
    "rsltCd": "HCO000",
    "rsltMesg": "정상으로 처리되었어요",
    "rsltObj":
    {
		    "rqsDscd": "요청구분코드",
				"uscoSno": "이용사일련번호",
				"mrstSno": "상점일련번호",
				"mbrID": "회원일련번호",
				"tmnNo": "단말기번호",
				"trDscd": "거래구분코드",
				"trDtlDscd": "거래상세구분코드",
				"lkgTrDtlDscd": "연동거래상세구분코드",
				"trDt": "거래일자",
				"trTm": "거래시각",
				"trAprvNo": "거래승인번호",
				"rqsAmt": "요청금액 - 고객결제금액",
				"pcsAmt": "처리금액 - 실처리금액",
				"trAfRmd": "거래후잔액",
				"ordNo": "주문번호",
				"prdNm": "상품명",
				"trUnqNo": "거래고유번호",
				"trIsttCd": "거래기관코드",
				"trInf": "거래정보",
				"ogtrDt": "원거래일자",
				"ogtrTm": "원거래시각",
				"ogtrAprvNo": "원거래승인번호"    
		}
}
JSON
복사

3. 거래관리

3.1. 거래등록