API 문서
전체 API
서비스
포인트 거래내역 확인동기
버전: v1
버전: v1
/api/v1/transaction/point
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
transactionInfo
array of objects
필수
거래 내역 목록 정보
transactionInfo_item
object
옵션
authCancelType
string
조건부
최소 : 1 , 최대 : 6
승인/취소 타입
- AUTH : 승인
- CANCEL : 취소pointTranType
inOutType
string
조건부
길이 : 1
포인트 조회 구분 코드
포인트의 증가 거래, 감소 거래를 구분합니다.
- I : 포인트 증가(입금)
- O : 포인트 감소 (출금)
tranType
string
조건부
길이 : 2
포인트 거래 유형
- PP : 지급(Point Payment)
- PU : 사용(Point Use)
- PD : 회수(Point Deduction)
- PE : 소멸(Point Expiry)
tranDetail
string
조건부
길이 : 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
조건부
최소 : 0 , 최대 : 1000000000
포인트 거래의 금액
- 증가, 차감 (예; 1000)
approvalDateTime
string
조건부
길이 : 14
거래 승인 시간
- 형식 : yyyyMMddHHmmss
policyName
string
조건부
최소 : 1 , 최대 : 255
포인트 정책명
expiryDate
string
조건부
길이 : 8
포인트 만료일자
- 형식 : yyyyMMdd
merchantName
string
조건부
최소 : 1 , 최대 : 255
결제 가맹점명
approvalCode
string
옵션
길이 : 6
거래 승인코드
- Admin 적립, 차감, 소멸의 경우에는 null
nrNumber
string
옵션
길이 : 18
거래 고유번호
- Network Reference Number
pageResponse
object
필수
페이징 응답 정보
page
number
필수
최소 : 0 , 최대 : 1000
페이징 인덱스
- 기본값 = 0
totalPages
number
필수
최소 : 0 , 최대 : 1000
전체 페이지 수
numberOfElements
number
필수
최소 : 0 , 최대 : 10000
전체 목록 개수
응답 코드
Detailed classification and addition of error for unseccessful withfrawal
200
에러 코드
000_000
메시지
Success.
설명
성공
400
에러 코드
000_001
메시지
Unkown Reason.
설명
외부연결 실패 테스트
400
에러 코드
000_002
메시지
Invalid input parameter.
설명
입력 파라미터 오류
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.
