자동결제

빌링키 삭제

해지 후 남은 카드 토큰을 API로 삭제할 수 있어요.

더 이상 사용하지 않는 빌링키를 삭제해요. 삭제 후에는 해당 빌링키로 결제를 요청할 수 없어요.

핵심 요약

  • 빌링키 삭제는 결제수단 토큰을 더 이상 사용하지 못하게 하는 작업이에요.
  • 해지·탈퇴·카드 변경 시 내부 DB 상태도 revoked로 바꿔 청구 대상에서 제외해야 해요.
  • 삭제 후에는 같은 빌링키로 빌링키 결제 요청이나 예약 등록을 할 수 없어요.
  • 이미 등록된 예약결제가 있다면 삭제 전에 예약 조회예약 취소를 먼저 처리해야 해요.

삭제 전 점검 흐름

API 엔드포인트

DELETEhttps://api.bootpay.co.kr/v2/subscribe/billing_key/:billing_keyBasic Auth

빌링키 삭제는 결제수단 토큰을 삭제하는 작업이고, 예약 취소는 미래 결제 예약을 제거하는 작업이에요. 빌링키를 삭제해도 이미 등록된 예약결제가 자동으로 취소된다고 가정하면 안 돼요. 예약결제까지 중단해야 한다면 먼저 예약 취소를 호출하고, 그 다음 빌링키를 삭제해요. 자세한 순서는 예약결제 운영 주의사항을 참고해요.

요청 파라미터

파라미터 타입 필수 설명
billing_key String 필수 삭제할 빌링키 (URL 파라미터)

코드 예제

import { Bootpay } from '@bootpay/backend-js'

Bootpay.setConfiguration({
    client_key: '[ Client Key ]',
    secret_key: '[ Secret Key ]'
})

try {
    const response = await Bootpay.destroyBillingKey('[ billing_key ]')
    console.log(response)
} catch (e) {
    console.log(e)
}javascript

응답

성공 응답

{
  "billing_key": "[ 취소된 billing key ]"
}json

에러 응답

{
  "error_code": "AUTHENTICITY_TOKEN_EXPIRE",
  "message": "Access Token이 잘못되었거나 만료되었습니다."
}json

에러 코드

공통 에러

인증·권한 관련 에러는 에러 코드표를 참고해요.

코드 메시지 대처 방법
SUBSCRIBE_BK_NOT_FOUND (2309) 빌링키 발급 내역을 찾지 못했다 billing_key가 올바른지 확인해요
SUBSCRIBE_BK_EXPIRED (2310) 빌링키 유효기간 만료 이미 만료된 빌링키예요. 새로 발급받아요

다음 단계