현금 영수증 취소
해당 결제가 status = PAY_COMPLETE으로 완료되었고, 발급 요청된 현금 영수증이 있을 때에만 호출 가능합니다.
각 API 응답 필드와 에러코드는 사전 공지 없이 추가되거나 변경될 수도 있으니, 추가된 항목으로 인해 오류가 발생하지 않도록 처리에 유의해 주시기 바랍니다.
주의 사항: 현금영수증 취소 API의 경우에도 금액과 관련된 parameter를 받지 않습니다. 결제 환불 API를 통해 토스 시스템에서 기록된 남은 금액을 바탕으로 현금영수증 취소를 처리합니다. 따라서 전체 환불, 부분 환불의 구분 없이 취소 API를 호출하면, 남은 결제 금액에 맞게 알아서 처리됩니다.
엔드포인트
POSThttps://pay.toss.im/api/v2/revoke-cash-receipt
요청 파라미터
apiKeystring필수
maxLen: 30
결제 가맹점의 API Key
API Key는 LIVE 값만 동작하며 TEST 값은 무시됩니다.
payTokenstring필수
maxLen: 30
결제토큰
현금영수증 발급 대상 결제는 '결제 완료' 상태여야 합니다. status = PAY_COMPLETE
Example Request
{
"apiKey": "example_api_key",
"payToken": "example_payToken"
}응답 파라미터
statusinteger
http status code
codeinteger
응답 코드
0: 정상, 그 외 값은 에러
cashReceiptMgtKeystring
관리번호 값
발급 요청된 현금영수증을 확인할 수 있는 관리번호 값
Example Response
{
"status": 200,
"code": 0,
"cashReceiptMgtKey": "123456-123456",
"supplyCost": 9090,
"tax": 910,
"serviceFee": 0
}