API 문서
전체 API
서비스
관리자 포인트 지급동기
버전: v1
버전: v1
/api/v1/point/admin/reward
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
policyId
string
조건부
길이 : 15
포인트 정책 ID
- "pointType"값이 "CARD"값일 경우 필수값
pointType
string
필수
길이 : 4
지급한 포인트 타입
- USER : 유저 포인트 사용
- CARD : 카드 포인트 사용
policyName
string
조건부
최소 : 1 , 최대 : 255
포인트 정책명 입니다.
- "pointType"값이 "CARD"값일 경우 필수값
completedCount
number
필수
값 : 0
지급 완료 건수 입니다
failedCount
number
필수
값 : 0
지급 실패 건수 입니다.
totalPointAmount
number
필수
값 : 0
총 지급된 포인트 입니다.
pointRewardInfoList
array of objects
필수
포인트 지급 정보 리스트 입니다.
pointRewardInfoList_item
object
옵션
userId
number
필수
최소 : 1 , 최대 : 9999999999999999999
회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.
- 포인트를 지급받은 회원의 ID입니다.
par
string
조건부
길이 : 27
카드 포인트를 지급받은 카드의 par 입니다.
- "pointType"값이 "CARD"값일 경우 필수값
cardNo
string
조건부
길이 : 16
지급 대상 카드
- "pointType"값이 "CARD"값이면서 "isRewardByToken" 이 ture인 경우 필수값입니다.
amount
number
필수
최소 : 0 , 최대 : 999999999999
지급할 포인트 입니다.
fixedAmount
number
필수
최소 : 0 , 최대 : 999999999999
실제 지급 받은 포인트 입니다.
status
string
필수
최소 : 6 , 최대 : 9
지급 성공 여부 입니다.
- COMPLETED : 지급 완료
- FAILED : 지급 실패
reason
string
필수
길이 : 0
지급 결과 사유 입니다
transactionId
string
옵션
길이 : 50
외부 연동 거래 코드 값입니다.
응답 코드
Detailed classification and addition of error for unseccessful withfrawal
200
에러 코드
000_000
메시지
Success.
설명
성공
400
에러 코드
000_002
메시지
Invalid input parameter.
설명
입력 파라미터 오류 테스트
400
에러 코드
000_003
메시지
Missing required values.
설명
필수값 누락 테스트
400
에러 코드
000_008
메시지
Internal service error.
설명
내부 서비스 오류.
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.