Konaplate logo

API Documentation

All API

Service


Checking History of Point TransactionSync

Version: v1


Version: v1

POST

/api/v1/transaction/point

It is available to check the history of points belong to cards or members. It is available to check amount of point transaction, policy, time of transaction, expiration date and information of franchise.

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


userId

number

Required

Min : 1 , Max : 999999999999999

    
회원 ID

회원가입 시 부여되는 회원의 고유 ID입니다.

par

string

Required

Length : 27

카드의 PAN(Primary Account Number)을 대체하는 번호

PAR가 있는 경우 :

  • 카드 포인트 거래 내역 조회

PAR가 없는 경우 :

  • 회원 포인트 거래 내역 조회

inquiryType

string

Required

Length : 1

포인트 조회 구분 코드

포인트의 증가 거래, 감소 거래를 구분합니다.

  • 기본값 : A
  • A : 모두
  • I : 포인트 증가(입금)
  • O : 포인트 감소 (출금)

startDate

string

Required

Length : 8

검색 시작일자

  • 형식 : yyyyMMdd
  • 거래 승인 날짜 기준입니다.

endDate

string

Required

Length : 8

검색 종료일자

  • 형식 : yyyyMMdd
  • 거래 승인 날짜 기준입니다.

pageRequest

object

Required

페이징 요청 정보

orderByDirection

string

Required

Min : 1 , Max : 4

정렬 순서

  • 기본값 = ASC
  • ASC : 오름차순 정렬
  • DESC : 내림차순 정렬
  • 거래 승인 날짜 기준입니다.

page

number

Required

Min : 0 , Max : 1000

페이징 인덱스

  • 기본값 = 0

pageSize

number

Required

Min : 0 , Max : 10000

페이징 크기

  • 기본값 = 10
  • 전체 목록 = 0

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


transactionInfo

array of objects

Required

거래 내역 목록 정보

transactionInfo_item

object

Optional

transactionInfo_item content

authCancelType

string

Conditional

Min : 1 , Max : 6

승인/취소 타입

  • AUTH : 승인
  • CANCEL : 취소pointTranType

inOutType

string

Conditional

Length : 1

포인트 조회 구분 코드

포인트의 증가 거래, 감소 거래를 구분합니다.

  • I : 포인트 증가(입금)
  • O : 포인트 감소 (출금)

tranType

string

Conditional

Length : 2

포인트 거래 유형

  • PP : 지급(Point Payment)
  • PU : 사용(Point Use)
  • PD : 회수(Point Deduction)
  • PE : 소멸(Point Expiry)

tranDetail

string

Conditional

Length : 2

포인트 거래 상세유형

지급 관련
TranType
내용 비고
01 일반 포인트적립 결제시 or 충전시의 혜택을 적립
06 카드포인트 잔액 이전 (카드->카드) 카드 교체 시 TranType 05 에서 소멸된 A카드 캐시를 B카드로 지급
07 포인트 구매 적립 (카드 잔액을 이용한 포인트 구매 적립) 캐시 적립 취소 시 마이너스 캐시 발생한 경우, 잔액으로 벌충 결제 후 캐시 재지급.
09 단말기를 이용한 카드 포인트적립 오프라인단말기(G870) 을 이용한 적립
11 어드민 적립 플랫폼 포탈에서 포인트 어드민 지급
13 수기 어드민 적립(고객센터) 고객센터에서 포인트 어드민 지급
15 시스템 어드민 적립  '결제금액에 대한 리워드'와 '고객 행동에 대한 리워드' 로 적립
17 복지 포인트 적립 복지 포탈에서 포인트 지급
23 캐시송금으로 인한 적립. 송금 : 타 회원에게 캐시를 이관 하는 기능
51 포인트 이용한 환급(쿠폰부분취소환급) 직접 구매를 진행한 쿠폰을 사용한 거래의 부분취소가 발생할 경우 쿠폰금액의 부분취소분을 포인트로 환급
61 수당 및 인센티브 지급 정책수당 포탈에서 정책수당 지급
63 정액형 포인트 지급 공장에서 카드 생성시에 특정 금액을 포인트로 지급하여 생성
65 어드민 벌크 적립(ATC) 무기명 카드 지급 가능한 포탈의 어드민 적립
67 포인트 -> 포인트 이관 적립 동일 회원의 보유 카드 간의 포인트 이동
69 교통비 수당 지급 교통부의 캐시지급 거래
70 이벤트 리워드로 인한 지급 특정 이벤트로 발생한 적립(회원의 참여 필요)
73 법인캐시 포인트 계좌에서 카드에 법인캐시 지급 법인 포탈에서 법인카드에 법인캐시로 지급
77 법인캐시통으로부터 개인회원에게 지급 법인 포탈에서 기부수혜자에게 캐시 지급
81 외부연동으로 캐시 지급 외부 제휴사를 통한 캐시 지급(별도 연동 필요)
92 일반사용 망취소 시스템 오류로 인한 사용거래의 망취소.
사용 관련
TranType
내용 비고
02 일반 포인트 사용 당월사용금액은 일반포인트 사용만 계산되고 있음.
04 인센티브로 적립된 포인트 소멸(계좌이체환불 완료시) 환불로 인한 소멸
08 오프라인단말기로 포인트를 잔액으로 이관 오프라인단말기(G870) 을 이용한 캐시 전환
22 캐시송금으로 인한 차감. 송금 : 타 회원에게 캐시를 이관 하는 기능
68 포인트 -> 포인트 이관 차감 동일 회원의 보유 카드 간의 포인트 이동
75 기부를 위한 포인트 사용 회원의 포인트를 이용한 기부
91 일반적립 망취소 시스템 오류로 인한 적립거래의 망취소.
회수관련
TranType
내용 비고
12 어드민 차감 플랫폼 포탈에서 포인트 어드민 차감
14 수기 어드민 차감(고객센터) 고객센터에서 포인트 어드민 차감
18 복지 포인트 어드민 차감 복지 포탈에서 포인트 차감
19 패널티 차감 (카드 분실에의한 재발급신청시 등에 사용) 카드 재발급 등의 비용
62 수당 및 인센티브 환수 정책수당 포탈에서 정책수당 환수
64 DIS portal 에서 공무원이 환수 요청 유저 상태 및 카드상태 바라보지않고 환수
66 어드민 벌크 차감(ATC) 무기명 카드 처리 가능한 포탈의 어드민 환수
소멸관련
TranType
내용 비고
21 카드 연결 해제로 인한 소멸 회원에게 연결된 카드를 삭제 할 경우 보유 캐시 소멸.
05 카드포인트 이전에 의한 포인트 소멸 카드 교체 ( A 카드 폐기되면서 A 카드 캐시 소멸)
31 유효기간 만료로 인한 소멸 현재 유효기간 만료 소멸금액만 계산됨.
41 회원탈퇴로 인한 소멸  

pointAmount

number

Conditional

Min : 0 , Max : 1000000000

포인트 거래의 금액

  • 증가, 차감 (예; 1000)

approvalDateTime

string

Conditional

Length : 14

거래 승인 시간

  • 형식 : yyyyMMddHHmmss

policyName

string

Conditional

Min : 1 , Max : 255

포인트 정책명

expiryDate

string

Conditional

Length : 8

포인트 만료일자

  • 형식 : yyyyMMdd

merchantName

string

Conditional

Min : 1 , Max : 255

결제 가맹점명

approvalCode

string

Optional

Length : 6

거래 승인코드

- Admin 적립, 차감, 소멸의 경우에는 null

nrNumber

string

Optional

Length : 18

거래 고유번호

  • Network Reference Number

pageResponse

object

Required

페이징 응답 정보


page

number

Required

Min : 0 , Max : 1000

페이징 인덱스

  • 기본값 = 0

totalPages

number

Required

Min : 0 , Max : 1000

전체 페이지 수

numberOfElements

number

Required

Min : 0 , Max : 10000

전체 목록 개수

Response Code

Detailed classification and addition of error for unseccessful withfrawal


200

Error code

000_000

Message

Success.

Description

성공


400

Error code

000_001

Message

Unkown Reason.

Description

외부연결 실패 테스트


400

Error code

000_002

Message

Invalid input parameter.

Description

입력 파라미터 오류

Test Data

200 - 성공 테스트


200 - 성공 테스트
400 - 외부연결 실패 테스트
400 - 입력 파라미터 오류
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)회원 등록 계좌 조회회원 계좌 정보 조회자동충전 계좌 등록회원 계좌 삭제Microdeposit Verification(1 KRW)Microdeposit Verification CheckApplication 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주카드 설정카드에 연결된 가상계좌 조회Application for Issuance and Delivery of Debit CardCancellation of Card ApplicationSearch for Card Delivery StatusPhysical Card RegistrationSearch for CardModification of the Card’s StateModification of the Card’s LimitDiscarding a CardApplying For Income Tax DeductionInquiry of Card Tax Deduction Status주카드 설정Issuance of Disposable TokenChargeCancellation of ChargeChecking Result of Charge & Cancellation of ChargeChecking Transaction History기준 하한 및 월정액 자동 충전 활성화기준 하한 자동 충전 등록기준 하한 및 월정액 자동 충전 목록 조회기준 하한 자동 충전 수정월 정액 자동 충전 등록월 정액 자동 충전 수정기준 하한 및 월정액 자동 충전 등록 해제결제 시 자동 충전 등록결제 시 자동 충전 등록 해제결제 시 자동 충전 목록 조회Issuance of Disposable TokenSearch for Refund FeeRefundChecking Refund ResultSystem RechargingSystem Recharging CancelSystem RefundSystem Partial Refund신용카드 충전 거래 생성신용카드 충전 취소 요청편의점 충전/출금 요청Deposit Transaction InquiryDeposit Balance InquiryIssuance of Disposable TokenPaymentCancellation of PaymentNetwork Cancellation of Payment Checking Transaction HistoryChecking History of Point TransactionSearch for CardReservations & Cancellations of Point UseChecking History of Point Transaction관리자 포인트 지급관리자 포인트 환수Stamp card accumulation history inquiryCheck the list of stamp cards held by memberInquiry the list of mileage cards owned by member.Mileage card accumulation history inquiryTransfer to CardTransfer to Card ReceivingCard Transfer RejectionCard Transfer CancellationIssuance of Disposable Token for ATMATM Withdrawal ReservationATM Withdrawal Reservation CancelATM withdrawal information inquiry선불카드 선물하기선불카드 선물하기 취소선불카드 선물하기 유효성 검증선불카드 선물하기 수락선불카드 선물하기 거절받은 카드/쿠폰 선물 목록 조회보낸 카드/쿠폰 선물 목록 조회카드 선물 수락 V2카드 선물하기 V2Transfer card balanceBalance Transfer Card Information Inquiry현금영수증 발행 요청현금영수증 발행 취소현금영수증 국세청 승인오류 요청현금영수증 식별 정보 등록현금영수증 식별 정보 조회현금영수증 식별 정보 삭제현금영수증 가맹점 등록현금영수증 가맹점 수정Creation of merchant groupsMerchant Group ModifyMerchant Group InquiryMerchant Information InquiryAdding merchants to merchant groupsMerchant removal from merchant groups신용카드 자동충전 설정(기준 하한)신용카드 자동충전 설정(월정액)신용카드 자동충전 활성화신용카드 자동충전 목록 조회신용카드 자동충전 설정 해제신용카드 자동 충전 설정 변경카드 상품 전체 조회 (관리자용)카드 상품 상세 조회 (관리자용)발급 카드 목록 조회 (관리자용)카드 상품 생성 API (관리자용)카드 선물 내역 조회 (관리자용)