어드민 포인트 지급

API Description

Doc. No. A12S1D1V1
API Title 포인트 > 어드민 포인트 지급
API Description 어드민(관리자)에 의한 포인트 적립을 요청하는 API 입니다.
Protocol HTTP Interface Type SYNC
HTTP METHOD POST Request URL /api/v1/point/admin/reward
Data Encryption Request : YES / Response : YES

Request Parameter

Field Type Length MOC Description
affiliateId STRING 15 CONDITIONAL 카드 포인트 지급에 필요한 제휴사 ID
- "pointType"값이 "CARD"값이면서 "isRewardByToken" 이 true인 경우 필수 값입니다.
pointType STRING 4 MANDATORY 지급할 포인트 타입
- USER : 유저 포인트 사용
- CARD : 카드 포인트 사용
validMonthLength NUMBER 1~99 CONDITIONAL 포인트가 유효한 개월 수
- expiryDate이 null인 경우 필수 값입니다.
expiryDate STRING 8 CONDITIONAL 포인트 지정 만료일
- 형식 : yyyyMMdd
- validMonthLength이 null인 경우 필수 값입니다.
policyId STRING 15 CONDITIONAL 포인트 정책 ID
- 조건 필드 : "pointType"값이 "CARD"값일 경우 설정
policyLimitMonthIgnored BOOLEAN OPTIONAL 유저당 캐시정책 월 지급 제한 무시 여부
- 기본값 : false
policyLimitYearIgnored BOOLEAN OPTIONAL 회원 당 캐시정책 년 지급 제한 무시 여부
- 기본값 : false
isRewardByToken BOOLEAN OPTIONAL 카드 번호를 이용한 카드 포인트 지급 여부
- 기본값 : false
pointRewardInfoList ARRAY MANDATORY 포인트 발급 정보 목록
userId NUMBER 1~999999999999 CONDITIONAL 회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.
- "isRewardByToken"이 false인 경우, 필수 값입니다.
cardNo STRING 16 CONDITIONAL 지급 대상 카드
- "pointType"값이 "CARD"값이면서 "isRewardByToken"이 true인 경우 필수 값입니다.
par STRING 27 CONDITIONAL 지급 대상이 되는 par
- "pointType"값이 "CARD"값이면서 "isRewardByToken"이 false인 경우 필수 값입니다.
amount NUMBER 0~999999999999 MANDATORY 지급할 포인트
transactionId STRING 50 OPTIONAL 외부 연동 거래 코드
adminPointMessageInfo OBJECT MANDATORY 지급 사유 정보
reason STRING 1~255 MANDATORY 지급 사유
pointProviderGroupId STRING 2 OPTIONAL 포인트 지급 시 분담 그룹 정보
- 기본값 : "01"

Response Parameter

Field Type Length MOC Description
policyId STRING 15 CONDITIONAL 포인트 정책 ID
- "pointType"값이 "CARD"값일 경우 필수 값
pointType STRING 4 MANDATORY 지급한 포인트 타입
- USER : 유저 포인트 사용
- CARD : 카드 포인트 사용
policyName STRING 1~255 CONDITIONAL 포인트 정책명
- "pointType"값이 "CARD"값일 경우 필수 값
completedCount NUMBER 0~999999999999 MANDATORY 지급 완료 건수 입니다.
failedCount NUMBER 0~999999999999 MANDATORY 지급 실패 건수
totalPointAmount NUMBER 0~999999999999 MANDATORY 총 지급된 포인트
pointRewardInfoList OBJECT MANDATORY 포인트 지급 정보 목록
userId NUMBER 0~999999999999 MANDATORY 회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.
- 포인트를 지급 받은 회원의 ID입니다.
cardNo STRING 16 CONDITIONAL 지급 대상 카드
- "pointType"값이 "CARD"값이면서 "isRewardByToken" 이 true인 경우 필수 값입니다.
par STRING 27 CONDITIONAL 카드 포인트를 지급 받은 카드의 par
- "pointType"값이 "CARD"값일 경우 필수 값
amount NUMBER 0~999999999999 MANDATORY 지급할 포인트
fixedAmount NUMBER 0~999999999999 MANDATORY 실제 지급 받은 포인트
status STRING 6~9 MANDATORY 지급 성공 여부
- COMPLETED : 지급 완료
- FAILED : 지급 실패
reason STRING 1~255 MANDATORY 지급 결과 사유
transactionId STRING 50 OPTIONAL 외부 연동 거래 코드
response OBJECT MANDATORY 응답 결과 값
code STRING 1~7 MANDATORY 응답 결과 코드
description STRING 1~255 MANDATORY 응답 결과 상세 설명

Response Code

HTTP Status Error code Message Description
프로토콜 항목의 "공통 Error Message 정보"에서 추가 확인 바랍니다.

Example

Request


            

Response