API Documentation
All API
Service
관리자 포인트 환수Sync
Version: v1
Version: v1
/api/v1/point/admin/deduction
Request Headers
Request Parameters
Response Headers
X-KM-Correlation-Id
string
Required
Length : 20
Transaction number for tracking trasncription
- Form : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7digit, Hex String
X-KM-Crypto-Key-Id
string
Optional
Length : 32
Data encryption/decryption key ID
- Given ID from creating the service provider's project
- If it is passed as a callback, the first key issued among the keys issued to the service provider is used.
Response Parameters
pointType
string
Required
Length : 4
환수할 포인트 타입
- USER : 유저 포인트 사용
- CARD : 카드 포인트 사용
completedCount
number
Required
Value : 0
환수 완료 건수 입니다.
failedCount
number
Required
Value : 0
환수 실패 건수 입니다.
totalPointAmount
number
Required
Value : 0
총 환수 된 포인트 입니다.
pointDeductionInfoList
array of objects
Required
포인트 환수 정보 리스트 입니다.
pointDeductionInfoList_item
object
Optional
userId
number
Required
Min : 1 , Max : 9999999999999999999
회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.
- 포인트를 환수 받는 회원의 ID입니다.
par
string
Conditional
Length : 27
카드 포인트를 환수 받는 카드의 par 입니다.
- "pointType"값이 "CARD"값일 경우 필수값
amount
number
Required
Min : 0 , Max : 999999999999
환수한 포인트 입니다.
status
string
Required
Min : 6 , Max : 9
환수 성공 여부 입니다.
- COMPLETED : 지급 완료
- FAILED : 지급 실패
- PARTIAL_SUCCESS: 부분환불(보유 포인트가 요청 포인트보다 적을 경우)
Response Code
Detailed classification and addition of error for unseccessful withfrawal
200
Error code
000_000
Message
Success.
Description
성공
200
Error code
000_000
Message
Success.
Description
환수실패
400
Error code
000_003
Message
Missing required values.
Description
필수값 누락
Test Data
Request
Response
Click Try It!
to start a Request and see the Response here!