토스페이 연동가이드

API 레퍼런스자동 결제 API

빌링키 삭제 요청

토스 자동결제를 등록하기 위해서는 사용자를 식별할 수 있는 고유한 빌링키를 생성해야 합니다. API 요청의 응답으로 성공 여부와 함께 토스 앱 인증 URL을 전달합니다. 빌링키 삭제 요청 API 사양은 다음과 같습니다.

각 API 응답 필드와 에러코드는 사전 공지 없이 추가되거나 변경될 수도 있으니, 추가된 항목으로 인해 오류가 발생하지 않도록 처리에 유의해 주시기 바랍니다.

엔드포인트

POSThttps://pay.toss.im/api/v1/billing-key/remove/

요청 파라미터

apiKeystring필수

결제 가맹점의 API Key. 가맹점에 발급된 API Key - 빌링키 생성요청 시 사용된 API Key 와 동일해야한다. 그렇지 않으면 오류가 발생한다.

billingKeystring필수

자동결제 사용자 빌링키. 토스가 생성한 자동결제 사용자 빌링키

응답 파라미터

codeinteger

응답코드

가능한 값:

0성공

-1실패 (실패사유는 msg와 errorCode로 제공)

에러 응답

code가 -1일 때만 에러코드와 실패 사유를 전달합니다.

errorCodestring

에러코드

msgstring

에러메시지. 상세한 에러 설명

예제

Example Request

curl -X POST \
  https://pay.toss.im/api/v1/billing-key/remove \
  -H 'Content-Type: application/json' \
  -d '{
    "apiKey": "example_api_key",
    "billingKey": "example-billingKey"
}'

Example Response

{
  "code": 0
}

빌링키 상태 조회

이전

결제 환불

다음

목차

엔드포인트 요청 파라미터 응답 파라미터 에러 응답 예제 Example Request Example Response