네이버페이(결제형)

빌링키 발급받기

JavaScript SDK
IMP.request_pay(
  {
    pg: "naverpay.{파트너 ID}",
    customer_uid: "gildong_0001_1234", // 빌링, 필수 입력.
    merchant_uid: "order_monthly_0001", // 상점에서 생성한 고유 주문번호
    name: "Slim 요금제(1개월 단위)",
    amount: 1004, // 실 결제는 발생되지 않습니다.
    buyer_email: "test@portone.io",
    buyer_name: "구매자이름",
    buyer_tel: "010-1234-5678", // 필수 입력.
    buyer_addr: "서울특별시 강남구 삼성동",
    buyer_postcode: "123-456",
    naverProductCode: "반복결제 상품코드",
    naverProductCount: 5,
    naverPopupMode: true, // 팝업모드 활성화
    m_redirect_url: "{등록 완료 후 리디렉션 될 URL}",
  },
  function (rsp) {
    // callback 로직
    /* ...중략... */
  }
);

주요 파라미터 설명

pg string

PG사 구분코드

naverpay 로 지정하면 됩니다.

customer_uid * string

빌링키

• 정기/반복 결제 등록을 위해서 지정해야 합니다. 미 지정 시, 일반결제로 진행됩니다.
• 등록 후 해당 키를 사용해 반복결제 승인을 요청할 수 있습니다.

merchant_uid * string

주문번호

매번 고유하게 채번되어야 합니다.

amount integer

결제금액

string 이 아닌점에 유의하세요

정기/반복 결제 등록과정에서는 결제승인이 이뤄지지 않습니다.

naverProductCode * string

고객사의 상품코드

• 동일한 고객이 동일상품에 대해 중복으로 반복결제 등록하는 것을 방지하기 위한 파라미터입니다.
• 기본값은 random으로 자동 생성되어 중복결제가 가능하므로 값을 지정해 주세요.

naverProductCount integer

결제대상 상품 수

name * string

제품명

네이버페이 내부적으로 외 2개 의 표현이 자동생성되므로 ”xxxx 외 2개" 대신naverProducts[0].name(첫번째 상품명)으로 설정하길 권장합니다.

naverPopupMode boolean

결제창 팝업여부

false인 경우 페이지 리디렉션 방식으로 진행되며 m_redirect_url을 설정해야 합니다

m_redirect_url string

리다이렉트 URL

리디렉션 방식으로 진행(naverPopupMode: false)할 경우 결제 완료 후 리디렉션 될 URL

naverActionType string

신규 등록/수단 변경 여부

네이버페이를 통해 발급한 빌링키의 결제 수단을 변경하고자 하는 경우 포트원 빌링키인 customer_uid를 동일하게 입력하고, naverActionType 파라미터를 CHANGE로 입력하여 빌링키를 재발급해야 합니다.

naverActionType 파라미터를 이용하지 않고 동일한 고객의 정보로 추가 빌링키를 발급 시도하면 이전의 결제 수단 정보가 구매자의 네이버페이 계정에 그대로 남아있어 문제가 발생할 수 있습니다.

• NEW(default) : 신규 등록
• CHANGE 결제 수단 변경

결제요청하기

빌링키 발급이 완료되면 설정한 customer_uid 를 이용하여 결제승인 API를 호출하여 결제를 요청하거나 결제를 예약할 수 있습니다

결제 요청방법

REST API /subscribe/payments/again 를 호출하여 결제를 요청할 수 있습니다.

• customer_uid: 정기/반복결제 등록 시 사용된 해당 고객의 customer_uid
• merchant_uid: 고객사 주문번호
• amount: 결제승인 요청금액 (결제고객 등록 시 지정된 금액과 달라도 무방함)
• tax_free: amount 중 면세공급가액 (기본값: 0)
• name: 주문의 명칭
• extra.naverUseCfm: 이용 완료일(yyyyMMdd 형식의 문자열로 결제 당일 또는 미래의 일자여야 함) 상품 유형에 따라, 네이버페이-고객사 간 필수값으로 계약되는 경우 입력합니다.

sample json
{
  "customer_uid": "gildong_0001_1234",
  "merchant_uid": "order_monthly_0002", //재사용 불가
  "amount": 10000,
  "name": "Slim 요금제(최초과금)",
  "extra": {
    "naverUseCfm": "20201001"
  }
}

form-urlencoded
customer_uid={고객사의 결제 고객을 특정하는 Unique Key}&merchant_uid={고객사 주문번호}&amount=10000&name=Slim 요금제(최초과금)&extra[naverUseCfm]=20201001

결제 예약방법

REST API /subscribe/payments/schedule를 호출하여 결제예약을 할 수 있습니다.

• customer_uid : 정기/반복결제 등록 시 사용된 해당 고객의 customer_uid
• schedules : 결제 예약 정보 객체 배열(1개 이상 설정 가능)
  • merchant_uid : 고객사 주문번호
  • schedule_at : 결제요청 예약시각 (UNIX timestamp)
  • amount : 결제승인 요청금액 (결제고객 등록 시 지정된 금액과 달라도 무방함)
  • extra.naverUseCfm : 이용 완료일(yyyyMMdd 형식의 문자열로 결제 당일 또는 미래의 일자여야 함) 상품 유형에 따라, 네이버페이-고객사 간 필수값으로 계약되는 경우 입력합니다.

sample json
{
  "customer_uid": "gildong_0001_1234",
  "schedules": [
    {
      "merchant_uid": "order_monthly_0003", //재사용 불가
      "schedule_at": 1519862400,
      "amount": 10000,
      "extra": {
        "naverUseCfm": "20201001"
      }
    }
  ]
}

form-urlencoded
customer_uid={고객사의 결제 고객을 특정하는 Unique Key}&schedules[0][merchant_uid]={고객사 주문번호}&schedules[0][schedule_at]={결제요청 예약시각 UNIX timestamp}&schedules[0][amount]=10000&schedules[0][extra][naverUseCfm]=20201001\