포인트 사용예약 및 취소

API Description

Doc. No. A7S11D1V1
API Title 결제 > 포인트 사용예약 및 취소
API Description 회원이 보유한 포인트의 사용예약 및 예약 취소를 처리 합니다.
포인트 정책에 따라 수동사용으로 설정되어 있는 포인트를 결제 시 포인트을 사용하기 위해서는 결제 전 사용할 포인트를 사용 예약하고 10분 이내로 결제를 진행해야 합니다.
“포인트 사용예약 및 취소”, “포인트 사용예약”로 예약한 포인트 API로 사용예약을 취소 할 수 있습니다.
Protocol HTTP Interface Type SYNC
HTTP METHOD POST Request URL /api/v1/payment/point
Data Encryption Request : YES / Response : NO

Request Parameter

Field Type Length MOC Description
userId NUMBER 1~999999999999 MANDATORY 회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.
pointType STRING 1~5 CONDITIONAL 사용할 포인트 타입
- USER : 유저 포인트 사용
- CARD : 카드 포인트 사용
- 조건 필드 : "reservationType"값이 "RESERVE"값일 경우 설정
policyId STRING 15 CONDITIONAL 사용할 포인트 정책 ID
보유카드 조회로 확일 할 수 있습니다.
- 조건 필드 : "pointType"값이 "CARD"값일 경우 설정
cardNo STRING 16 CONDITIONAL 결제할 카드 번호
- 조건 필드 : "pointType"값이 "CARD"값일 경우 설정
pointAmount NUMBER 1~999999999999 CONDITIONAL 사용할 포인트 금액
- 조건 필드 : "reservationType"값이 "RESERVE"값일 경우 설정
reservationType STRING 1~7 MANDATORY 포인트 사용 예약상태
- RESERVE : (포인트) 사용예약
- CANCEL : (포인트) 사용예약 취소

Response Parameter

Field Type Length MOC Description
remainTime NUMBER 0~3600000 MANDATORY 포인트 사용 예약 시 예약의 유효한 잔여시간
- 단위 : ms
userId NUMBER 0~999999999999 MANDATORY 회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.
pointAmount NUMBER 0~999999999999 MANDATORY 사용/사용취소 할 포인트 금액
response OBJECT MANDATORY 응답 결과 값
└ code STRING 1~7 MANDATORY 응답 결과 코드
└ description STRING 1~255 MANDATORY 응답 결과 상세 설명

Response Code

HTTP Status Error code Message Description
프로토콜 항목의 "공통 Error Message 정보"에서 추가 확인 바랍니다.
400 006_023 Exceed the balance. 잔액이 부족 합니다.
400 006_024 Exceed the one time limit. 1회 사용한도 초과입니다.
400 006_025 Exceed the day limit. 1일 사용한도 초과입니다.
400 006_026 Exceed the month limit. 1달 사용한도 초과입니다.
400 006_029 Card is not found with the card no. 해당 카드 번호의 카드를 찾을 수 없습니다.

Example

Request


            

        

        

            

                
Response