신개념 결제 플랫폼, KONA PLATE

API 문서

전체 API

서비스

회원 관리
계좌 관리
계좌 인증
선불 카드 관리
체크 카드 관리
계좌 충전
계좌 자동 충전
계좌 환불
시스템 충전(예치금)
시스템 환불(예치금)
신용카드 충전
편의점 충전/출금
예치금 관리
결제
거래내역
포인트 관리
스탬프 관리
마일리지 관리
카드로 송금
ATM 출금
선불카드 선물하기
돈 옮기기
현금영수증
가맹점 관리
신용카드 자동충전
관리자 페이지용 기능

관리자 포인트 환수동기

버전: v1

POST

/api/v1/point/admin/deduction

카드에 보유한 포인트를 환수하는 API입니다

요청 헤더

X-KM-User-AspId

string

필수

길이 : 15

ASP ID

서비스 사업자에게 부여한 ID입니다.
ID는 계약 시 제공됩니다.

X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

형식 : yyMMddHHmiSS-xxxxxxx
xxxxxxx : 7자리, Hex String

X-KM-Access-Key

string

조건부

길이 : 40

프로젝트에서 생성된 Access Key

Callback API 인 경우는 제외합니다.

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
데이터 암호화 요청 시 필수 입력값입니다. (Data Encryption = Y)

X-KM-Tran-Token

string

필수

길이 : 66

공통 Header 정보 - X-KM-Tran-Token

X-KM-Tran-Time

string

필수

길이 : 16

클라이언트 요청 시간

형식 : YYYYMMDDHH24MISS

X-KM-Time-Zone

string

필수

길이 : 3

시간대 정보 (UTC, KST, ...)

요청 파라미터

암호화 처리|

더 자세한 정보는

가이드라인

을 참조하세요.

adminPointMessageInfo

object

필수

환수 사유 정보 입니다.

reason

string

필수

최소 : 1 , 최대 : 255

환수 사유 입니다.

affiliateId

string

조건부

길이 : 15

카드 포인트 환수에 필요한 제휴사 ID 입니다.

"pointType"값이 "CARD"인 경우 필수값입니다.

pointDeductionInfoList

array of objects

필수

포인트 환수 정보 리스트 입니다.

추가 object

pointType

string

필수

길이 : 4

환수할 포인트 타입

USER : 유저 포인트 사용
CARD : 카드 포인트 사용

policyId

string

조건부

길이 : 15

포인트 정책 ID

조건 필드 : "pointType"값이 "CARD"값일 경우 설정

policyLimitMonthIgnored

boolean

옵션

true

false

유저당 캐시정책 월 지급 제한 무시 여부입니다.

default : false

policyLimitYearIgnored

boolean

옵션

true

false

유저당 캐시정책 년 지급 제한 무시 여부입니다.

default : false

pointProviderGroupId

string

옵션

길이 : 2

카드 포인트 환수 분담 그룹 정보

기본값: "01"

응답 헤더

X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

형식 : yyMMddHHmiSS-xxxxxxx
xxxxxxx : 7자리, Hex String

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.

응답 파라미터

pointType

string

필수

길이 : 4

환수할 포인트 타입

USER : 유저 포인트 사용
CARD : 카드 포인트 사용

completedCount

number

필수

값 : 0

환수 완료 건수 입니다.

failedCount

number

필수

값 : 0

환수 실패 건수 입니다.

totalPointAmount

number

필수

값 : 0

총 환수 된 포인트 입니다.

pointDeductionInfoList

array of objects

필수

포인트 환수 정보 리스트 입니다.

pointDeductionInfoList_item

object

옵션

pointDeductionInfoList_item content

userId

number

필수

최소 : 1 , 최대 : 9999999999999999999

회원 ID

회원가입 시 부여되는 회원의 고유 ID입니다.
포인트를 환수 받는 회원의 ID입니다.

par

string

조건부

길이 : 27

카드 포인트를 환수 받는 카드의 par 입니다.

"pointType"값이 "CARD"값일 경우 필수값

amount

number

필수

최소 : 0 , 최대 : 999999999999

환수한 포인트 입니다.

status

string

필수

최소 : 6 , 최대 : 9

환수 성공 여부 입니다.

COMPLETED : 지급 완료
FAILED : 지급 실패
PARTIAL_SUCCESS: 부분환불(보유 포인트가 요청 포인트보다 적을 경우)

응답 코드

Detailed classification and addition of error for unseccessful withfrawal

200

에러 코드

000_000

메시지

Success.

설명

성공

200

에러 코드

000_000

메시지

Success.

설명

환수실패

400

에러 코드

000_003

메시지

Missing required values.

설명

필수값 누락

테스트 데이터

200 - 성공 테스트

200 - 환수 실패

400 - 필수값 누락 테스트

Loading ...

Request

Response

Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.

회원 가입 회원 정보 조회 회원 비밀번호 재설정 및 변경 회원 정보 변경 회원 탈퇴 회원 로그인 ID 확인 휴면 회원 해제 약관 목록 조회 약관 동의 및 철회 CI 값으로 회원 정보 조회 회원 로그인 ID 중복 확인 회원 비밀번호 검증 회원 인증 정보 조회 금융사 목록 조회 계좌 예금주 실명 검증 ARS 인증 전 인증코드 생성 PG를 통한 은행 계좌 등록 계좌 등록 상태 조회 기명화 및 한도상향(개인)회원 등록 계좌 조회 회원 계좌 정보 조회 자동충전 계좌 등록 회원 계좌 삭제 계좌 1원 인증 요청 계좌 1원 인증 코드 검증 선불카드 발급 및 배송 신청 카드 신청 취소 선불카드 재발급(교체발급)만료 예정 선불카드 재발급 갱신 카드 배송 상태 조회 실물카드와 연결 가능한 모바일카드 신청 정보 조회 실물카드 등록 보유카드 조회 미등록 카드 조회 카드 상태 변경 카드 폐기 기명화 및 한도상향(개인)기명화 및 한도상향(법인)법인 기명화 여부 조회 소득공제 신청 카드 소득공제 신청 여부 조회 카드 매핑 회원 조회 카드 상품ID로 상품 정보 조회 주카드 설정 카드에 연결된 가상계좌 조회 직불카드 발급 및 배송 신청 카드 신청 취소 카드 배송 상태 조회 실물카드 등록 보유카드 조회 카드 상태 변경 카드 한도 변경 카드 폐기 소득공제 신청 카드 소득공제 신청 여부 조회 주카드 설정 일회용 토큰 발급 계좌 충전 계좌 충전취소 충전 및 충전취소 결과 확인 거래내역 확인 기준 하한 및 월정액 자동 충전 활성화 기준 하한 자동 충전 등록 기준 하한 및 월정액 자동 충전 목록 조회 기준 하한 자동 충전 수정 월 정액 자동 충전 등록 월 정액 자동 충전 수정 기준 하한 및 월정액 자동 충전 등록 해제 결제 시 자동 충전 등록 결제 시 자동 충전 등록 해제 결제 시 자동 충전 목록 조회 일회용 토큰 발급 환불 수수료 조회 환불 환불 결과 확인 시스템 충전(예치금)시스템 충전 취소(예치금)시스템 환불(예치금)시스템 부분환불(예치금)신용카드 충전 거래 생성 신용카드 충전 취소 요청 편의점 충전/출금 요청 예치금 내역 조회 예치금 잔액 조회 일회용 토큰 발급 결제 결제취소 결제 망취소 거래내역 확인 포인트 거래내역 확인 보유카드 조회 포인트 사용예약 및 취소 포인트 거래내역 확인 관리자 포인트 지급 관리자 포인트 환수 스탬프카드 적립이력조회 보유 스탬프카드 목록 조회 보유 마일리지카드 목록 조회 마일리지카드 적립이력조회 카드로 송금 전송 카드로 송금 수신 카드로 송금 거절 카드로 송금 취소 ATM 출금용 일회용 Token 발급 ATM 출금 예약 ATM 출금 예약 취소 ATM 출금 정보 조회 선불카드 선물하기 선불카드 선물하기 취소 선불카드 선물하기 유효성 검증 선불카드 선물하기 수락 선불카드 선물하기 거절 받은 카드/쿠폰 선물 목록 조회 보낸 카드/쿠폰 선물 목록 조회 카드 선물 수락 V2 카드 선물하기 V2 카드 잔액 이관 잔액 이관 카드 정보 조회 현금영수증 발행 요청 현금영수증 발행 취소 현금영수증 국세청 승인오류 요청 현금영수증 식별 정보 등록 현금영수증 식별 정보 조회 현금영수증 식별 정보 삭제 현금영수증 가맹점 등록 현금영수증 가맹점 수정 가맹점 그룹 생성 가맹점 그룹 수정 가맹점 그룹 조회 가맹점 정보 조회 가맹점 그룹 내 가맹점 추가 가맹점 그룹 내 가맹점 삭제 신용카드 자동충전 설정(기준 하한)신용카드 자동충전 설정(월정액)신용카드 자동충전 활성화 신용카드 자동충전 목록 조회 신용카드 자동충전 설정 해제 신용카드 자동 충전 설정 변경 카드 상품 전체 조회 (관리자용)카드 상품 상세 조회 (관리자용)발급 카드 목록 조회 (관리자용)카드 상품 생성 API (관리자용)카드 선물 내역 조회 (관리자용)