현금 영수증 팝업 주소 전달

토스 결제 가맹점을 이용한 고객이 현금영수증의 발급 및 취소된 것의 발급 이미지 등을 요구할 때, 해당 API를 호출하여 리턴되는 팝업 Uri 값으로 대응이 가능합니다.

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

엔드포인트

POSThttps://pay.toss.im/api/v2/cash-receipt-popupUri

요청 파라미터

apiKeystring필수

maxLen: 30

결제 가맹점의 API Key

API Key는 LIVE 값만 동작하며 TEST 값은 무시됩니다.

payTokenstring필수

maxLen: 30

결제토큰

결제토큰

Example Request

json

{
  "apiKey": "example_api_key",
  "payToken": "example_payToken"
}

응답 파라미터

codeinteger

응답 코드

0: 정상, 그 외 값은 에러

popupUristring

팝업 Uri

발급 및 취소 상태인 현금영수증을 웹브라우저에서 직접 확인할 수 있는 팝업 Uri 값

Example Response

{
  "code": 0,
  "popupUri": "https://pay.toss.im/payfront/web/external/cash-receipt?payToken=example_payToken&mgtKey=f017f18b-2356-bNpwieGeQp"
}