API 문서
전체 API
서비스
환불 수수료 조회동기
버전: v1
버전: v1
/api/v1/refund/fee
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
par
string
필수
길이 : 27
카드의 PAN(Primary Account Number)을 대체하는 번호
refundFeeRate
number
필수
최소 : 0 , 최대 : 99
환불 수수료율
소수점 1자리까지 가능합니다.
balance
number
필수
최소 : 0 , 최대 : 1000000000
카드 잔액
refundCheckBalance
number
필수
최소 : 0 , 최대 : 1000000000
순수 결제만 반영한 잔액
discountAmount
number
필수
최소 : 0 , 최대 : 1000000000
할인받은 금액
refundFee
number
필수
최소 : 0 , 최대 : 1000000000
환불 수수료 금액
refundAmount
number
필수
최소 : 0 , 최대 : 1000000000
환불 금액
expiredFee
number
필수
최소 : 0 , 최대 : 1000000000
만료 수수료
refundable
boolean
필수
최종 환불 가능 여부
refundThresholdBalance
number
필수
최소 : 0 , 최대 : 1000000000
환불 임계치 잔액
환불처리가 가능한 잔액으로 해당 금액 이하가 되어야 환불이 가능합니다. (예; 값이 "1000"일 경우 환불금액이 1000원 이하 일때 가능)
refundThresholdRatio
number
필수
최소 : 0 , 최대 : 99
환불 임계치 비율
최종충전 잔액대비 사용금액 비율로 이 퍼센트 이상을 사용하여야만 환불 가능합니다.
소수점 1자리까지 가능합니다.
currentBalanceRatio
number
필수
최소 : 0 , 최대 : 99
마지막 충전 대비 현재 잔액 사용율
소수점 1자리까지 가능합니다.
lastLoadedBalance
number
필수
최소 : 0 , 최대 : 1000000000
마지막 충전시 잔액
lastLoadedDateTime
string
필수
길이 : 17
마지막 충전 날짜
- 형식 : yyyyMMddHHmmssSSS
refundPolicy
object
필수
환불 정책 정보
refundMonthlyCount
number
필수
최소 : 0 , 최대 : 1000000000
월 환불 횟수
refundMonthlyLimitCount
number
필수
최소 : 0 , 최대 : 1000000000
월 환불 제한 횟수
refundMonthlyAmount
number
필수
최소 : 0 , 최대 : 1000000000
월 환불 금액
refundMonthlyLimitAmount
number
필수
최소 : 0 , 최대 : 1000000000
월 환불 제한 금액
conditionOverPolicy
string
필수
길이 : 1
환불조건 초과 시 처리 구분
- D : 환불 불가
- C : 수수료 부과
응답 코드
Detailed classification and addition of error for unseccessful withfrawal
200
에러 코드
000_000
메시지
Success.
설명
성공
400
에러 코드
000_002
메시지
Invalid input parameter. oneTimeToken
설명
입력 파라미터 오류
400
에러 코드
009_001
메시지
Bank account is null.
설명
회원 환불 계좌 정보 없음
400
에러 코드
009_002
메시지
Refund amount over limit in month.
설명
월 환불 금액 초과
400
에러 코드
009_003
메시지
Refund count over limit in month.
설명
월 환불 횟수 초과
400
에러 코드
009_004
메시지
Refund denied.
설명
환불 거래 거절
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.
