원하는 목차 항목을 누르면 해당 내용으로 이동합니다.
5.1. 회원조회
(이용사 자체 백오피스가 있다면) 아래는 연동에 필요한 회원 정보입니다.
•
HTTP Header Information
URL | 요청 도메인 + /member/getMemberList |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 길이 | 설명 |
1 | uscoSno | 이용사일련번호 | Y | bigint | 별도 안내 | |
2 | eml | 이메일 | N | String | 100 | AES 암호화 |
3 | mbtlNo | 휴대폰번호 | N | String | 50 | AES 암호화 |
4 | mbrNm | 회원명 | N | String | 50 | |
5 | mbrID | 회원ID | N | string | 100 | 이용사의 회원 ID |
6 | stcd | 상태값 | N | String | 2 | 00: 정상, 10: 중지, 20: 잠김, 21: 휴면, 99지 |
7 | rgsdEnrYn | 무/기명 여부 | N | String | 1 | Y: 기명, N:무기명 |
8 | startDt | 조회일자 | N | bigint | 8 | 회원 가입일 YYYYMMDD |
9 | endDt | 조회일자 | N | bigint | 6 | 회원 가입일YYYYMMDD |
10 | pagNo | 페이지번호 | Y | int | 1부터 입력가능 | |
11 | pagSz | 페이지사이즈 | Y | int | ||
12 | mskYn | 마스킹여부 | Y | string | 1 | ‘Y’ : 마스킹처리, ‘N’ : 마스킹미처리 |
{
"uscoSno": "이용사일련번호",
"eml" :"이메일",
"mbtlNo" :"휴대폰번호",
"mbrNm" :"회원명",
"osdMbrId" :"회원ID",
"stcd" :"상태값",
"rgsdEnrYn" : "무기명여부",
"startDt" :"조회일자(시작일)",
"endDt" :"조회일자(종료일)",
"pagNo" :"페이지번호",
"pagSz" :"페이지사이즈"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 설명 | |
1 | sucsFalr | Y | String | 성공 실패 여부 | ||
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | ||
3 | rsltMesg | Y | String | 응답 메시지 | ||
4 | rsltObj | N | JSON | API별 응답 데이터 | ||
5 | totSize | 총 데이터 개수 | Y | |||
[list] | ||||||
5-1 | uscoSno | 이용사일련번호 | Y | bigint | 별도 안내 | |
5-2 | eml | 이메일 | Y | String | 100 | 마스킹처리 시 평문
마스킹미처리 시 암호화 |
5-3 | mbtlNo | 휴대폰번호 | Y | String | 50 | 마스킹처리 시 평문
마스킹미처리 시 암호화 |
5-4 | mbrNm | 회원명 | Y | String | 50 | 마스킹처리 시 평문
마스킹미처리 시 암호화 |
5-5 | mbrID | 회원ID | Y | string | 100 | 이용사의 회원 ID |
5-6 | stcd | 상태값 | Y | String | 2 | 00: 정상, 10: 중지, 20: 잠김, 21: 휴면, 90 : 탈퇴 |
5-7 | bdt | 생년월일 | Y | String | 8 | 생년월일 YYYYMMDD |
5-8 | rgsdEnrYn | 무/기명 여부 | Y | String | 1 | Y: 기명, N:무기명 |
5-9 | sxDscd | 성별 | Y | String | 1 | 0: 남성, 1:여성 |
5-10 | monyAmt | 회원보유머니금액 | Y | bigint | ||
5-11 | pntAmt | 무상포인트 금액 | Y | bigint | ||
5-12 | fpntAmt | 유상포인트 금액 | Y | bigint | ||
5-13 | enrDt | 가입일자 | Y | String | 8 | 가입일자 YYYYMMDD |
{
"sucsFalr": "성공실패여부(success/fail)",
"rsltCd": "응답코드",
"rsltMesg": "응답메시지",
"rsltObj": {
"uscoSno": "이용사일련번호",
"eml" :"이메일",
"mbtlNo" :"휴대폰번호",
"mbrNm" :"회원명",
"osdMbrId" :"회원ID",
"stcd" :"상태값",
"rgsdEnrYn" : "무기명여부",
"bdt" : "생년월일",
"sxDscd" : "성별",
"monyAmt" : "회원보유머니금액",
"pntAmt":"포인트금액 - 회원이 보유하고 있는 유상 포인트 금액",
"fpntAmt":"포인트금액 - 회원이 보유하고 있는 무상 포인트 금액",
"enrDt" : "가입일자"
}
}
JSON
복사
5.2. 상점조회
자체 백오피스 사용 시 연동에 필요한 상점 정보입니다.
•
HTTP Header Information
URL | 요청 도메인 + /merchant/getMerchantList |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 길이 | 설명 |
1 | uscoSno | 이용사번호 | Y | bigint | 계약한 이용사 데이터만 확인 가능(별도안내) | |
2 | mrstNo | 상점번호 | N | string | 50 | |
3 | mrstNm
| 상점명 | N | string | 100 | |
4 | bzprNo | 사업자번호 | N | string | 10 | |
5 | mrstTpcd | 상점유형 | N | string | 2 | 10:대표상점, 20:하위상점, 30:일반상점 |
6 | mrstStcd | 상점상태 | N | string | 2 | 00:정상, 10:중지, 99:해지 |
7 | xclStCd | 정산상태 | N | string | 1 | 1:정상, 2:중지 |
8 | startDt | 조회일자 | N | string | 8 | 등록일자 YYYYMMDD |
9 | endDt | 조회일자 | N | string | 8 | 등록일자 YYYYMMDD |
10 | pagNo | 페이지번호 | Y | int | 1부터 입력가능 | |
11 | pagSz | 페이지사이즈 | Y | int |
{
"uscoSno": "이용사일련번호",
"mrstNo" :"상점번호",
"mrstNm" :"회원ID",
"bzprNo" :"회원명",
"mrstTpcd" :["거래구분코드1","거래구분코드2"]
"mrstStcd" :["결제구분코드1","결제구분코드2"]
"xclStCd" : ["연동상세구분코드1","연동상세구분코드2"]
"startDt" :"조회일자(시작일)",
"endDt" :"조회일자(종료일)",
"pagNo" :"페이지번호",
"pagSz" :"페이지사이즈"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 설명 | |
1 | sucsFalr | Y | String | 성공 실패 여부 | ||
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | ||
3 | rsltMesg | Y | String | 응답 메시지 | ||
4 | rsltObj | N | JSON | API별 응답 데이터 | ||
4-1 | totSize | 총 데이터 개수 | Y | |||
[list] | ||||||
1) | 이용사번호 | Y | bigint | 계약한 이용사 데이터만 확인 가능(별도안내) | ||
2) | mrstNo | 상점번호 | Y | string | 50 | |
3) | mrstNm
| 상점명 | Y | string | 100 | |
4) | bzprNo | 사업자번호 | Y | string | 10 | |
5) | mrstTpcd | 상점유형 | Y | string | 2 | 10:대표상점, 20:하위상점, 30:일반상점 |
6) | mrstStcd | 상점상태 | Y | string | 2 | 00:정상, 10:중지, 99:해지 |
7) | enrDt | 등록일 | Y | string | 8 | YYYYMMDD |
8) | xclStCd | 정산상태 | Y | string | 1 | 1:정상, 2:중지 |
{
"sucsFalr": "성공실패여부(success/fail)",
"rsltCd": "응답코드",
"rsltMesg": "응답메시지",
"rsltObj": {
"totSize": "총 데이터 갯수",
"list": [
{
"uscoNm": "이용사명",
"mrstNo": "상점ID",
"mrstNm": "상점명",
"bzprNo": "사업자번호",
"mrstTpcd": "상점유형",
"mrstStcd": "상점상태",
"enrDt": "등록일시",
"xclStCd": "정산상태"
}
]
}
}
JSON
복사
5.3. 상점상세조회
자체 백오피스 사용 시 연동에 필요한 상점 상세 정보입니다.
•
HTTP Header Information
URL | 요청 도메인 + /merchant/getMerchantDetail |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 길이 | 설명 |
1 | uscoSno | 이용사번호 | Y | bigint | 계약한 이용사 데이터만 확인 가능(별도안내) | |
2 | mrstNo | 상점번호 | Y | string | 50 |
{
"uscoSno": "이용사일련번호",
"mrstNo" :"상점번호"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 설명 | |
1 | sucsFalr | Y | String | 성공 실패 여부 | ||
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | ||
3 | rsltMesg | Y | String | 응답 메시지 | ||
4 | rsltObj | N | JSON | API별 응답 데이터 | ||
4-1 | mrstNo | 상점번호 | Y | string | 50 | 외부상점아이디 |
4-2 | uscoSno | 이용사번호 | Y | bigint | 별도안내 | |
4-3 | mrstStcd | 상점상태 | Y | string | 2 | 00:정상, 10:중지, 99:해지 |
4-4 | mrstTpcd | 상점유형 | Y | string | 2 | 10:대표상점, 20:하위상점, 30:일반상점 |
4-6 | mrstNm
| 상점명 | Y | string | 100 | |
4-7 | bzprNo | 사업자번호 | Y | string | 10 | |
4-8 | bztpCd | 업종코드 | Y | string | 6 | 사업자등록증 상의 업종에 해당하는 코드 |
4-9 | bscnNm | 업태명 | Y | string | 100 | 사업자등록증 상의 업태, 업태는 코드분류가 따로안되어있음 |
4-10 | rpsrNm | 대표자명 | N | string | 30 | |
4-11 | rpstTlno | 대표번호 | N | string | 15 | |
4-12 | rpsrMbtlNo | 대표자 휴대폰번호 | N | string | 100 | |
4-13 | rpsrEml | 대표 이메일 | N | string | 100 | |
4-14 | zip | 우편번호 | Y | string | 6 | |
4-15 | adr | 주소 | Y | string | 250 | |
4-16 | dtlAdr | 상세주소 | Y | string | 100 | |
4-17 | xclTgtCd | 정산대상코드 | Y | string | 1 | 1:개별상점 정산, 2:대표상점 정산 |
4-18 | xclStCd | 정산상태 | Y | string | 1 | 1:정상, 2:중지 |
4-19 | xclDfryBkcd | 지급은행코드 | Y | string | 3 | |
4-20 | xclDfryAcno | 지급계좌번호 | Y | string | 20 | |
4-21 | xclDfryDpwn | 예금주 | Y | string | 50 | |
4-22 | bscFee | 기본수수료 | Y | double | ||
4-23 | mnmFee | 건당 최소 수수료 | Y | bigint | ||
4-24 | xclDfryFrq | 정산주기 | Y | int |
{
"sucsFalr": "성공실패여부(success/fail)",
"rsltCd": "응답코드",
"rsltMesg": "응답메시지",
"rsltObj": {
"mrstNo": "상점번호",
"uscoSno": "이용사번호",
"mrstNo": "상점ID",
"mrstNm": "상점명",
"mrstStcd": "상점상태",
"mrstTpcd": "상점유형",
"mrstNm": "상점명",
"bzprNo": "사업자번호",
"bztpCd": "업종코드",
"bscnNm": "업태명",
"rpsrNm": "대표자명",
"rpstTlno": "대표자번호",
"rpsrMbtlNo": "대표자 휴대폰번호",
"rpsrEml": "대표자 이메일",
"zip": "우편번호",
"adr": "주소",
"dtlAdr": "상세주소",
"xclTgtCd": "정산대상코드",
"xclStCd": "정산상태",
"xclDfryBkcd": "지급 은행코드",
"xclDfryAcno": "지급 계좌번호",
"xclDfryDpwn": "예금주",
"bscFee": "기본 수수료",
"mnmFee": "건당 최소 수수료",
"xclDfryFrq": "정산주기"
}
}
JSON
복사
5.4. 포인트 거래내역조회 v1 (Offset 기반)
자체 백오피스 사용 시 연동에 필요한 회원별 거래 정보입니다.
pageNo(페이지 번호)와 pageSize(페이지 크기)를 사용하여 데이터를 조회
•
HTTP Header Information
URL | 요청 도메인 + /point/div/trlist |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 길이 | 설명 |
1 | uscoSno | 이용사번호 | Y | Long | ||
2 | mrstNo | 상점번호 | N | string | 50 | |
3 | mbrID | 회원ID | N | string | 100 | 이용사의 회원 ID |
4 | trAprvNo | 승인번호 | N | String | 20 | |
5 | trDscd | 거래구분코드 | N | String[] | 2 | |
6 | trDtlDscd | 결제구분코드 | N | String[] | 2 | |
7 | lkgTrDtlDscd | 연동상세구분코드 | N | String[] | 2 | |
8 | trDtStart | 조회일자(FROM) | Y | String | 8 | YYYYMMDD * 거래일 기준으로 조회됨 |
9 | trTmStart | 조회시간(FROM) | N | String | 6 | HHmmss |
10 | trDtEnd | 조회일자(TO) | Y | String | 8 | YYYYMMDD |
11 | trTmEnd | 조회시간(TO) | N | String | 6 | HHmmss |
12 | pagNo | 페이지번호 | Y | int | 1 부터 입력가능 | |
13 | pagSz | 페이징 크기 | Y | int |
{
"uscoSno": "이용사일련번호",
"mrstNo" :"상점번호",
"mbrID" :"회원ID",
"trAprvNo" :"회원명",
"trDscd" :["거래구분코드1","거래구분코드2"]
"trDtlDscd" :["결제구분코드1","결제구분코드2"]
"lkgTrDtlDscd" : ["연동상세구분코드1","연동상세구분코드2"]
"trDtStart" :"조회일자(시작일)",
"trTmStart" :"조회시간(시작시간)",
"trDtEnd" :"조회일자(종료일)",
"trTmEnd" :"조회시간(종료시간)",
"pagNo" :"페이지번호",
"pagSz" :"페이지사이즈"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 길이 | 설명 |
1 | sucsFalr | Y | String | 성공 실패 여부 | ||
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | ||
3 | rsltMesg | Y | String | 응답 메시지 | ||
4 | rsltObj | N | JSON | API별 응답 데이터 | ||
[trList] | ||||||
4-1 | uscoNm | 이용사명 | Y | String | 50 | |
4-2 | mbrID | 회원ID | Y | string | 100 | 이용사의 회원 ID |
4-3 | mrstNo | 상점번호 | N | Long | 50 | |
4-4 | mrstNm | 상점명 | Y | String | 100 | |
4-5 | trAprvNo | 승인번호 | Y | String | 20 | |
4-6 | prdNm | 상품명 | N | String | 200 | |
4-7 | trDscd | 거래구분코드 | Y | String | 2 | |
4-8 | trDscdNm | 거래구분코드명 | Y | String | 2 | |
4-9 | trDtlDscd | 거래상세구분코드 | Y | String | 2 | |
4-10 | trDtlDscdNm | 거래상세구분코드명 | Y | String | 2 | |
4-11 | lkgTrDtlDscd | 연동거래상세구분코드 | Y | String | 2 | |
4-13 | rqsAmt | 요청금액 | Y | Long | ||
4-14 | pcsAmt | 처리금액 | Y | Long | ||
4-15 | trAfRmd | 거래 후 잔액 | Y | Long | ||
4-16 | trDt | 거래일자 | Y | String | 8 | YYYYMMDD |
4-17 | trTm | 거래시간 | Y | String | 6 | HHMMSS |
4-18 | cnclDscd | 취소여부 | Y | Long | 0 : 정상상태 / 1: 취소상태 | |
4-19 | dtlList | 원거래 정보 | N | List | 사용승인(UA), 사용취소(UC) , 소멸(EX) 거래만 해당 ( 2024.07.17 이후 지급건 부터 확인 가능) |
{
"sucsFalr": "성공실패여부(success/fail)",
"rsltCd": "응답코드",
"rsltMesg": "응답메시지",
"rsltObj": {
"trList": [
{
"uscoNm": "이용사명",
"mbrID": "이용사 회원ID",
"mrstNo": "상점ID",
"mrstNm": "상점명",
"trAprvNo": "승인번호",
"prdNm": "상품명",
"trDscd": "거래구분코드",
"trDscdNm": "거래구분코드명",
"trDtlDscd": "거래상세구분코드",
"trDtlDscdNm": "거래상세구분코드명",
"lkgTrDtlDscd": "연동거래상세구분코드",
"rqsAmt": "요청금액",
"pcsAmt": "처리금액",
"trAfRmd": "잔액",
"trDt": "등록일시",
"trTm": "등록일시",
"cnclDscd": "취소여부",
"dtlList": [
{
"uscoNm": "이용사명",
"mbrID": "이용사 회원ID",
"mrstNo": "상점ID",
"mrstNm": "상점명",
"trAprvNo": "승인번호",
"prdNm": "상품명",
"trDscd": "거래구분코드",
"trDscdNm": "거래구분코드명",
"trDtlDscd": "거래상세구분코드",
"trDtlDscdNm": "거래상세구분코드명",
"lkgTrDtlDscd": "연동거래상세구분코드",
"extDt": "만료일자",
"rqsAmt": "요청금액",
"pcsAmt": "처리금액",
"trAfRmd": "잔액",
"trDt": "등록일시",
"trTm": "등록일시",
"cnclDscd": "취소여부"
}
]
}
]
}
}
JSON
복사
5.4.1 포인트 거래내역조회 v2 (Cursor 기반)
자체 백오피스 사용 시 연동에 필요한 회원별 거래 정보입니다.
•
lastTrSno(마지막 조회한 일련번호)를 사용하여 다음 데이터를 조회
•
nextLastTrSno를 응답값으로 반환하며, 이후 요청 시 해당 값을 lastTrSno로 전달하여 다음 페이지를 가져옴
•
HTTP Header Information
URL | 요청 도메인 + /point/v2/div/trlist |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 길이 | 설명 |
1 | uscoSno | 이용사번호 | Y | Long | ||
2 | mrstNo | 상점번호 | N | string | 50 | |
3 | mbrID | 회원ID | N | string | 100 | 이용사의 회원 ID |
4 | trAprvNo | 승인번호 | N | String | 20 | |
5 | trDscd | 거래구분코드 | N | String[] | 2 | |
6 | trDtlDscd | 결제구분코드 | N | String[] | 2 | |
7 | lkgTrDtlDscd | 연동상세구분코드 | N | String[] | 2 | |
8 | trDtStart | 조회일자(FROM) | Y | String | 8 | YYYYMMDD * 거래일 기준으로 조회됨 |
9 | trTmStart | 조회시간(FROM) | N | String | 6 | HHmmss |
10 | trDtEnd | 조회일자(TO) | Y | String | 8 | YYYYMMDD |
11 | trTmEnd | 조회시간(TO) | N | String | 6 | HHmmss |
12 | lastTrSno | 마지막 거래 일련번호(Last Cursor) | N | int | 처음 조회 시 비워서 보냄 (null) | |
13 | pagSz | 페이징 크기 | Y | int | 한 번의 요청에서 조회할 데이터 갯수를 지정 |
{
"uscoSno": "이용사일련번호",
"mrstNo" :"상점번호",
"mbrID" :"회원ID",
"trAprvNo" :"회원명",
"trDscd" :["거래구분코드1","거래구분코드2"]
"trDtlDscd" :["결제구분코드1","결제구분코드2"]
"lkgTrDtlDscd" : ["연동상세구분코드1","연동상세구분코드2"]
"trDtStart" :"조회일자(시작일)",
"trTmStart" :"조회시간(시작시간)",
"trDtEnd" :"조회일자(종료일)",
"trTmEnd" :"조회시간(종료시간)",
"lastTrSno" :"마지막 거래 일련번호",
"pagSz" :"페이지사이즈"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 길이 | 설명 |
1 | sucsFalr | Y | String | 성공 실패 여부 | ||
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | ||
3 | rsltMesg | Y | String | 응답 메시지 | ||
4 | rsltObj | N | JSON | API별 응답 데이터 | ||
[trList] | Array | |||||
4-1 | uscoNm | 이용사명 | Y | String | 50 | |
4-2 | mbrID | 회원ID | Y | string | 100 | 이용사의 회원 ID |
4-3 | mrstNo | 상점번호 | N | Long | 50 | |
4-4 | mrstNm | 상점명 | Y | String | 100 | |
4-5 | trAprvNo | 승인번호 | Y | String | 20 | |
4-6 | prdNm | 상품명 | N | String | 200 | |
4-7 | trDscd | 거래구분코드 | Y | String | 2 | |
4-8 | trDscdNm | 거래구분코드명 | Y | String | 2 | |
4-9 | trDtlDscd | 거래상세구분코드 | Y | String | 2 | |
4-10 | trDtlDscdNm | 거래상세구분코드명 | Y | String | 2 | |
4-11 | lkgTrDtlDscd | 연동거래상세구분코드 | Y | String | 2 | |
4-13 | rqsAmt | 요청금액 | Y | Long | ||
4-14 | pcsAmt | 처리금액 | Y | Long | ||
4-15 | trAfRmd | 거래 후 잔액 | Y | Long | ||
4-16 | trDt | 거래일자 | Y | String | 8 | YYYYMMDD |
4-17 | trTm | 거래시간 | Y | String | 6 | HHMMSS |
4-18 | cnclDscd | 취소여부 | Y | Long | 0 : 정상상태 / 1: 취소상태 | |
4-19 | dtlList | 원거래 정보 | N | List | 사용승인(UA), 사용취소(UC) , 소멸(EX) 거래만 해당 ( 2024.07.17 이후 지급건 부터 확인 가능) | |
5 | nextLastTrsno | 다음 조회를 위한 마지막 거래 일련번호 (Cursor) | Y | int | 다음 페이지 요청 시 사용 (최대 :200) |
{
"sucsFalr": "성공실패여부(success/fail)",
"rsltCd": "응답코드",
"rsltMesg": "응답메시지",
"rsltObj": {
"nextLastTrsno": "마지막 일련번호"
"trList": [
{
"uscoNm": "이용사명",
"mbrID": "이용사 회원ID",
"mrstNo": "상점ID",
"mrstNm": "상점명",
"trAprvNo": "승인번호",
"prdNm": "상품명",
"trDscd": "거래구분코드",
"trDscdNm": "거래구분코드명",
"trDtlDscd": "거래상세구분코드",
"trDtlDscdNm": "거래상세구분코드명",
"lkgTrDtlDscd": "연동거래상세구분코드",
"rqsAmt": "요청금액",
"pcsAmt": "처리금액",
"trAfRmd": "잔액",
"trDt": "등록일시",
"trTm": "등록일시",
"cnclDscd": "취소여부",
"dtlList": [
{
"uscoNm": "이용사명",
"mbrID": "이용사 회원ID",
"mrstNo": "상점ID",
"mrstNm": "상점명",
"trAprvNo": "승인번호",
"prdNm": "상품명",
"trDscd": "거래구분코드",
"trDscdNm": "거래구분코드명",
"trDtlDscd": "거래상세구분코드",
"trDtlDscdNm": "거래상세구분코드명",
"lkgTrDtlDscd": "연동거래상세구분코드",
"extDt": "만료일자",
"rqsAmt": "요청금액",
"pcsAmt": "처리금액",
"trAfRmd": "잔액",
"trDt": "등록일시",
"trTm": "등록일시",
"cnclDscd": "취소여부"
}
]
}
]
}
}
JSON
복사
5.5. 포인트 만료거래내역조회
해당 기간에 만료되는 포인트 거래내역을 조회하는 API
•
HTTP Header Information
URL | 요청 도메인 + /point/expMngList |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 길이 | 설명 |
1 | uscoSno | 이용사번호 | Y | Long | ||
2 | mbrID | 회원ID | N | String | 100 | 이용사의 회원 ID |
3 | stcd | 상태코드 | N | String | 91: 만료포인트 , 01 : 정상포인트 | |
3 | trDtlDscd | 결제구분코드 | N | String[] | 2 | |
4 | lkgTrDtlDscd | 연동상세구분코드 | N | String[] | 2 | |
5 | expDtStart | 만료일자(FROM) | Y | String | 8 | YYYYMMDD |
6 | expDtEnd | 만료일자(TO) | Y | String | 8 | YYYYMMDD |
7 | pagNo | 페이지번호 | Y | int | ||
8 | pagSz | 페이징 크기 | Y | int |
{
"uscoSno": "이용사일련번호",
"mbrID" :"회원ID",
"trDscd" :["거래구분코드1","거래구분코드2"]
"trDtlDscd" :["결제구분코드1","결제구분코드2"]
"lkgTrDtlDscd" : ["연동상세구분코드1","연동상세구분코드2"]
"expDtStart" :"만료일자(시작일)",
"expDtEnd" :"만료일자(종료일)",
"pagNo" :"페이지번호",
"pagSz" :"페이지사이즈"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 길이 | 설명 |
1 | sucsFalr | Y | String | 성공 실패 여부 | ||
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | ||
3 | rsltMesg | Y | String | 응답 메시지 | ||
8 | rsltObj | N | JSON | API별 응답 데이터 | ||
8-1 | uscoSno | 이용사번호 | Y | Long | ||
8-2 | ttlExpCnt | 총 만료 건 수 | Y | Long | ||
8-3 | ttlExpAmt | 총 만료 금액 | Y | Long | ||
8-4 | ttlExpUsrCnt | 만료된 회원 수 | Y | Long | ||
8-5 | ttlExprsAmt | 총 만료 예정 금액 | Y | Long | ||
8-6 | ttlExprsCnt | 총 만료 예정 건 수 | Y | Long | ||
[rmdList] | Y | |||||
1) | mbrID | 이용사 회원 일련번호 | Y | String | ||
2) | mbrNm | 회원명 | Y | String | ||
3) | trDtlDscd | 포인트 종류 | Y | String | 2 | 정산포인트(”PP”), 장부형포인트(”PF”) |
4) | lkgTrDtlDscd | 포인트 구분코드 | Y | String | 2 | |
5) | autoYn | 지급구분 | Y | String | 1 | 자동(”Y”), 수동(”N”) |
6) | payAmt | 지급금액 | Y | Long | ||
7) | useAmt | 사용금액 | Y | Long | ||
8) | expAmt | 만료금액 | Y | Long | ||
9) | rmdAmt | 잔여금액 | Y | Long | ||
10) | expDt | 만료일자 | Y | String | 8 | YYYYMMDD |
11) | enrDtTm | 등록일시 | Y | String | 15 | YYYYMMDD hhmmss |
12) | usPsbDt | 사용가능일자 | Y | String | 8 | YYYYMMDD |
{
"sucsFalr": "성공실패여부(success/fail)",
"rsltCd": "응답코드",
"rsltMesg": "응답메시지",
"rsltObj": {
"uscoSno": "이용사번호",
"ttExpAmt": "총 만료 금액",
"ttExpCnt": "총 만료 건 수",
"ttExprsAmt": "총 만료 예정 금액",
"ttExprsCnt": "총 만료 예정 건 수",
"ttExpUsrCnt": "만료된 회원 수",
"rmdList": [
{
"mbrID": "이용사 회원ID",
"mbrNm": "회원명",
"trDtlDscd": "포인트 종류",
"lkgTrDtlDscd": "포인트 구분코드",
"autoYn": "지급구분",
"payAmt": "지급금액",
"useAmt": "사용금액",
"expAmt": "만료금액",
"rmdAmt": "잔여금액",
"stcd": "상태코드",
"expDt": "만료일자",
"enrDt": "등록일시",
"usPsbDt": "사용가능일자"
}
]
}
}
JSON
복사