API 문서
전체 API
서비스
마일리지카드 적립이력조회동기
버전: v1
버전: v1
/api/v1/mileage/cards/history
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
userMileageHistoryResList
array of objects
옵션
마일리지 카드 단순정보
userMileageHistoryResList_item
object
옵션
accumAmount
number
옵션
최소 : 0 , 최대 : 9999999999999999999
마일리지 카드에 누적된 금액
afterAccumAmount
number
옵션
최소 : 0 , 최대 : 9999999999999999999
누적후 금액
approvalDateTime
string
옵션
길이 : 16
승인 시간
형식 : yyyyMMddHHmmssSSS
createdDateTime
string
옵션
길이 : 16
생성일
형식 : yyyyMMddHHmmssSSS
reqAmount
number
옵션
최소 : 0 , 최대 : 9999999999999999999
누적 요청 금액
rewardStatus
string
옵션
최소 : 6 , 최대 : 8
마일리지카드의 완성에 따른 보상(쿠폰)의 처리상태
- 보상받은 이력이 없는 경우, null
- (type=10/11/12) 인 경우, 아래의 상태값을 가질 수 있습니다.
- REWARD : 보상완료
- (type=10/11/12) 외의 경우, 아래의 상태값을 가질 수 있습니다.
- WITHDRAW : 보상회수성공
- DISCARD : 보상회수실패
type
string
옵션
길이 : 2
적립유형
10 : 일반적립 - 가장 최근 수정된 마일리지카드 한 장에 모두 적립한 경우
11 : 적립(초과) - 한 장의 마일리지카드의 완성금액을 초과한 금액을 적립할 때 적립가능한 마일리지카드에 적립가능한 금액만큼만 적립
12 : 적립(초과금액이관) - (type="11")에서 적립할 수 없는 초과금액 만큼 신규 마일리지카드에 적립
40 : 일반적립취소 - 가장 최근 수정된 마일리지카드 한 장에서 모두 적립회수 가능한 경우
41 : 적립취소(초과) - 한 장의 마일리지카드에 적립된 금액을 초과하여 적립취소할 때 회수 가능한 마일리지카드에 회수가능한 금액만큼만 적립취소
42 : 적립취소(초과금액이관) - (type="41")에서 적립취소할 수 없는 초과금액만큼 직전 마일리지카드에서 회수
50 : 적립이력 망취소
updatedDateTime
string
옵션
길이 : 16
수정일
형식 : yyyyMMddHHmmssSSS
pageResponse
object
필수
페이징 응답 정보
page
number
필수
최소 : 0 , 최대 : 1000
현재 페이지
totalPages
number
필수
최소 : 0 , 최대 : 1000
전체 페이지 수
numberOfElements
number
필수
최소 : 0 , 최대 : 10000
전체 목록 개수
응답 코드
Detailed classification and addition of error for unseccessful withfrawal
200
에러 코드
000_000
메시지
Success.
설명
성공
500
에러 코드
000_001
메시지
Unknown Reason.
설명
알 수 없는 오류
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.
