API Documentation
All API
Service
Pre-settlement Point Deposit Balance Aggregate InquirySync
Version: v1
Version: v1
/api/v1/point/deposit/aggregate
Request Headers
Request Parameters
Response Headers
X-KM-Correlation-Id
string
Required
Length : 20
Transaction number for tracking trasncription
- Form : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7digit, Hex String
X-KM-Crypto-Key-Id
string
Optional
Length : 32
Data encryption/decryption key ID
- Given ID from creating the service provider's project
- If it is passed as a callback, the first key issued among the keys issued to the service provider is used.
Response Parameters
depositInfoList
array of objects
Required
충전상 예치금 내역 리스트
depositInfoList_item
object
Optional
policyId
string
Required
Length : 15
포인트정책 ID
aspId
string
Required
Length : 15
ASP ID
aspName
string
Required
Length : 256
ASP명
depositBalance
number
Required
Min : 0 , Max : 1000000000
포인트 예치금 잔액
depositAmount
number
Required
Min : 0 , Max : 1000000000
포인트 예치금 입금 금액
- 제휴사에서 예치금 계좌로 입금한 금액
depositRefundAmount
number
Required
Min : 0 , Max : 1000000000
포인트 예치금 환불 금액
- 예치금 계좌에서 제휴사 계좌로 환불된 금액
depositAdjustAmount
number
Required
Min : 0 , Max : 1000000000
포인트 예치금 조정 입금 금액
- 다른 예치금 계좌에서 입금된 금액
depositAdjustRefundAmount
number
Required
Min : 0 , Max : 1000000000
포인트 예치금 조정 환불 금액
- 다른 예치금 계좌로 충금된 금액
chargeAmount
number
Required
Min : 0 , Max : 1000000000
포인트 지급 금액
- 예치금 계좌에서 회원 카드로 충전되어 차감된 금액
chargeCancelAmount
number
Required
Min : 0 , Max : 1000000000
포인트 지급 취소 금액
- 잔액 충전이 취소되어, 예치금 계좌로 돌아온 금액
retrieveAmount
number
Required
Min : 0 , Max : 1000000000
포인트 회수 금액
- 잔액 충전이 되었다가, 예치금 계좌로 회수한 금액
expiredAmount
number
Required
Min : 0 , Max : 1000000000
포인트 소멸 금액
criteriaDate
string
Required
Length : 8
집계일자
- 형식 : yyyyMMdd
pageResponse
object
Required
페이징 응답 정보
page
number
Required
Min : 0 , Max : 1000
페이징 인덱스
- 기본값 = 0
totalPages
number
Required
Min : 0 , Max : 1000
전체 목록 개수
numberOfElements
number
Required
Min : 0 , Max : 10000
성공
Response Code
Detailed classification and addition of error for unseccessful withfrawal
200
Error code
000_000
Message
Success.
Description
성공
400
Error code
000_002
Message
Invalid input parameter.
Description
입력 파라미터 오류
Test Data
Request
Response
Click Try It!
to start a Request and see the Response here!
