API ๋ฌธ์
์ ์ฒด API
์๋น์ค
๋ณด์ ์นด๋ ์กฐํ๋๊ธฐ
๋ฒ์ : v1
๋ฒ์ : v1
/api/v1/user/card/list
์๋ต ํค๋
X-KM-Correlation-Id
string
ํ์
๊ธธ์ด : 20
์ ๋ฌธ ์ถ์ ์ ์ํ ๊ฑฐ๋๋ฒํธ
- ํ์ : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7์๋ฆฌ, Hex String
X-KM-Crypto-Key-Id
string
์ต์
๊ธธ์ด : 32
๋ฐ์ดํฐ์๋ณตํธํ ํค ID
- ์๋น์ค ์ฌ์ ์์ ํ๋ก์ ํธ์์ ์์ฑ ์ ๋ถ์ฌํ ID์ ๋๋ค
- Callback์ผ๋ก ์ ๋ฌ๋ ๊ฒฝ์ฐ ์๋น์ค ์ฌ์ ์์๊ฒ ๋ฐ๊ธ๋ ํค ์ค ๊ฐ์ฅ ๋จผ์ ๋ฐ๊ธ๋ ํค๋ฅผ ์ฌ์ฉ ํฉ๋๋ค.
์๋ต ํ๋ผ๋ฏธํฐ
cardDataInfo
array of objects
ํ์
์นด๋ ์ ๋ณด ๋ชฉ๋ก
cardDataInfo_item
object
์ต์
par
string
ํ์
๊ธธ์ด : 27
์นด๋์ PAN(Primary Account Number)์ ๋์ฒดํ๋ ๋ฒํธ
limits
object
์ต์
๊ฒฐ์ ํ๋ ์ ๋ณด
์ง๋ถ์นด๋์ธ ๊ฒฝ์ฐ์๋ง ์๋ต๋ฐ์ดํฐ์ ํฌํจ๋ฉ๋๋ค.
day
number
์ต์
์ต์ : 0 , ์ต๋ : 9999999999
์ผ ๊ฒฐ์ ํ๋
once
number
์ต์
์ต์ : 0 , ์ต๋ : 9999999999
1ํ ๊ฒฐ์ ํ๋
month
number
์ต์
์ต์ : 0 , ์ต๋ : 9999999999
์ ๊ฒฐ์ ํ๋
balance
number
ํ์
์ต์ : 0 , ์ต๋ : 9999999999
์นด๋์ ์ถฉ์ ๋์ด ์๋ ์์ก ์ ๋ณด
pendingAmount
number
ํ์
์ต์ : 0 , ์ต๋ : 9999999999
์ถฉ์ ๋๊ธฐ๊ธ ๊ธ์ก
- ์นด๋์ ํ๋๋ฅผ ์ด๊ณผํ๋ ์ถฉ์ ์์ฒญ์ด ์ ์๋์ด, ์์ง ์ฒ๋ฆฌ๋์ง ์๊ณ ์ถฉ์ ๋๊ธฐ ์ค์ธ ๊ธ์ก.
isNamed
boolean
ํ์
์นด๋ ๊ธฐ๋ช ํ ์ฌ๋ถ
- ๊ธฐ๋ช ํ๋? ๋ฌด๊ธฐ๋ช ์ผ๋ก ๋ฐํ๋ ์นด๋๋ฅผ ์ ๋ถ์ ์์ง๊ธ์๋จ์ ๋ฒ์์ ์ ํ๋ '์ค์ง๋ช ์ ์ธ์ฆ' ๋๋ '์๊ธ๊ณ์ข์ ์ฐ๊ฒฐํ๋ ๋ฐฉ์'์ ํตํ์ฌ ํด๋น ์ ๋ถ์ ์์ง๊ธ์๋จ์ ์ด์ฉ์๋ก ํน์ ํ๋ ํ์๋ฅผ ๋งํฉ๋๋ค.
bankInfo
object
์ต์
์ง๋ถ์นด๋์ ์ฐ๊ฒฐ๋ ๊ณ์ข ์ ๋ณด
์ง๋ถ์นด๋์ธ ๊ฒฝ์ฐ์๋ง ์๋ต๋ฐ์ดํฐ์ ํฌํจ๋ฉ๋๋ค.
bankName
string
ํ์
์ต์ : 1 , ์ต๋ : 10
์ํ ์ด๋ฆ
accountNo
string
ํ์
์ต์ : 1 , ์ต๋ : 20
์ํ ๊ณ์ข ๋ฒํธ
enableFIC
boolean
ํ์
ํ๊ธIC ํฌํจ ์ฌ๋ถ
- true : ํ๊ธIC ํฌํจ
- false : ํ๊ธIC ๋ฏธํฌํจ
์ง๋ถ์นด๋์ธ ๊ฒฝ์ฐ์๋ง ์๋ต๋ฐ์ดํฐ์ ํฌํจ๋ฉ๋๋ค.
serviceId
string
ํ์
๊ธธ์ด : 15
์นด๋ ์ํ ID
- ์นด๋ ์ํ์ ๋ถ์ฌํ ๊ณ ์ ์๋ณ ๊ฐ์ ๋๋ค.
expiryDate
string
ํ์
๊ธธ์ด : 8
์นด๋ ์ฌ์ฉ ์ ํจ๊ธฐ๊ฐ
- ํ์ : yyyyMMdd
refundable
boolean
ํ์
์นด๋์ ํ๋ถ ๊ฐ๋ฅ ์ฌ๋ถ
remittable
boolean
ํ์
์นด๋์ ์ก๊ธ ๊ฐ๋ฅ ์ฌ๋ถ
์๋ ํญ๋ชฉ์ ๋ํ ์์ก ์ก๊ธ ๊ฐ๋ฅ ์ฌ๋ถ๋ฅผ ์ค์ ํฉ๋๋ค.
- ํด๋ ์ ํ๋ฒํธ๋ก ์ก๊ธ
- ์นด๋๋ฒํธ๋ก ์ก๊ธ
cardApplyNo
string
์ต์
๊ธธ์ด : 22
์นด๋ ์ ์ฒญ ๋ฒํธ
- (ํ์) ๋ชจ๋ฐ์ผ ์นด๋ ๋๋ ์ค๋ฌผ ์นด๋๋ฅผ ๋ฐ๊ธ/๋ฐฐ์ก ์ ์ฒญํ ๋ ์์ฑ๋๋ ๊ณ ์ ๋ฒํธ
serviceName
string
ํ์
์ต์ : 1 , ์ต๋ : 255
์นด๋ ์ํ๋ช
mobileCardNo
string
์ต์
๊ธธ์ด : 16
(๋ชจ๋ฐ์ผ์นด๋) ์นด๋ ๋ฒํธ
rechargeable
boolean
ํ์
์นด๋์ ์ถฉ์ ๊ฐ๋ฅ ์ฌ๋ถ
์๋ ํญ๋ชฉ์ ์ถฉ์ ๊ฐ๋ฅ์ฌ๋ถ๋ฅผ ์ค์ ํฉ๋๋ค.
- OFFLINE ๋จ๋ง๊ธฐ ์ถฉ์
- ๊ฐ์ธ๊ณ์ข ์ถฉ์
- ํฌํ์ ํตํ ADMIN ์ถฉ์
cardPointInfo
array of objects
์ต์
์นด๋ ํฌ์ธํธ ์ ๋ณด
cardPointInfo_item
object
์ต์
autoUse
boolean
ํ์
ํฌ์ธํธ ์๋์ฌ์ฉ ์ฌ๋ถ
- ํฌ์ธํธ ์ ์ฑ ์ ์ค์ ๋ ๊ฐ
pointName
string
ํ์
์ต์ : 1 , ์ต๋ : 255
ํฌ์ธํธ ์ ์ฑ ๋ช
pointPolicyId
string
ํ์
๊ธธ์ด : 15
ํฌ์ธํธ ์ ์ฑ ID
remainingPoint
number
์ต์
์ต์ : 0 , ์ต๋ : 9999999999
(ํ์) ํฌ์ธํธ ์์ก
- ํ์์ด ๊ฐ์ง๊ณ ์๋ ํฌ์ธํธ์ ์์ก
physicalCardNo
string
์ต์
๊ธธ์ด : 16
(์ค๋ฌผ์นด๋) ์นด๋ ๋ฒํธ
serviceImageUrl
string
ํ์
์ต์ : 1 , ์ต๋ : 255
์นด๋ ์ํ์ ์ด๋ฏธ์ง ํ์ผ URL
autoReloadStatus
string
์ต์
์ต์ : 1 , ์ต๋ : 8
์นด๋์ ์๋์ถฉ์ ์ํ
- ACTIVE : ํ์ฑํ
- INACTIVE : ๋นํ์ฑํ
- NONE : ์ค์ ์ํจ
mobileCardStatus
string
ํ์
์ต์ : 1 , ์ต๋ : 7
(๋ชจ๋ฐ์ผ์นด๋) ์นด๋์ ์ํ
- ACTIVE : ์ ์
- SUSPENDED : ์ค์ง
minRechargeAmount
number
ํ์
์ต์ : 0 , ์ต๋ : 9999999999
์นด๋์ ์ถฉ์ ์ ์ต์ ์ถฉ์ ๊ธ์ก
physicalCardStatus
string
์ต์
์ต์ : 1 , ์ต๋ : 7
(์ค๋ฌผ์นด๋) ์นด๋์ ์ํ
- ACTIVE : ์ ์
- SUSPENDED : ์ค์ง
rechargeableAmount
number
ํ์
์ต์ : 0 , ์ต๋ : 9999999999
์นด๋์ ์ถฉ์ ๊ฐ๋ฅํ ๊ธ์ก
- ๋ฌด๊ธฐ๋ช ์นด๋์ ๊ฒฝ์ฐ = ๋ฌด๊ธฐ๋ช ์นด๋ ์ต๋ ์ถฉ์ ๊ธ์ก(maxNonRealNameRechargeAmount) - ์นด๋์์ก(balance)
- ๊ธฐ๋ช ํ๋ ์นด๋์ ๊ฒฝ์ฐ = ๊ธฐ๋ช ํ์นด๋ ์ต๋ ์ถฉ์ ๊ธ์ก(maxRealNameRechargeAmount) - ์นด๋์์ก(balance)
์ถฉ์ ๊ฐ๋ฅ ๊ธ์ก(์)
- maxNonRealNameRechargeAmount = 500000
- maxRealNameRechargeAmount = 2000000
- balance = 300000
๋ฌด๊ธฐ๋ช ์นด๋์ธ ๊ฒฝ์ฐ = 200000(500000 - 300000)
๊ธฐ๋ช ํ๋ ์นด๋์ธ ๊ฒฝ์ฐ = 1700000(2000000 - 300000)
personalRechargeable
boolean
ํ์
์นด๋์ ๊ฐ์ธ๊ณ์ข๋ฅผ ํตํ ์ถฉ์ ๊ฐ๋ฅ ์ฌ๋ถ
maxRealNameRechargeAmount
number
ํ์
์ต์ : 0 , ์ต๋ : 9999999999
๊ธฐ๋ช ํ๋ ์นด๋์ ์ถฉ์ ํ ์ ์๋ ์ต๋ ๊ธ์ก
maxNonRealNameRechargeAmount
number
ํ์
์ต์ : 0 , ์ต๋ : 9999999999
๋ฌด๊ธฐ๋ช ์นด๋์ ์ถฉ์ ํ ์ ์๋ ์ต๋ ๊ธ์ก
rechargeUnitAmt
number
์ต์
์ต์ : 0 , ์ต๋ : 9999999999
์ถฉ์ ๋จ์ ์ค์
cardLifeStatus
string
ํ์
๊ธธ์ด : 2
์นด๋ ์์ฅ ์ํ ๊ตฌ๋ถ๊ฐ
- 30 : ์ ์ง
- 60 : ํ์ฑํ
- 90 : ์ญ์
cardBizStatus
string
ํ์
๊ธธ์ด : 2
์นด๋์ํ ์ฝ๋
- 31: ์นด๋ ๋ถ์ค๋ก ์ธํ ์ ์งใ
- 36: ์นด๋ ์๋ น ์ ์ ์ง
- 3A: ์นด๋ ์ฌ๋ฐ๊ธ์ผ๋ก ์ธํ ์ค์ง
- 60: ์ ์
- 61: ์นด๋ ๋ถ์ค ์ ๊ณ ํด์ง
- 35: ์นด๋ ์ ํจ ๊ธฐ๊ฐ ๋ง๋ฃ๋ก ์ธํ ์ค์ง
accTransferStatus
string
ํ์
๊ธธ์ด : 1
๋ชจ๋ ์ด์ฒด ์งํ์ํ (์ถฉ์ ์ทจ์, ํ๋ถ์ด์ฒด ์งํ ์ํ)
- 0 : ํด๋น ์์
- 1 : ์ด์ฒด ์งํ์ค
enableVirtualAccountPendingAmount
boolean
ํ์
๊ฐ์๊ณ์ข ์ถฉ์ ๋๊ธฐ๊ธ ์ฌ์ฉ ์ฌ๋ถ
virtualAccountMaxPendingAmount
number
ํ์
์ต์ : 0 , ์ต๋ : 9999999999
๊ฐ์๊ณ์ข ์ถฉ์ ๋๊ธฐ๊ธ ์ต๋ ๊ธ์ก
- ์นด๋ ์์ก + ์ถฉ์ ๋๊ธฐ๊ธ ์์ก์ ์ต๋ ํ์ฉ ๊ธ์ก
์๋ต ์ฝ๋
Detailed classification and addition of error for unseccessful withfrawal
200
์๋ฌ ์ฝ๋
000_000
๋ฉ์์ง
Success.
์ค๋ช
์ฑ๊ณต
400
์๋ฌ ์ฝ๋
000_002
๋ฉ์์ง
Invalid input parameter. userId
์ค๋ช
์ ๋ ฅ ํ๋ผ๋ฏธํฐ ์ค๋ฅ์ ๋๋ค.
400
์๋ฌ ์ฝ๋
000_003
๋ฉ์์ง
Missing required values. userId
์ค๋ช
ํ์ ํ๋ผ๋ฏธํฐ๊ฐ ๋๋ฝ๋์์ต๋๋ค.
400
์๋ฌ ์ฝ๋
001_006
๋ฉ์์ง
Wallet user not found.
์ค๋ช
ํ์์ด ์๋๊ฑฐ๋ ํํดํ ํ์์ ๋๋ค.
ํ ์คํธ ๋ฐ์ดํฐ
Request
Response
Try It!์ ํด๋ฆญํ์ฌ
์
๋ ฅํ Request์ Response๋ฅผ ํ์ธํ์ธ์.