Search Info

Search Infos

GET /api/payments

Access Permissions

Role	Description
ADMIN	관리자
MANAGER	CS 담당자
SELLER	판매자
CUSTOMER	구매자

Request Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Request Parameter

Name	Type	Description
page	int	Page number
size	int	Page Size (10,30,50)
sort	String	Value of the 'orderby' (ex) createdAt)
direction	String	Direction of the sorting (DESC, ASC)
keyword	String	주문일(createAt), 결제방법(paymentMethod), 주문상태(state)

Response

200

{ 
    "status": 200,
    "data": [
      {
        "orderId": 98765,
        "userId": 12345,
        "state": "결제완료",
        "totalPrice": 42500,
        "paymentKey": "String", // 토스페이먼츠에서 응답한 paymentKey
        "amount": "Number", // 토스페이먼츠에서 응답한 amount
        "paymentMethod": "CREDIT_CARD"
      },{
       "orderId": 98766,
       "userId": 12345,
       "state": "결제완료",
       "totalPrice": 42500,
       "paymentKey": "String", // 토스페이먼츠에서 응답한 paymentKey
       "amount": "Number", // 토스페이먼츠에서 응답한 amount
       "paymentMethod": "CREDIT_CARD"
      }
    ],
    "error": null,
    "timeStamp": "2024-09-27 12:00:00"
}

ERROR

{ 
    "status": 400, // ERROR 코드 ex) 400, 401, 403, 404 등
    "data": null,
    "error": {
        "message": "ERROR 발생 시 e.getmessage 결과"
    },
    "timeStamp": "2024-09-27 12:00:00"
}