빌링키 조회하기

유효한 빌링키인지 조회해요. 빌링키가 유효하지 않으면 결제를 요청할 수 없으며, 처음부터 다시 발급받아야 해요.

receipt_id로 조회
빌링키 발급 시 받은 영수증 ID로 조회
billing_key로 조회
이미 발급받은 빌링키로 조회
1
receipt_id로 조회하기
Server

빌링키 발급요청시 발급된 receipt_id를 이용하여 빌링키를 조회할 수 있습니다.

GET
https://api.bootpay.co.kr/v2/subscribe/billing_key/:receipt_id
요청 파라미터
  • receipt_id필수string
    부트페이에서 부여하는 영수증 ID로 고유한 값을 가집니다. 이 값은 데이터베이스에 반드시 저장되어야 합니다.
2
응답 결과
Server

빌링키 조회시 응답값은 아래와 같습니다.

 
응답 파라미터
  • receipt_idstring
    부트페이에서 부여하는 영수증 ID로 고유한 값을 가집니다. 결제 요청 시 생성되며, confirm, done, error 이벤트 및 관리자 페이지의 결제내역에서 확인할 수 있습니다. 데이터베이스에 반드시 저장해야 합니다.
  • gateway_urlstring
    PG로 요청된 부트페이 URL입니다. 이 값은 부트페이 내부적으로 사용되며, PG사에 referer로 전달됩니다.
  • metadatahash
    결제 요청 시 전달된 메타데이터입니다. 전송된 데이터는 그대로 반환됩니다.
  • pgstring
    결제가 완료된 PG사의 이름입니다.
  • methodstring
    결제에 사용된 결제 수단의 이름입니다.
  • method_symbolstring
    결제 수단의 영문 심볼입니다.
  • method_origin_symbolstring
    원본 결제 수단의 영문 심볼입니다.
  • requested_atdate
    결제가 최초 요청된 시간입니다. ISO 8601형식으로 제공됩니다. * 부트페이 서버 시간 기준입니다.
  • published_atdate
    빌링키 발급된 시간입니다. ISO 8601형식으로 제공됩니다.
  • status_localestring
    빌링키 발급 상태를 한글로 제공합니다. * "빌링키발급완료" 데이터로 제공됩니다
  • statusstring
    빌링키 발급 상태입니다 * 빌링키 완료 값은 "11" 입니다.
  • billing_keystring
    빌링키입니다. 등록된 계좌로 이체 결제 요청시 사용됩니다. * 반드시 데이터베이스에 저장이 되어야 합니다.
  • billing_datahash
    빌링키와 연결된 계좌, 계좌주, 은행등의 정보입니다.
    • bank_code자동계좌이체string
      숫자 3자리로 이루어진 은행코드입니다.
    • bank_name자동계좌이체string
      빌링키와 연결된 계좌의 은행명입니다. 은행코드표를 참조하세요
    • bank_account자동계좌이체string
      빌링키와 연결된 계좌번호입니다. 중간에 값이 마스킹되어 들어갑니다.
    • username자동계좌이체string
      빌링키와 연결된 계좌의 계좌주명입니다.
    • card_company자동카드결제string
      빌링키와 연결된 카드사명입니다.
    • card_no자동카드결제string
      빌링키와 연결된 카드의 마스킹된 카드번호입니다.
    • card_company_code자동카드결제string
      빌링키와 연결된 카드사 코드입니다. * PG사가 정의한 카드사 코드입니다.
    • card_type자동카드결제number
      등록된 카드 종류입니다.
      • 0신용카드
        1체크카드
    • card_hash자동카드결제number
      등록된 카드의 고유 HASH 값입니다. 일부 PG는 이 값이 전달되지 않습니다. * KCP만 전달
  • billing_expired_atdate
    빌링키 만료일입니다. ISO 8601형식으로 제공됩니다. 계좌의 경우 별도의 만료일이 없기 때문에 2099-12-31 23:59:59로 전달됩니다.
백엔드
receipt_id로 조회
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 response = await Bootpay.lookupSubscribeBillingKey('[ receipt_id ]')    console.log(response)} catch (e) {    // 발급 실패시 오류    console.log(e)}