API Documentation
All API
Service
받은 카드/쿠폰 선물 목록 조회Sync
Version: v1
Version: v1
/api/v1/gifts/cards/inbox
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
giftData
array of objects
Required
선물 목록
giftData_item
object
Optional
transferId
string
Required
Length : 20
카드 선물 ID
giftType
string
Required
Min : 1 , Max : 6
선물 타입
- CARD
- COUPON
gift type.
- CARD
- COUPON
par
string
Conditional
Length : 27
선물 유형이 CARD인 경우에만 유효
- 받는 사람이 선물을 받기 전에 "SendPar"
- 받는 사람이 선물을 수락한 후에는 "ReceiverPar"
couponNo
string
Conditional
Length : 16
쿠폰번호 (선물형이 쿠폰인 경우에만 유효)
coupon no. (only valid if gift type is COUPON)
serviceId
string
Required
Length : 15
선물형이 CARD이면 서비스 ID
선물형이 쿠폰이면 쿠폰 ID
amount
string
Conditional
Min : 1 , Max : 9999999999
금액. (giftType이 CARD인 경우에만 유효)
senderUserId
string
Required
Min : 1 , Max : 9999999999999999999
쿠폰 전송하는 사용자ID
senderPhone
string
Required
Min : 1 , Max : 20
발송인 휴대폰번호
receiverUserId
string
Required
Min : 1 , Max : 9999999999999999999
수신자 ID
Receiver Id
receiverPhone
string
Required
Min : 1 , Max : 20
수신자 휴대폰번호
sentDateTime
string
Required
Length : 14
선물 전송 시간
settlementDateTime
string
Optional
Length : 14
선물 완료일
canceledDateTime
string
Optional
Length : 14
선물 취소 시간
expiryDate
string
Required
Length : 14
선물 만료일
cardExpiryDate
string
Optional
Length : 6
카드유효기간
- yyMMdd
status
string
Required
Length : 2
선물 상태
- "00" : Ready (수신자 측 상태로 발송인이 보낸 선물을 수신자가 받지 않은 상태)
- "01" : 송신(발송인 측 상태로 발송인이 보낸 선물을 수신자가 받지 않은 상태)
- "02" : 수락(수신자가 선물을 성공적으로 수락)
- "03" : 거절당하였습니다(수신자가 선물 수신을 거절)
- "04" : 철회(발신자에 의해 선물이 취소 됨)
- "05" : 복구됨 (선물이 만료 되어 발신자에게 되돌아감)
- "06" : 발급(수신자가 카드선물을 수락 하여 발신 잔액을 수신하기 위한 카드가 발급 됨)
- "07" : 차감(수신자가 카드선물을 수락 하여 발신자가 선물한 카드 잔액이 차감 됨)
- "08" : 입금(발신잔액을 수신하기위한 카드에 발신자가 선물한 카드의 잔액이 입금 됨)
- "09" : 실패
- "10" : 기프트 카드에 해당하는 서비스가 만료, 삭제 또는 중지 됨
reservedMsgOne
string
Required
Min : 1 , Max : 255
선물 메세지 1
reservedMsgTwo
string
Required
Min : 1 , Max : 255
선물 메세지 2
serviceImageUrl
string
Optional
Min : 1 , Max : 255
서비스 이미지 URL
serviceThumbnailImageUrl
string
Optional
Min : 1 , Max : 255
서비스 썸네일 이미지 URL
serviceName
string
Required
Min : 1 , Max : 255
상품 명
senderName
string
Optional
Min : 1 , Max : 255
발신자명
senderRealName
string
Optional
Min : 1 , Max : 255
발신자 실명
receiverRealName
string
Optional
Min : 1 , Max : 255
수신자 명
receiverName
string
Optional
Min : 1 , Max : 255
수신자 실명
pageResponse
object
Required
페이징 응답 정보
page
number
Required
Value : 1000
페이징 인덱스
- 기본값 = 0
totalPages
number
Required
Value : 1000
전체 페이지 수
numberOfElements
number
Required
Value : 10000
전체 목록 개수
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!
