API Documentation

All API

Service


Search for CardSync

Version: v1


Version: v1

POST

/api/v1/user/card/list

The list of cards held by a member and card information are provided as follows. โ€ข Card product information โ€ข Balance information โ€ข Expiry date โ€ข Card status โ€ข Card number โ€ข Payment limits โ€ข Point โ€ข Linked accounts (for debit card)

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

Encrypted|
Check out
Guidelines
for more information.

cardDataInfo

array of objects

Required

์นด๋“œ ์ •๋ณด ๋ชฉ๋ก

cardDataInfo_item

object

Optional

cardDataInfo_item content

par

string

Required

Length : 27

์นด๋“œ์˜ PAN(Primary Account Number)์„ ๋Œ€์ฒดํ•˜๋Š” ๋ฒˆํ˜ธ

limits

object

Optional

๊ฒฐ์ œ ํ•œ๋„ ์ •๋ณด

์ง๋ถˆ์นด๋“œ์ธ ๊ฒฝ์šฐ์—๋งŒ ์‘๋‹ต๋ฐ์ดํ„ฐ์— ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.


day

number

Optional

Min : 0 , Max : 9999999999

์ผ ๊ฒฐ์ œ ํ•œ๋„

once

number

Optional

Min : 0 , Max : 9999999999

1ํšŒ ๊ฒฐ์ œ ํ•œ๋„

month

number

Optional

Min : 0 , Max : 9999999999

์›” ๊ฒฐ์ œ ํ•œ๋„

balance

number

Required

Min : 0 , Max : 9999999999

์นด๋“œ์— ์ถฉ์ „๋˜์–ด ์žˆ๋Š” ์ž”์•ก ์ •๋ณด

pendingAmount

number

Required

Min : 0 , Max : 9999999999

์ถฉ์ „ ๋Œ€๊ธฐ๊ธˆ ๊ธˆ์•ก

  • ์นด๋“œ์˜ ํ•œ๋„๋ฅผ ์ดˆ๊ณผํ•˜๋Š” ์ถฉ์ „ ์š”์ฒญ์ด ์ ‘์ˆ˜๋˜์–ด, ์•„์ง ์ฒ˜๋ฆฌ๋˜์ง€ ์•Š๊ณ  ์ถฉ์ „ ๋Œ€๊ธฐ ์ค‘์ธ ๊ธˆ์•ก.

isNamed

boolean

Required

์นด๋“œ ๊ธฐ๋ช…ํ™” ์—ฌ๋ถ€

  • ๊ธฐ๋ช…ํ™”๋ž€? ๋ฌด๊ธฐ๋ช…์œผ๋กœ ๋ฐœํ–‰๋œ ์นด๋“œ๋ฅผ ์„ ๋ถˆ์ „์ž์ง€๊ธ‰์ˆ˜๋‹จ์„ ๋ฒ•์—์„œ ์ •ํ•˜๋Š” '์‹ค์ง€๋ช…์˜ ์ธ์ฆ' ๋˜๋Š” '์˜ˆ๊ธˆ๊ณ„์ขŒ์™€ ์—ฐ๊ฒฐํ•˜๋Š” ๋ฐฉ์‹'์„ ํ†ตํ•˜์—ฌ ํ•ด๋‹น ์„ ๋ถˆ์ „์ž์ง€๊ธ‰์ˆ˜๋‹จ์˜ ์ด์šฉ์ž๋กœ ํŠน์ •ํ•˜๋Š” ํ–‰์œ„๋ฅผ ๋งํ•ฉ๋‹ˆ๋‹ค.

bankInfo

object

Optional

์ง๋ถˆ์นด๋“œ์— ์—ฐ๊ฒฐ๋œ ๊ณ„์ขŒ ์ •๋ณด

์ง๋ถˆ์นด๋“œ์ธ ๊ฒฝ์šฐ์—๋งŒ ์‘๋‹ต๋ฐ์ดํ„ฐ์— ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.


bankName

string

Required

Min : 1 , Max : 10

์€ํ–‰ ์ด๋ฆ„

accountNo

string

Required

Min : 1 , Max : 20

์€ํ–‰ ๊ณ„์ขŒ ๋ฒˆํ˜ธ

enableFIC

boolean

Required

ํ˜„๊ธˆIC ํฌํ•จ ์—ฌ๋ถ€

  • true : ํ˜„๊ธˆIC ํฌํ•จ
  • false : ํ˜„๊ธˆIC ๋ฏธํฌํ•จ

์ง๋ถˆ์นด๋“œ์ธ ๊ฒฝ์šฐ์—๋งŒ ์‘๋‹ต๋ฐ์ดํ„ฐ์— ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.

serviceId

string

Required

Length : 15

์นด๋“œ ์ƒํ’ˆ ID

  • ์นด๋“œ ์ƒํ’ˆ์— ๋ถ€์—ฌํ•œ ๊ณ ์œ  ์‹๋ณ„ ๊ฐ’์ž…๋‹ˆ๋‹ค.

expiryDate

string

Required

Length : 8

์นด๋“œ ์‚ฌ์šฉ ์œ ํšจ๊ธฐ๊ฐ„

  • ํ˜•์‹ : yyyyMMdd

refundable

boolean

Required

์นด๋“œ์˜ ํ™˜๋ถˆ ๊ฐ€๋Šฅ ์—ฌ๋ถ€

remittable

boolean

Required

์นด๋“œ์˜ ์†ก๊ธˆ ๊ฐ€๋Šฅ ์—ฌ๋ถ€

์•„๋ž˜ ํ•ญ๋ชฉ์— ๋Œ€ํ•œ ์ž”์•ก ์†ก๊ธˆ ๊ฐ€๋Šฅ ์—ฌ๋ถ€๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.

  • ํœด๋Œ€ ์ „ํ™”๋ฒˆํ˜ธ๋กœ ์†ก๊ธˆ
  • ์นด๋“œ๋ฒˆํ˜ธ๋กœ ์†ก๊ธˆ

cardApplyNo

string

Optional

Length : 22

์นด๋“œ ์‹ ์ฒญ ๋ฒˆํ˜ธ

  • (ํšŒ์›) ๋ชจ๋ฐ”์ผ ์นด๋“œ ๋˜๋Š” ์‹ค๋ฌผ ์นด๋“œ๋ฅผ ๋ฐœ๊ธ‰/๋ฐฐ์†ก ์‹ ์ฒญํ• ๋•Œ ์ƒ์„ฑ๋˜๋Š” ๊ณ ์œ  ๋ฒˆํ˜ธ

serviceName

string

Required

Min : 1 , Max : 255

์นด๋“œ ์ƒํ’ˆ๋ช…

mobileCardNo

string

Optional

Length : 16

(๋ชจ๋ฐ”์ผ์นด๋“œ) ์นด๋“œ ๋ฒˆํ˜ธ

rechargeable

boolean

Required

์นด๋“œ์˜ ์ถฉ์ „ ๊ฐ€๋Šฅ ์—ฌ๋ถ€

์•„๋ž˜ ํ•ญ๋ชฉ์˜ ์ถฉ์ „ ๊ฐ€๋Šฅ์—ฌ๋ถ€๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.

  • OFFLINE ๋‹จ๋ง๊ธฐ ์ถฉ์ „
  • ๊ฐœ์ธ๊ณ„์ขŒ ์ถฉ์ „
  • ํฌํƒˆ์„ ํ†ตํ•œ ADMIN ์ถฉ์ „

cardPointInfo

array of objects

Optional

์นด๋“œ ํฌ์ธํŠธ ์ •๋ณด

cardPointInfo_item

object

Optional

cardPointInfo_item content

autoUse

boolean

Required

ํฌ์ธํŠธ ์ž๋™์‚ฌ์šฉ ์—ฌ๋ถ€

  • ํฌ์ธํŠธ ์ •์ฑ…์— ์„ค์ •๋œ ๊ฐ’

pointName

string

Required

Min : 1 , Max : 255

ํฌ์ธํŠธ ์ •์ฑ…๋ช…

pointPolicyId

string

Required

Length : 15

ํฌ์ธํŠธ ์ •์ฑ… ID

remainingPoint

number

Optional

Min : 0 , Max : 9999999999

(ํšŒ์›) ํฌ์ธํŠธ ์ž”์•ก

  • ํšŒ์›์ด ๊ฐ€์ง€๊ณ  ์žˆ๋Š” ํฌ์ธํŠธ์˜ ์ž”์•ก

physicalCardNo

string

Optional

Length : 16

(์‹ค๋ฌผ์นด๋“œ) ์นด๋“œ ๋ฒˆํ˜ธ

serviceImageUrl

string

Required

Min : 1 , Max : 255

์นด๋“œ ์ƒํ’ˆ์˜ ์ด๋ฏธ์ง€ ํŒŒ์ผ URL

autoReloadStatus

string

Optional

Min : 1 , Max : 8

์นด๋“œ์˜ ์ž๋™์ถฉ์ „ ์ƒํƒœ

  • ACTIVE : ํ™œ์„ฑํ™”
  • INACTIVE : ๋น„ํ™œ์„ฑํ™”
  • NONE : ์„ค์ •์•ˆํ•จ

mobileCardStatus

string

Required

Min : 1 , Max : 7

(๋ชจ๋ฐ”์ผ์นด๋“œ) ์นด๋“œ์˜ ์ƒํƒœ

  • ACTIVE : ์ •์ƒ
  • SUSPENDED : ์ค‘์ง€

minRechargeAmount

number

Required

Min : 0 , Max : 9999999999

์นด๋“œ์— ์ถฉ์ „์‹œ ์ตœ์†Œ ์ถฉ์ „๊ธˆ์•ก

physicalCardStatus

string

Optional

Min : 1 , Max : 7

(์‹ค๋ฌผ์นด๋“œ) ์นด๋“œ์˜ ์ƒํƒœ

  • ACTIVE : ์ •์ƒ
  • SUSPENDED : ์ค‘์ง€

rechargeableAmount

number

Required

Min : 0 , Max : 9999999999

์นด๋“œ์— ์ถฉ์ „ ๊ฐ€๋Šฅํ•œ ๊ธˆ์•ก

  • ๋ฌด๊ธฐ๋ช… ์นด๋“œ์˜ ๊ฒฝ์šฐ = ๋ฌด๊ธฐ๋ช…์นด๋“œ ์ตœ๋Œ€ ์ถฉ์ „๊ธˆ์•ก(maxNonRealNameRechargeAmount) - ์นด๋“œ์ž”์•ก(balance)
  • ๊ธฐ๋ช…ํ™”๋œ ์นด๋“œ์˜ ๊ฒฝ์šฐ = ๊ธฐ๋ช…ํ™”์นด๋“œ ์ตœ๋Œ€ ์ถฉ์ „๊ธˆ์•ก(maxRealNameRechargeAmount) - ์นด๋“œ์ž”์•ก(balance)

 

์ถฉ์ „ ๊ฐ€๋Šฅ ๊ธˆ์•ก(์˜ˆ)

  • maxNonRealNameRechargeAmount = 500000
  • maxRealNameRechargeAmount = 2000000
  • balance = 300000

๋ฌด๊ธฐ๋ช… ์นด๋“œ์ธ ๊ฒฝ์šฐ = 200000(500000 - 300000)

๊ธฐ๋ช…ํ™”๋œ ์นด๋“œ์ธ ๊ฒฝ์šฐ = 1700000(2000000 - 300000)

personalRechargeable

boolean

Required

์นด๋“œ์˜ ๊ฐœ์ธ๊ณ„์ขŒ๋ฅผ ํ†ตํ•œ ์ถฉ์ „ ๊ฐ€๋Šฅ ์—ฌ๋ถ€

maxRealNameRechargeAmount

number

Required

Min : 0 , Max : 9999999999

๊ธฐ๋ช…ํ™”๋œ ์นด๋“œ์— ์ถฉ์ „ํ•  ์ˆ˜ ์žˆ๋Š” ์ตœ๋Œ€ ๊ธˆ์•ก

maxNonRealNameRechargeAmount

number

Required

Min : 0 , Max : 9999999999

๋ฌด๊ธฐ๋ช… ์นด๋“œ์— ์ถฉ์ „ํ•  ์ˆ˜ ์žˆ๋Š” ์ตœ๋Œ€ ๊ธˆ์•ก

rechargeUnitAmt

number

Optional

Min : 0 , Max : 9999999999

์ถฉ์ „ ๋‹จ์œ„ ์„ค์ •

cardLifeStatus

string

Required

Length : 2

์นด๋“œ ์›์žฅ ์ƒํƒœ ๊ตฌ๋ถ„๊ฐ’

  • 30 : ์ •์ง€
  • 60 : ํ™œ์„ฑํ™”
  • 90 : ์‚ญ์ œ

cardBizStatus

string

Required

Length : 2

์นด๋“œ์ƒํƒœ ์ฝ”๋“œ

  • 31: ์นด๋“œ ๋ถ„์‹ค๋กœ ์ธํ•œ ์ •์ง€ใ€€
  • 36: ์นด๋“œ ์ˆ˜๋ น ์ „ ์ •์ง€
  • 3A: ์นด๋“œ ์žฌ๋ฐœ๊ธ‰์œผ๋กœ ์ธํ•œ ์ค‘์ง€
  • 60: ์ •์ƒ
  • 61: ์นด๋“œ ๋ถ„์‹ค ์‹ ๊ณ  ํ•ด์ง€
  • 35: ์นด๋“œ ์œ ํšจ ๊ธฐ๊ฐ„ ๋งŒ๋ฃŒ๋กœ ์ธํ•œ ์ค‘์ง€

accTransferStatus

string

Required

Length : 1

๋ชจ๋“  ์ด์ฒด ์ง„ํ–‰์ƒํƒœ (์ถฉ์ „์ทจ์†Œ, ํ™˜๋ถˆ์ด์ฒด ์ง„ํ–‰ ์ƒํƒœ)

  • 0 : ํ•ด๋‹น ์—†์Œ
  • 1 : ์ด์ฒด ์ง„ํ–‰์ค‘

enableVirtualAccountPendingAmount

boolean

Required

๊ฐ€์ƒ๊ณ„์ขŒ ์ถฉ์ „ ๋Œ€๊ธฐ๊ธˆ ์‚ฌ์šฉ ์—ฌ๋ถ€

virtualAccountMaxPendingAmount

number

Required

Min : 0 , Max : 9999999999

๊ฐ€์ƒ๊ณ„์ขŒ ์ถฉ์ „ ๋Œ€๊ธฐ๊ธˆ ์ตœ๋Œ€ ๊ธˆ์•ก

  • ์นด๋“œ ์ž”์•ก + ์ถฉ์ „ ๋Œ€๊ธฐ๊ธˆ ์ž”์•ก์˜ ์ตœ๋Œ€ ํ—ˆ์šฉ ๊ธˆ์•ก

Response Code

Detailed classification and addition of error for unseccessful withfrawal


200

Error code

000_000

Message

Success.

Description

Success


400

Error code

000_002

Message

Invalid input parameter. userId

Description

Invalid input parameter


400

Error code

000_003

Message

Missing required values. userId

Description

Missing required parameter


400

Error code

001_006

Message

Wallet user not found.

Description

Non-member or a member who has canceled membership

Test Data

200 - Test succeeded


200 - Test succeeded
200 - Test succeeded _no card owned by a member
400 - Invalid input parameter
400 - Missing required parameter
400 - Non-member or a member who has canceled membership
200 - ์„ฑ๊ณต ํ…Œ์ŠคํŠธ_PAR ํŒŒ๋ผ๋ฏธํ„ฐ ์‚ฌ์šฉ ์ผ€์ด์Šค
200 - ์„ฑ๊ณต ํ…Œ์ŠคํŠธ_cardNo ํŒŒ๋ผ๋ฏธํ„ฐ ์‚ฌ์šฉ ์ผ€์ด์Šค
Loading ...

Request

Loading...

Response

Click Try It!
to start a Request and see the Response here!


User RegisterSearch for Member InformationMember Password Reset and ChangeMember Information ChangeMembership CancellationChecking Log in ID checkActivation of Dormant MemberSearch for Terms and Conditions ListTerms and Conditions Agreement/WithdrawalCI ๊ฐ’์œผ๋กœ ํšŒ์› ์ •๋ณด ์กฐํšŒํšŒ์› ๋กœ๊ทธ์ธ ID ์ค‘๋ณต ํ™•์ธํšŒ์› ๋น„๋ฐ€๋ฒˆํ˜ธ ๊ฒ€์ฆํšŒ์› ์ธ์ฆ ์ •๋ณด ์กฐํšŒFinancial Institution List InquiryReal Name Verification for Account holderAuthentication code generation before ARS authentication.Bank account registration via PGSearch for Account Registration StatusBalance Limit Increase(Individual card)ํšŒ์› ๋“ฑ๋ก ๊ณ„์ขŒ ์กฐํšŒํšŒ์› ๊ณ„์ขŒ ์ •๋ณด ์กฐํšŒ์ž๋™์ถฉ์ „ ๊ณ„์ขŒ ๋“ฑ๋กํšŒ์› ๊ณ„์ขŒ ์‚ญ์ œIssuance of Disposable TokenChargeCancellation of ChargeChecking Result of Charge & Cancellation of ChargeChecking Transaction HistoryApplication for Issuance and Delivery of Prepaid CardCancellation of Card ApplicationReissuance of Prepaid Card (Replacement Issuance)Reissuance & Renewal of Prepaid Card to be ExpiredSearch for Card Delivery StatusSearch for Mobile Card Application Information Linkable to Physical CardPhysical Card RegistrationSearch for CardUnregistered card inquiryModification of the Cardโ€™s StateDiscarding a CardBalance Limit Increase(Individual card)Balance Limit Increase(Coporate card)Inquiry of Coporate Card Identification StatusApplying For Income Tax DeductionInquiry of Card Tax Deduction StatusCard-User Mapped InquiryCard Product ID Inquiry์ฃผ์นด๋“œ ์„ค์ •์นด๋“œ์— ์—ฐ๊ฒฐ๋œ ๊ฐ€์ƒ๊ณ„์ขŒ ์กฐํšŒUser RegisterSearch for Member InformationMember Password Reset and ChangeMember Information ChangeMembership CancellationChecking Log in ID checkActivation of Dormant MemberSearch for Terms and Conditions ListTerms and Conditions Agreement/WithdrawalCI ๊ฐ’์œผ๋กœ ํšŒ์› ์ •๋ณด ์กฐํšŒํšŒ์› ๋กœ๊ทธ์ธ ID ์ค‘๋ณต ํ™•์ธํšŒ์› ๋น„๋ฐ€๋ฒˆํ˜ธ ๊ฒ€์ฆํšŒ์› ์ธ์ฆ ์ •๋ณด ์กฐํšŒFinancial Institution List InquiryReal Name Verification for Account holderAuthentication code generation before ARS authentication.Bank account registration via PGSearch for Account Registration StatusBalance Limit Increase(Individual card)ํšŒ์› ๋“ฑ๋ก ๊ณ„์ขŒ ์กฐํšŒํšŒ์› ๊ณ„์ขŒ ์ •๋ณด ์กฐํšŒ์ž๋™์ถฉ์ „ ๊ณ„์ขŒ ๋“ฑ๋กํšŒ์› ๊ณ„์ขŒ ์‚ญ์ œ