API 문서
전체 API
서비스
카드 매핑 회원 조회동기
버전: v1
버전: v1
/api/v1/user/card/info
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
userId
number
옵션
최소 : 0 , 최대 : 9999999999999999999
회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.
- 미등록 카드인 경우 null
balance
number
필수
최소 : 0 , 최대 : 9999999999
카드에 충전되어 있는 잔액 정보
serviceId
string
필수
길이 : 15
카드 상품 ID
- 카드 상품에 부여한 고유 식별 값입니다.
serviceName
string
필수
최소 : 1 , 최대 : 256
카드 상품명
ownerKa
string
옵션
길이 : 15
상품 소유 제휴사 ID
cashReceiptInfo
object
옵션
현금영수증 식별정보
- 회원이 현금영수증 식별정보를 등록한 경우에 확인 가능
approvalDiv
string
필수
길이 : 1
거래구분(0: 소비자 소득공제용, 1: 사업자 지출증빙용)
idNo
string
필수
길이 : 20
신분확인번호
- 현금영수증 카드번호
- 휴대폰번호
- 사업자번호
manYn
string
필수
길이 : 1
신분확인번호구분
- 0 : 카드 번호
- 1 : 수기 (휴대폰, 사업자 번호)
cardStatus
string
옵션
최소 : 1 , 최대 : 7
카드 상태
- SUSPENDED : 정지
- ACTIVE : 정상
- TERMINATED : 폐기
isAutoRechargeBeforePayment
boolean
필수
결제시 잔액 부족한 경우 자동 충전 여부
응답 코드
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. cardNo
설명
필수 파라미터가 누락되었습니다.
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.
