응답 본문

토스페이먼츠 API의 성공 여부는 HTTP 상태 코드로 전달합니다. 돌아온 HTTP 상태 코드에 따라 요청이나 에러를 처리하는 로직을 구축하세요.

모든 API 응답, 요청 본문(body)은 JSON 포맷입니다. 따라서 응답 헤더에는 다음과 같이 Content-Type이 포함됩니다.

Content-Type: application/json

응답 HTTP 상태 코드

HTTP 상태 코드	설명
`200 - OK`	요청이 성공적으로 처리되었습니다.
`400 - Bad Request`	요청을 처리할 수 없습니다. 필수 파라미터를 보내지 않았거나, 파라미터 포맷이 잘못되었을 때 돌아오는 응답입니다. 요청 파라미터를 확인해주세요.
`403 - Forbidden`	시크릿 키 없이 요청했거나 사용한 시크릿 키가 잘못되었습니다. 개발자센터에서 내 상점의 키 값을 다시 한 번 확인하고, 시크릿 키 문서를 참고하세요.
`404 - Not Found`	요청한 리소스가 존재하지 않습니다. 요청한 API 주소를 다시 한 번 확인해보세요.
`500 - Server Error`	토스페이먼츠 서버에서 에러가 발생했습니다.

요청이 정상적으로 처리되지 않으면 응답으로 HTTP 상태 코드와 함께 아래와 같은 에러 객체가 돌아옵니다.

{
  "code": "NOT_FOUND_PAYMENT",
  "message": "존재하지 않는 결제 입니다."
}

JSON

API 별 에러 코드와 메시지는 에러 코드 페이지에서 살펴보세요.