결제 매뉴얼커머스 매뉴얼

결제 예약조회

예약된 결제를 조회해요. 예약 요청 성공시 발급받은reserve_id로 조회할 수 있어요.

1
예약 조회하기
Server

다음과 같이 예약된 결제를 조회할 수 있습니다.

GET
https://api.bootpay.co.kr/v2/subscribe/payment/reserve/:reserve_id
2
요청 파라미터
Server
  • reserve_idstring
    부트페이가 발급한 예약 번호입니다.
3
응답 결과
Server

예약 조회에 성공하면 다음과 같은 응답을 받습니다.

 
응답 파라미터
  • pricenumber
    최종 결제 금액입니다. 0보다 커야 합니다.
  • tax_freenumber
    결제할 최종 금액 중 비과세 금액에 해당합니다. price 값과 같거나 작아야 합니다. 비과세 또는 복합과세 설정이 사전에 완료되어 있어야 합니다. 이 설정은 PG사에서 진행합니다. 복합과세 설정에 대해서는 PG사에 문의하시기 바랍니다.
  • billing_key필수string
    부트페이에서 부여하는 빌링키로 고유한 값을 가집니다. 이 값은 데이터베이스에 반드시 저장되어야 합니다.
  • order_idstring
    가맹점에서 관리하는 고유 주문번호 입니다.
  • order_namestring
    상품명, 주문명 입니다.
  • metadatahash
    결제 요청 시 해당 값을 보내면, 결제가 완료되거나 취소될 때 돌려받을 수 있습니다. orderId 만으로 주문을 구분하기 어려운 상황에서 처리하기 위한 필드입니다.
    예시: { "callbackParam1" : "value12", "callbackParam2" : "value34", "callbackParam3" : "value56", "callbackParam4" : "value78"}
  • extrahash
    Extra 모델을 통해 추가 데이터를 입력할 수 있습니다.
  • user페이앱은 구매자 전화번호 필수hash
    구매자 정보를 입력합니다.
  • items페이코 필수array<hash>
    상품 정보를 입력합니다.
  • card_quotastring
    구매자가 선택한 카드 할부 개월 수입니다.
    범위: 00, 02, 03, 04, 05, 06, 07, 08 등
  • reserve_requested_atdate
    예약 결제가 요청된 시간입니다.
  • reserve_execute_atdate
    예약결제를 실행할 시간
    * UTC 시간을 사용할 경우 ex) 2024-06-01 12:00:00 UTC (한국시간 기준 2024-06-01 21:00:00에 결제 진행)
    * TIMEZONE을 사용할 경우 ex) 2024-06-01T21:00:00 +0900 (한국시간 기준 2024-06-01 21:00:00에 결제 진행)
  • reserve_started_atdate
    예약 결제가 실행이 시작된 시간입니다.
  • reserve_finished_atdate
    예약 결제가 실행이 완료된 시간입니다.
  • versionnumber
    요청된 API 버전으로, 사용된 부트페이 SDK의 버전을 의미합니다.
    범위: 1 | 2
  • reserve_revoked_atdate
    예약 결제가 취소된 시간입니다.
  • feedback_urlstring
    웹훅을 받을 주소를 입력할 수 있습니다. 값이 없을 경우 부트페이 관리자에 설정된 URL로 전송됩니다.
  • content_typestring
    웹훅을 받을 데이터 타입을 입력할 수 있습니다. application/json 또는 application/x-www-form-urlencoded 를 선택하여 입력합니다. 값이 없을 경우 부트페이 관리자에 설정된 값으로 전송됩니다.
  • statusnumber
    현재 결제 상태입니다.
    • -1
      예약 결제 실패 상태입니다.
    • 0
      결제가 최초로 생성되어 요청이 대기 중인 상태입니다.
    • 1
      결제가 완료된 상태입니다. 부분취소가 된 상태에서 전체금액이 취소되지 않았다면, 결제완료 상태입니다.
    • 3
      예약된 결제가 예약취소된 상태입니다.
추가 예제: 더 자세한 예제는
백엔드
예약 결제 조회
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import { Bootpay } from '@bootpay/backend-js' Bootpay.setConfiguration({    application_id: '[ REST API용 Application ID ]',    private_key: '[ Private KEy ]'}) try {    await Bootpay.getAccessToken()    const reserveId = '6490149ca575b40024f0b70d'    await Bootpay.subscribePaymentReserveLookup(reserveId)    console.log(response)} catch (e) {    console.log(e)}