객체: ErrorResponse

응답 본문

200이 아닌 모든 HTTP 응답의 HTTP 본문입니다.

응답의 예는 다음과 같습니다.


  {
    "responseHeader": {
      "requestTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }
JSON 표현
{
  "responseHeader": {
    object(ResponseHeader)
  },
  "errorResponseCode": string,
  "errorDescription": string,
}
필드
responseHeader

object(ResponseHeader)

필수: 모든 응답의 공통 헤더입니다.

errorResponseCode

string

선택사항: 아래 표에 나열된 코드 중 하나를 입력합니다.

오류 응답 코드 및 권장 HTTP 코드
INVALID_API_VERSION 400

통합업체가 요청의 API 버전을 지원하지 않는 경우에 사용됩니다.

INVALID_PAYLOAD_SIGNATURE 401

페이로드의 서명이 알 수 없거나 비활성 키인 경우 사용됩니다.

INVALID_PAYLOAD_ENCRYPTION 400

페이로드 암호화가 알 수 없거나 비활성 키인 경우 사용됩니다.

REQUEST_TIMESTAMP_OUT_OF_RANGE 400

request_timestamp가 현재 ± 60초가 아닌 경우 사용됩니다.

INVALID_IDENTIFIER 404

요청에 전송된 식별자가 잘못되었거나 알 수 없는 경우에 사용됩니다. 여기에는 paymentIntegratorAccountId, googlePaymentToken, captureRequestId 등이 포함될 수 있습니다. 잘못된 식별자의 유형은 errorDescription에 지정해야 합니다.

IDEMPOTENCY_VIOLATION 412

요청이 요청의 멱등성 요구사항을 위반하는 경우 사용됩니다.

INVALID_FIELD_VALUE 400

지원되는 값 집합에 없는 필드 값이 요청에 포함된 경우 사용됩니다.

MISSING_REQUIRED_FIELD 400

요청에서 필수 필드가 설정되지 않은 경우 사용됩니다.

PRECONDITION_VIOLATION 400

작업의 제약조건을 위반하는 경우 (예: 환불 금액 요청이 거래의 남은 금액을 초과하는 경우) 사용됩니다.

USER_ACTION_IN_PROGRESS 400

현재 요청을 처리할 수 없는 경우 사용됩니다. 이는 사실상 시스템 잠금 역할을 하는 진행 중인 사용자 작업을 중단하기 때문입니다. 이 코드는 구현별 내부 동시 실행 오류로 인한 실패를 나타내는 데 사용하면 안 됩니다.

INVALID_DECRYPTED_REQUEST 400

요청 페이로드를 복호화할 수 있지만 결과 메시지를 파싱할 수 없는 경우에 사용됩니다.

errorDescription

string

선택사항: 오류를 디버그할 수 있도록 지원 담당자가 이 상태에 관한 설명을 제공합니다. 사용자에게는 표시되지 않습니다. 디버깅에 사용되는 설명적이고 민감하지 않은 텍스트를 포함할 수 있습니다. errorResponseCode의 일부 값에는 이 필드의 추가 세부정보가 포함되어야 합니다 (예: INVALID_IDENTIFIER에는 잘못된 식별자 유형에 관한 정보가 이 필드의 정보와 함께 제공되어야 합니다).