API 문서
전체 API
서비스
보유 스탬프카드 목록 조회동기
버전: v1
버전: v1
/api/v1/stamp/cards/list
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
stampCardList
array of objects
옵션
스탬프카드 단순정보
stampCardList_item
object
옵션
stampId
string
옵션
길이 : 20
스탬프 정책 아이디
cardNo
number
옵션
값 : 20
스탬프 카드번호
policyName
string
옵션
최소 : 1 , 최대 : 50
스탬프 정책명
merchantId
string
옵션
길이 : 15
스탬프정책에 등록된 코나 가맹점아이디
merchantType
string
옵션
길이 : 2
가맹점타입
MC : 코나가맹점
currentCount
number
옵션
최소 : 0 , 최대 : 9999999999999999999
카드 총 적립개수
targetCount
number
옵션
최소 : 0 , 최대 : 9999999999999999999
스탬프정책 완성개수
status
string
옵션
최소 : 1 , 최대 : 10
스탬프카드 상태
ACTIVE : 적립가능
TERMINATED : 적립불가 (보상완료/만료)
statusCode
string
옵션
길이 : 2
스탬프카드 상태 상세
01 : 활성화
02 : 스탬프 카드 완성 후 보상 완료
03 : 스탬프 카드 유효기간 만료
05 : 공카드 (스탬프 카드에 적립된 스탬프 개수 0개)
policyEnable
string
옵션
길이 : 1
정책 사용가능여부
Y : 사용가능 (스탬프 정책의 유효기간 별도 확인 필요)
N : 사용불가 (정책 사용불가 시 마일리지 카드가 활성화 상태여도 적립 불가능함)
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를 확인하세요.
