Main API
관리자 결제 API
관리자용 결제 조회 및 취소 API
관리자 결제 API
관리자용 결제 조회 및 취소 관리 API입니다.
Base URL: /admin/payments
이 API는 관리자 전용입니다. 테스트 및 운영 목적으로 사용됩니다.
인증 정보
| 항목 | 값 |
|---|---|
| 인증 필요 | 예 (관리자 권한) |
| 인증 방식 | JWT Bearer Token |
엔드포인트 목록
결제 조회
| 메서드 | 경로 | 설명 | 인증 |
|---|---|---|---|
GET | /admin/payments/page | 관리자 결제 관리 페이지 | 필요 |
GET | /admin/payments/list | 모든 결제 정보 조회 | 필요 |
GET | /admin/payments | 결제 정보 조회 (intentKey) | 필요 |
결제 실패 기록
| 메서드 | 경로 | 설명 | 인증 |
|---|---|---|---|
GET | /admin/payments/failures/list | 모든 실패 기록 조회 | 필요 |
GET | /admin/payments/failures | 실패 기록 조회 (intentKey) | 필요 |
결제 취소
| 메서드 | 경로 | 설명 | 인증 |
|---|---|---|---|
POST | /admin/payments/{intentKey}/cancel | 결제 취소 | 필요 |
API 상세
모든 결제 정보 조회
모든 결제 정보를 조회합니다.
HTTP 요청
GET /admin/payments/list
Authorization: Bearer {access_token}응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "결제 정보 조회 성공",
"data": [
{
"id": 1,
"intentKey": "intent_xxxxxxxxxxxxx",
"orderId": "ORDER_001",
"amount": 50000,
"status": "DONE",
"createdAt": "2024-01-15T10:00:00",
"approvedAt": "2024-01-15T10:00:30"
}
]
}결제 정보 조회 (intentKey)
intentKey로 특정 결제 정보를 조회합니다.
HTTP 요청
GET /admin/payments?intentKey={intentKey}
Authorization: Bearer {access_token}Query Parameters
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
intentKey | string | 예 | 결제 키 |
응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "결제 정보 조회 성공",
"data": {
"id": 1,
"intentKey": "intent_xxxxxxxxxxxxx",
"orderId": "ORDER_001",
"amount": 50000,
"status": "DONE",
"createdAt": "2024-01-15T10:00:00",
"approvedAt": "2024-01-15T10:00:30"
}
}모든 결제 실패 기록 조회
모든 결제 실패 기록을 조회합니다.
HTTP 요청
GET /admin/payments/failures/list
Authorization: Bearer {access_token}응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "결제 실패 기록 조회 성공",
"data": [
{
"id": 1,
"intentKey": "intent_xxxxxxxxxxxxx",
"orderId": "ORDER_001",
"errorCode": "PAYMENT_FAILED",
"errorMessage": "결제 실패",
"createdAt": "2024-01-15T10:00:00"
}
]
}결제 취소
intentKey로 결제를 취소합니다.
HTTP 요청
POST /admin/payments/{intentKey}/cancel
Authorization: Bearer {access_token}
Content-Type: application/jsonPath Parameters
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
intentKey | string | 예 | 결제 키 |
Request Body (선택)
{
"cancelReason": "관리자 취소"
}응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "결제 취소 성공",
"data": {
"intentKey": "intent_xxxxxxxxxxxxx",
"status": "canceled",
"message": "결제가 취소되었습니다.",
"httpStatusCode": 200
}
}이미 취소된 결제 (200 OK)
{
"status": 200,
"code": null,
"message": "이미 취소된 결제입니다.",
"data": {
"intentKey": "intent_xxxxxxxxxxxxx",
"status": "already_canceled"
}
}에러 응답
| 상태 코드 | 코드 | 메시지 |
|---|---|---|
| 404 | NOT_FOUND | 결제 정보를 찾을 수 없습니다. |
| 500 | CANCEL_FAILED | 결제 취소에 실패했습니다. |
결제 상태
| 상태 | 설명 |
|---|---|
READY | 결제 대기 |
IN_PROGRESS | 결제 진행중 |
DONE | 결제 완료 |
CANCELED | 결제 취소 |
FAILED | 결제 실패 |