API Documentation
All API
Service
Card-User Mapped InquirySync
Version: v1
Version: v1
/api/v1/user/card/info
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
userId
number
Optional
Min : 0 , Max : 9999999999999999999
회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.
- 미등록 카드인 경우 null
balance
number
Required
Min : 0 , Max : 9999999999
카드에 충전되어 있는 잔액 정보
serviceId
string
Required
Length : 15
카드 상품 ID
- 카드 상품에 부여한 고유 식별 값입니다.
serviceName
string
Required
Min : 1 , Max : 256
카드 상품명
ownerKa
string
Optional
Length : 15
상품 소유 제휴사 ID
cashReceiptInfo
object
Optional
현금영수증 식별정보
- 회원이 현금영수증 식별정보를 등록한 경우에 확인 가능
approvalDiv
string
Required
Length : 1
거래구분(0: 소비자 소득공제용, 1: 사업자 지출증빙용)
idNo
string
Required
Length : 20
신분확인번호
- 현금영수증 카드번호
- 휴대폰번호
- 사업자번호
manYn
string
Required
Length : 1
신분확인번호구분
- 0 : 카드 번호
- 1 : 수기 (휴대폰, 사업자 번호)
cardStatus
string
Optional
Min : 1 , Max : 7
카드 상태
- SUSPENDED : 정지
- ACTIVE : 정상
- TERMINATED : 폐기
isAutoRechargeBeforePayment
boolean
Required
결제시 잔액 부족한 경우 자동 충전 여부
Response Code
Detailed classification and addition of error for unseccessful withfrawal
200
Error code
000_000
Message
Success.
Description
성공
400
Error code
000_002
Message
Invalid input parameter.
Description
입력 파라미터 오류입니다.
400
Error code
000_003
Message
Missing required values. cardNo
Description
필수 파라미터가 누락되었습니다.
Test Data
Request
Response
Click Try It!
to start a Request and see the Response here!