API 문서
전체 API
서비스
환불 결과 확인동기
버전: v1
버전: v1
/api/v1/refund/list
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
refundInfo
array of objects
필수
환불 내역 리스트
refundInfo_item
object
옵션
serviceId
string
필수
길이 : 15
카드 상품 ID
- 카드 상품에 부여한 고유 식별 값입니다.
serviceName
string
필수
최소 : 1 , 최대 : 255
카드 상품명
serviceImageUrl
string
필수
최소 : 1 , 최대 : 255
카드 상품의 이미지 파일 URL
requestedDateTime
string
필수
길이 : 17
환불 요청 일시
- 형식 : yyyyMMddHHmmssSSS
settleDate
string
필수
길이 : 8
환불금 계좌입금 예정일
- 형식 : yyyyMMdd
refundStatus
string
필수
최소 : 4 , 최대 : 6
환불 진행 상태
- WAIT : 환불 진행중
- SUCCESS : 환불 완료
refundBalance
number
필수
최소 : 0 , 최대 : 1000000000
환불 요청 금액
환불 신청된 카드의 잔액입니다.
refundFee
number
필수
최소 : 0 , 최대 : 1000000000
환불 수수료 금액
settleAmount
number
필수
최소 : 0 , 최대 : 1000000000
최종 환불 금액
refundType
string
필수
최소 : 0 , 최대 : 10
환불 타입
- BANK_ACC : 환불 이체
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_002
메시지
Invalid input parameter.
설명
입력 파라미터 오류
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.
