API Documentation
All API
Service
Unregistered card inquirySync
Version: v1
Version: v1
/api/v1/unregister/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
cardDataInfo
object
Required
카드 정보
par
string
Required
Length : 27
카드의 PAN(Primary Account Number)을 대체하는 번호
serviceId
string
Required
Length : 15
카드 상품 ID
- 카드 상품에 부여한 고유 식별 값입니다.
serviceName
string
Required
Min : 1 , Max : 255
카드 상품명
serviceImageUrl
string
Required
Min : 1 , Max : 255
카드 상품의 이미지 파일 URL
affiliateId
string
Required
Length : 15
같은 ASP 내에서 제휴사를 구별하기 위한 값
rechargeable
boolean
Required
카드의 충전 가능 여부
아래 항목의 충전 가능여부를 설정합니다.
- OFFLINE 단말기 충전
- 개인계좌 충전
- 포탈을 통한 ADMIN 충전
refundable
boolean
Required
카드의 환불 가능 여부
remittable
boolean
Required
카드의 송금 가능 여부
아래 항목에 대한 잔액 송금 가능 여부를 설정합니다.
- 휴대 전화번호로 송금
- 카드번호로 송금
personalRechargeable
boolean
Required
카드의 개인계좌를 통한 충전 가능 여부
balance
number
Required
Min : 0 , Max : 9999999999
카드에 충전되어 있는 잔액 정보
expiryDate
string
Required
Length : 8
카드 사용 유효기간
- 형식 : yyyyMMdd
physicalCardNo
string
Optional
Length : 16
(실물카드) 카드 번호
physicalCardStatus
string
Optional
Min : 1 , Max : 7
(실물카드) 카드의 상태
- ACTIVE : 정상
- SUSPENDED : 중지
mobileCardNo
string
Optional
Length : 16
(모바일카드) 카드 번호
mobileCardStatus
string
Optional
Min : 1 , Max : 7
(모바일카드) 카드의 상태
- ACTIVE : 정상
- SUSPENDED : 중지
maxNonRealNameRechargeAmount
number
Required
Min : 0 , Max : 9999999999
무기명 카드에 충전할 수 있는 최대 금액
maxRealNameRechargeAmount
number
Required
Min : 0 , Max : 9999999999
기명화된 카드에 충전할 수 있는 최대 금액
minRechargeAmount
number
Required
Min : 0 , Max : 9999999999
카드에 충전시 최소 충전금액
rechargeableAmount
number
Required
Min : 0 , Max : 9999999999
카드에 충전 가능한 금액
- 무기명 카드의 경우 = 무기명카드 최대 충전금액(maxNonRealNameRechargeAmount) - 카드잔액(balance)
- 기명화된 카드의 경우 = 기명화카드 최대 충전금액(maxRealNameRechargeAmount) - 카드잔액(balance)
충전 가능 금액(예)
- maxNonRealNameRechargeAmount = 500,000
- balance = 300,000
- rechargeableAmount = 200,000 (maxNonRealNameRechargeAmount - balance)
overseaPaymentable
boolean
Optional
해외결제 가능여부
cardPointInfo
array of objects
Optional
카드 포인트 정보
cardPointInfo_item
object
Optional
pointPolicyId
string
Required
Length : 15
포인트 정책 ID
pointName
string
Required
Min : 1 , Max : 255
포인트 정책명
remainingPoint
number
Optional
Min : 0 , Max : 9999999999
(회원) 포인트 잔액
- 회원이 가지고 있는 포인트의 잔액
autoUse
boolean
Optional
포인트 자동사용 여부
rechargeUnitAmt
number
Optional
Min : 0 , Max : 9999999999
충전 단위 설정
Response Code
Detailed classification and addition of error for unseccessful withfrawal
200
Error code
000_000
Message
Success.
Description
성공
Test Data
Request
Response
Click Try It!
to start a Request and see the Response here!
