API 문서
전체 API
서비스
선정산 포인트 예치금 잔액 집계 조회동기
버전: v1
버전: v1
/api/v1/point/deposit/aggregate
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
depositInfoList
array of objects
필수
충전상 예치금 내역 리스트
depositInfoList_item
object
옵션
policyId
string
필수
길이 : 15
포인트정책 ID
aspId
string
필수
길이 : 15
ASP ID
aspName
string
필수
길이 : 256
ASP명
depositBalance
number
필수
최소 : 0 , 최대 : 1000000000
포인트 예치금 잔액
depositAmount
number
필수
최소 : 0 , 최대 : 1000000000
포인트 예치금 입금 금액
- 제휴사에서 예치금 계좌로 입금한 금액
depositRefundAmount
number
필수
최소 : 0 , 최대 : 1000000000
포인트 예치금 환불 금액
- 예치금 계좌에서 제휴사 계좌로 환불된 금액
depositAdjustAmount
number
필수
최소 : 0 , 최대 : 1000000000
포인트 예치금 조정 입금 금액
- 다른 예치금 계좌에서 입금된 금액
depositAdjustRefundAmount
number
필수
최소 : 0 , 최대 : 1000000000
포인트 예치금 조정 환불 금액
- 다른 예치금 계좌로 충금된 금액
chargeAmount
number
필수
최소 : 0 , 최대 : 1000000000
포인트 지급 금액
- 예치금 계좌에서 회원 카드로 충전되어 차감된 금액
chargeCancelAmount
number
필수
최소 : 0 , 최대 : 1000000000
포인트 지급 취소 금액
- 잔액 충전이 취소되어, 예치금 계좌로 돌아온 금액
retrieveAmount
number
필수
최소 : 0 , 최대 : 1000000000
포인트 회수 금액
- 잔액 충전이 되었다가, 예치금 계좌로 회수한 금액
expiredAmount
number
필수
최소 : 0 , 최대 : 1000000000
포인트 소멸 금액
criteriaDate
string
필수
길이 : 8
집계일자
- 형식 : yyyyMMdd
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를 확인하세요.
