Payment

결제 히스토리 상세 조회

Changed on

특정 결제 내역의 상세 정보를 조회합니다. 결제 상태, 취소 내역, 증빙서류 정보 등을 확인할 수 있습니다.

get/v2/payment/payment-histories/{historyId}

Request

  • Base URL
    https://api.sendon.io
  • URL
    https://api.sendon.io/v2/payment/payment-histories/{historyId}
  • Auth
    HTTP basic

Path parameters

historyIdnumber nullable required
Example:1234567890

조회할 결제 내역의 ID입니다. 결제 히스토리 목록에서 받은 ID를 사용하세요.

Response

결제 히스토리 상세 조회 요청의 처리 결과입니다. 요청한 결제 내역의 모든 상세 정보가 포함됩니다.

codenumber required

HTTP 상태 코드입니다. 200이면 성공, 400대는 클라이언트 오류, 500대는 서버 오류를 나타냅니다.

messagestring required

API 호출 결과에 대한 사람이 읽을 수 있는 메시지입니다. 성공 시 "OK", 실패 시 구체적인 오류 사유가 포함됩니다.

Example response

{
  "code": 200,
  "message": "OK",
  "data": {
    "history": {
      "id": 12345,
      "amount": 50000,
      "proofDocumentId": "doc_123456",
      "memo": "추가 할인 적용됨",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "expiredAt": "2024-02-15T10:30:00Z"
    }
  }
}

Changes

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • info

      api operation id getPaymentHistory removed and replaced with PaymentController_getPaymentHistory

    • info

      the endpoint scheme security basic was added to the API

    • info

      added to the response property allOf list for the response status