API 문서
전체 API
서비스
발급 카드 목록 조회 (관리자용)동기
버전: v1
버전: v1
/api/v1/admin/issued-card/list
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
issuedCardList
array of objects
필수
발급 카드 목록
issuedCardList_item
object
옵션
serviceId
string
필수
길이 : 15
상품 ID
serviceName
string
필수
최소 : 1 , 최대 : 80
상품명
serviceGroupName
string
필수
최소 : 1 , 최대 : 255
상품 그룹 이름
cardType
string
필수
최소 : 1 , 최대 : 6
카드 타입
- CARDSE : 실물 카드
- MOBILE : 모바일 카드
mobileCardNo
string
옵션
길이 : 16
(모바일카드)카드 번호
mobileCardStatus
string
옵션
최소 : 1 , 최대 : 7
(모바일카드) 카드 사용 유효기간
- 형식 : yyyyMMdd
mobileExpiryDate
string
필수
길이 : 8
(실물카드) 카드 번호
physicalCardNo
string
옵션
길이 : 16
(실물카드) 카드 번호
physicalCardStatus
string
옵션
최소 : 1 , 최대 : 7
(실물카드)카드의 상태
- ACTIVE : 정상
- SUSPENDED : 중지
expiryDate
string
필수
길이 : 8
카드 사용 유효기간
- 형식 : yyyyMMdd
balance
number
필수
최소 : 0 , 최대 : 9999999999
카드에 충전되어 있는 잔액 정보
userId
number
필수
최소 : 1 , 최대 : 9999999999999999999
회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.
issuedDateTime
string
필수
길이 : 14
카드 발급 일시
- 형식 : yyyyMMddHHmmss
pageResponse
object
필수
페이징 응답 정보
page
number
필수
최소 : 0 , 최대 : 1000
페이징 인덱스
- 기본값 = 0
totalPages
number
필수
최소 : 0 , 최대 : 1000
전체 페이지 수
numberOfElements
number
필수
최소 : 0 , 최대 : 10000
전체 목록 개수
응답 코드
Detailed classification and addition of error for unseccessful withfrawal
200
에러 코드
000_000
메시지
Success
설명
성공
400
에러 코드
000_002
메시지
Invalid input parameter.
설명
입력 파라미터 오류
400
에러 코드
023_009
메시지
Invalid card token.
설명
카드번호가 유효한 값이 아닌 경우
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.
