Payment

결제 히스토리 목록 조회

Changed on

사용자의 결제 내역을 기간별로 조회합니다. 결제 상태, 금액, 결제 수단 등의 정보를 페이징 방식으로 확인할 수 있습니다.

get/v2/payment/payment-histories

Request

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

Query parameters

endDatestring date-time nullable
Example:2024-12-31

조회할 기간의 종료일입니다. 미지정시 현재 날짜까지 조회됩니다.

startDatestring date-time nullable
Example:2024-01-01

조회할 기간의 시작일입니다. 미지정시 최근 30일부터 조회됩니다.

limitnumber nullable
Example:20

한 번에 조회할 결제 내역의 개수입니다. 기본값은 10개이며, 너무 큰 값을 설정하면 응답 속도가 느려질 수 있습니다.

pagenumber nullable
Example:1

페이지 번호

Response

결제 히스토리 목록 조회 요청의 처리 결과입니다. 결제 내역 목록과 페이징 정보가 포함됩니다.

codenumber required

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

messagestring required

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

Example response

{
  "code": 200,
  "message": "OK",
  "data": {
    "histories": [
      {
        "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"
      }
    ],
    "totalCount": 1250,
    "totalPages": 63,
    "currentPage": 1,
    "hasNextPage": true
  }
}

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

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      api operation id getPaymentHistories removed and replaced with PaymentController_getPaymentHistories

    • info

      the endpoint scheme security basic was added to the API

    • info

      added to the response property allOf list for the response status