New Payment Platform, KONA PLATE

API Documentation

All API

Service

Pre-paid Card
Debit Card

Card Product ID InquirySync

Version: v1

POST

/api/v1/service/info/list

This is an API for querying product information, such as the product name, using the card product ID.

Request Headers

X-KM-User-AspId

string

Required

Length : 15

ASP ID

ID given to the service provider.
The ID is provided at the time of contract.

X-KM-Correlation-Id

string

Required

Length : 20

Transaction number for tracking trasncription

Form : yyMMddHHmiSS-xxxxxxx
xxxxxxx : 7digit, Hex String

X-KM-Access-Key

string

Conditional

Length : 40

Access Key created by Project

Excluding the case for Callback API

X-KM-Crypto-Key-Id

string

Optional

Length : 32

Data Encryption/Decryption Key ID

Given ID from creating the service provider's project
Required value when requesting data encryption.

X-KM-Tran-Token

string

Required

Length : 66

Refer to Common header information- X-KM-Tran-Token Guide page

X-KM-Tran-Time

string

Required

Length : 16

Client Request Time

Form : YYYYMMDDHH24MISS

X-KM-Time-Zone

string

Required

Length : 3

International Standard Time (UTC, KST, ...)

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

serviceInfos

array of objects

Required

상품 정보 리스트

serviceInfos_item

object

Optional

serviceInfos_item content

serviceId

string

Required

Length : 15

상품 ID

serviceName

string

Required

Min : 1 , Max : 80

상품명

cardType

string

Required

Min : 1 , Max : 6

카드 타입

CARDSE, MOBILE, COUPON

mobilePreIssueYn

string

Required

Length : 1

모바일 선발급 가능여부

shortDescription

string

Required

Min : 0 , Max : 4000

상품 설명

cardImageUrl

string

Required

Min : 1 , Max : 500

상품 이미지 URL

thumbnailImageUrl

string

Required

Min : 1 , Max : 500

상품 썸네일 이미지 URL

registeredDate

string

Required

Length : 10

상품 등록일

status

string

Required

Min : 1 , Max : 10

상품 상태

VOID, ACTIVE, SUSPENDED, SOLDOUT, DELETED

chargeCardCost

string

Required

Length : 1

추가카드 비용부과여부

T: 비용부과상품, ASP 비용부과기준 준수, F: 비용 비부과 상품, A: 무조건 비용부과

chargeCardCostAmt

number

Required

Min : 1 , Max : 99999

추가카드 발급 비용

reissuanceYn

string

Required

Length : 1

재발급 가능여부

issueLimitCount

number

Required

Min : 1 , Max : 99999

상품별 발급횟수 제한 (0은 제한없음)

useLimitCount

number

Required

Min : 1 , Max : 99999

고객별 발급횟수 제한(0은 제한없음)

overseaPaymentYn

string

Required

Length : 1

해외결제가능여부

Y, N

attributes

string

Required

Min : 1 , Max : 100

추가 속성 필드

해당 값에 'CASHBEE' 라는 문자열이 포함되어 있을 경우 교통카드 여부 Y

routeType

string

Required

Min : 6 , Max : 8

실물카드 배송 타입

POSTAL - 우편 배송
PERSONAL - 인편 배송

productDetailInfo

array of objects

Required

상품상세정보

productDetailInfo_item

object

Optional

productDetailInfo_item content

title

string

Optional

Min : 1 , Max : 255

상품 상세 정보 제목

content

string

Optional

Min : 1 , Max : 255

상품상세정보 내용

Response Code

Detailed classification and addition of error for unseccessful withfrawal

200

Error code

000_000

Message

Success.

Description

성공

400

Error code

000_003

Message

Missing required values. serviceIdList

Description

입력 파라미터 오류 - `serviceIdList` 입력 요청 정보가 null 인 경우

Test Data

200 - Success

400 - Missing required values. serviceIdList

Loading ...

Request

Response

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

User Register Search for Member Information Member Password Reset and Change Member Information Change Membership Cancellation Checking Log in ID check Activation of Dormant Member Search for Terms and Conditions List Terms and Conditions Agreement/Withdrawal CI 값으로 회원 정보 조회 회원 로그인 ID 중복 확인 회원 비밀번호 검증 회원 인증 정보 조회 Financial Institution List Inquiry Real Name Verification for Account holder Authentication code generation before ARS authentication.Bank account registration via PG Search for Account Registration Status Balance Limit Increase(Individual card)회원 등록 계좌 조회 회원 계좌 정보 조회 자동충전 계좌 등록 회원 계좌 삭제 Issuance of Disposable Token Charge Cancellation of Charge Checking Result of Charge & Cancellation of Charge Checking Transaction History Application for Issuance and Delivery of Prepaid Card Cancellation of Card Application Reissuance of Prepaid Card (Replacement Issuance)Reissuance & Renewal of Prepaid Card to be Expired Search for Card Delivery Status Search for Mobile Card Application Information Linkable to Physical Card Physical Card Registration Search for Card Unregistered card inquiry Modification of the Card’s State Discarding a Card Balance Limit Increase(Individual card)Balance Limit Increase(Coporate card)Inquiry of Coporate Card Identification Status Applying For Income Tax Deduction Inquiry of Card Tax Deduction Status Card-User Mapped Inquiry Card Product ID Inquiry 주카드 설정 카드에 연결된 가상계좌 조회 User Register Search for Member Information Member Password Reset and Change Member Information Change Membership Cancellation Checking Log in ID check Activation of Dormant Member Search for Terms and Conditions List Terms and Conditions Agreement/Withdrawal CI 값으로 회원 정보 조회 회원 로그인 ID 중복 확인 회원 비밀번호 검증 회원 인증 정보 조회 Financial Institution List Inquiry Real Name Verification for Account holder Authentication code generation before ARS authentication.Bank account registration via PG Search for Account Registration Status Balance Limit Increase(Individual card)회원 등록 계좌 조회 회원 계좌 정보 조회 자동충전 계좌 등록 회원 계좌 삭제