링크 결제

토스페이먼트 결제 취소 API를 활용하여 전액 또는 일부 금액을 환불하는 방법, 가상계좌 결제 취소 방법, 결제 위젯에서 가상계좌 정보를 확인하는 방법을 소개하겠습니다.

결제 취소 기한

먼저, 결제 수단별로 취소 기한과 취소 시점이 다릅니다. 아래 표의 정보를 확인하시고, 구매자에게 필요한 정보를 제공해 주시기 바랍니다.

모두 취소

결제 취소 API의 엔드포인트에결제 승인 API요청 결과로 받은 paymentKey를 경로 파라미터로 추가하세요. API 요청 본문에 있는 취소 사유는 cancelReason으로 추가합니다. Idempotent 헤더를 추가하면, 중복 취소 없이 안전하게 처리됩니다.

curl

request

curl --request POST \
  --url https://api.tosspayments.com/v1/payments/{paymentKey}/cancel \
  --header 'Authorization: Basic dGVzdF9za196WExrS0V5cE5BcldtbzUwblgzbG1lYXhZRzVSOg==' \
  --header 'Content-Type: application/json' \
  --data '{"cancelReason":"고객이 취소를 원함"}'

Python

import http.client

conn = http.client.HTTPSConnection("api.tosspayments.com")

payload = "{\"cancelReason\":\"고객이 취소를 원함\"}"

headers = {
    'Authorization': "Basic dGVzdF9za196WExrS0V5cE5BcldtbzUwblgzbG1lYXhZRzVSOg==",
    'Content-Type': "application/json"
}

conn.request("POST", "/v1/payments/{paymentKey}/cancel", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.tosspayments.com/v1/payments/{paymentKey}/cancel"))
    .header("Authorization", "Basic dGVzdF9za196WExrS0V5cE5BcldtbzUwblgzbG1lYXhZRzVSOg==")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"cancelReason\":\"고객이 취소를 원함\"}"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());