01 개요정기/반복결제 개요네이버페이 정기/반복결제의 전체 과정을 간략하게 나타내면 다음과 같습니다. Show 사용자가 정기/반복결제 상품의 결제 수단으로 네이버페이를 선택하면 네이버페이 정기/반복결제 등록 페이지가 열립니다. 02 인증인증방법 네이버페이 간편결제는 인증에 oAuth 2.0을 사용합니다.
클라이언트 ID와 클라이언트 시크릿은 보안상 노출되면 안 되는 값입니다. 네이버페이 간편결제 API 서버는 IP 주소 기반 ACL(access control list)을 사용하지 않습니다. TLS/SSL 지원 버전네이버페이 간편결제 API는 TLS 1.0~TLS 1.2를 지원합니다. SSL은 더 이상 지원하지 않으므로 TLS 1.0 이상을 지원하는 클라이언트 라이브러리를 사용해야 합니다. 03 방화벽방화벽가맹점은 가맹점에서 네이버페이 서버로 나가는 호출인 아웃바운드 트래픽에 대해 다음과 같이 가맹점 서버의 방화벽을 설정합니다. 방화벽 가이드 443 port 허용 04 API URL 형식백엔드 API 서버 URL 형식네이버페이 정기/반복결제 API의 URL 형식은 다음과 같습니다.
반드시 HTTPS로 호출해야 합니다. API 도메인은 다음과 같습니다.
네이버페이 간편결제 API를 호출하는 예는 다음과 같습니다.
정기/반복결제 등록 페이지네이버페이 정기/반복결제 API에서 사용하는 정기/반복결제 등록 페이지의 주소는 다음과 같습니다.
등록 예약 번호는 정기/반복결제 등록 예약 요청 결과 응답으로 전달받습니다.
05 기본 응답 형식기본 응답 형식네이버페이 정기/반복결제 API의 기본 응답 형식은 다음과 같습니다.
기본 응답 필드
피라미터
결제 승인 요청 API 호출 트래픽은 10TPS를 넘지 않아야 합니다. 06 정기/반복결제 등록 흐름정기/반복결제 등록 흐름네이버페이 정기/반복결제를 등록하는 과정은 다음과 같습니다. 사용자가 정기/반복결제 상품의 결제 수단으로 네이버페이를 선택하면 네이버페이 정기/반복결제 등록 페이지가 열립니다. 이 단계에는 오직 등록만 이루어지며, 결제 승인은 별도 결제 API를 사용해야 합니다. 07 정기/반복결제 등록예약 API정기/반복결제 등록예약 API네이버페이 정기/반복결제를 등록예약 요청하고 응답으로 등록예약 번호를 받습니다.
파라미터
응답결과코드
body
08 정기/반복결제 등록창 호출등록창 호출 정기/반복결제 등록 페이지를 호출하며, 등록예약 응답으로 받은 등록예약번호(reserveId)를 사용합니다. 요청
성공응답등록 예약 프로세스가 정상적으로 수행되었을 때 성공으로 응답합니다. 응답필드
응답 예
실패 응답응답필드
resultCode
응답 예
네이버 로그인 페이지는 보안 정책에 따라 X-Frame-Options : SAMEORIGIN으로 제공합니다. 09 정기/반복결제 등록완료 API정기/반복결제 등록완료 API정기/반복결제 최종 등록완료를 요청합니다. 요청
파라미터
응답결과코드
body
10 결제예약 API결제예약 API결제승인 예약을 요청합니다. 이 API를 호출하여 응답으로 받은 토큰을 결제승인요청 API 호출에 사용합니다. 요청
파라미터
응답결과코드
body
11 결제승인 API결제승인 API결제승인을 요청합니다. 요청
파라미터
최종 결제 승인이 완료되기까지 시간이 걸리므로 timeout을 60초로 설정해야 합니다. 응답결과코드
body
body > detail
12 정기/반복결제 해제 API정기/반복결제 해지 API등록된 정기/반복결제 항목을 해지하여 더이상 결제가 발생하지 않도록 합니다. 요청
파라미터
응답결과코드
body
13 정기/반복결제 등록 상태 조회 API정기/반복결제 등록 상태 조회 API정기/반복결제 등록 상태를 조회합니다. 요청
파라미터
응답결과코드
body
14 결제취소결제취소 API결제취소를 요청합니다. 요청
파라미터
주의 응답결과코드
body
15 거래완료거래완료 API 구매자가 결제를 완료하고 배송이 완료된 상태에서 가맹점과 구매자 간의 주문을 최종적으로 완료합니다. 에스크로 타입 가맹점인 경우에 사용합니다. 요청
파라미터
응답결과코드
body
16 결제내역조회결제내역조회 API결제내역을 조회합니다. 요청
파라미터
paymentId만 파라미터로 사용하여 결제 내역을 조회할 수 있습니다 응답결과코드
body
표 3 결제 내역
표 4 정산 데이터
17 현금영수증발행대상 금액조회현금영수증 발행대상 금액조회 API현금영수증 발행대상 금액을 조회합니다. 취소가 발생하면 남은 결제금액 중 현금영수증 발행대상 금액 정보를 제공합니다. 요청
GET https://{API 도메인}/{파트너 ID}/naverpay/payments/v1/receipt/npoint-cash-amount는 더 이상 사용하지 않습니다.(deprecated). 파라미터
응답결과코드
body
18 네이버페이 포인트 적립 요청네이버페이 포인트 적립 요청 API네이버페이 포인트 적립을 요청합니다. 비에스크로 타입 가맹점 중 수동 적립 방식을 선택한 경우에 사용합니다. 가맹점 타입과 네이버페이 포인트 적립 시점
이 절에서 설명하는 API는 수동 적립 방식을 선택한 경우 사용하는 API입니다. 요청
파라미터
응답결과코드
body
맨위로 |