> ## Documentation Index > Fetch the complete documentation index at: https://docs.meterengine.com/llms.txt > Use this file to discover all available pages before exploring further. # 결제 취소 요청 > done인 결제 시도의 금액 전부나 일부를 토스페이먼츠에 취소 요청한다. amount를 빼면 남은 결제 금액 전부를 취소한다. 남은 결제 금액은 시도 금액에서 done인 취소의 합을 뺀 값이다. 시도의 결제 모드 키로 토스페이먼츠를 부른다. 취소되면 status=done, 거절되면 status=failed와 failure_code, failure_message가 남고 둘 다 201이다. 토스페이먼츠 응답으로 결과를 확인하지 못하면 status=pending인 취소를 201로 돌려준다. 시도 하나에 pending인 취소는 하나뿐이다. 있으면 409다. API 키의 모드가 취소 대상과 다르면 409다. Idempotency-Key를 주면 같은 도입사와 환경의 같은 요청을 다시 보내도 그 취소를 지금 상태로 201로 돌려준다. 같은 키로 다른 시도, 금액, 사유를 보내면 409다. 이 키는 고객과 미터 등록의 Idempotency-Key와 계약이 다르다. UUID만 받고, 충돌 code는 payment_cancellation_idempotency_conflict이며, 다시 돌려준 응답에 Idempotency-Replayed 헤더를 붙이지 않는다. requested_at과 completed_at은 KST(+09:00)로 나온다. ## OpenAPI ````yaml https://raw.githubusercontent.com/asm17-ms2/meterengine/main/backend/openapi.yaml post /v1/payment-attempts/{id}/cancellations openapi: 3.1.0 info: description: | 사용량 기반 과금 플랫폼의 API. 사용량 이벤트를 수집하고, 고객별 월 사용량과 청구 예정액을 조회한다. 요청마다 Authorization 헤더에 Bearer 값으로 API 키(me_live_ 또는 me_test_로 시작)나 로그인 세션 토큰을 싣는다. 도입사는 키나 세션이 정한다. 헤더가 없으면 401이다. X-MeterEngine-Environment: test 또는 live로 업무 환경을 지정한다. 새 키는 발급 환경에 고정된다. 기존 데이터와 키는 환경 미지정 범위로 보존하며 자동으로 test/live에 배정하지 않는다. 환경 분리가 지원되지 않는 업무는 명시 환경 요청에 409를 반환한다. X-MeterEngine-Organization-Id: 화면의 도입사를 고정하는 선택 UUID 헤더다. 인증된 도입사와 다르면 403이며 이 헤더로 인증이나 도입사 전환을 대신할 수 없다. 오류 응답은 code, message, errors로 이뤄진다. 오류별 처리는 code로 분기한다. message는 code마다 하나인 한국어 문구이고, errors는 틀린 필드를 짚을 수 있는 400에만 실린다. title: MeterEngine API version: v1 servers: - description: MeterEngine API url: https://meterengine.com security: - bearerAuth: [] tags: - name: organization-environment-controller x-group: 업무 환경 - name: current-organization-controller x-group: 도입사 정보 - name: api-key-controller x-group: API 키 (콘솔 전용) - name: organization-people-controller x-group: 구성원과 초대 (콘솔 전용) - name: audit-log-controller x-group: 감사 기록 (콘솔 전용) - name: billable-metric-controller x-group: 미터 - name: billable-metric-price-controller x-group: 미터별 단가 조회 - name: price-rate-controller x-group: 단가 - name: price-plan-controller x-group: 요금제 - name: customer-controller x-group: 고객 - name: event-controller x-group: 이벤트 - name: event-batch-controller x-group: 이벤트 일괄 전송 - name: event-export-controller x-group: 이벤트 내보내기 - name: billable-metric-usage-controller x-group: 사용량 집계 - name: event-issue-controller x-group: 이벤트 매핑 진단 - name: event-rejection-controller x-group: 수집 거절 - name: unbilled-event-controller x-group: 청구 제외 사용량 - name: dashboard-controller x-group: 개요 - name: workspace-query-controller x-group: 검색과 내보내기 - name: draft-invoice-controller x-group: 청구 예정액 - name: invoice-controller x-group: 인보이스 - name: invoice-view-link-controller x-group: 인보이스 조회 링크 - name: payment-setting-controller x-group: 결제 설정 - name: toss-payments-credential-controller x-group: 토스페이먼츠 키 - name: payment-method-registration-controller x-group: 카드 등록 링크 - name: payment-method-controller x-group: 결제 수단 - name: payment-attempt-controller x-group: 결제 요청 - name: invoice-payment-controller x-group: 수납 상태 - name: payment-cancellation-controller x-group: 결제 취소 - name: payment-reconciliation-mismatch-controller x-group: 대사 불일치 - name: toss-payments-webhook-controller x-group: 토스페이먼츠 웹훅 수신 - name: webhook-endpoint-controller x-group: 웹훅 paths: /v1/payment-attempts/{id}/cancellations: post: tags: - payment-cancellation-controller summary: 결제 취소 요청 description: > done인 결제 시도의 금액 전부나 일부를 토스페이먼츠에 취소 요청한다. amount를 빼면 남은 결제 금액 전부를 취소한다. 남은 결제 금액은 시도 금액에서 done인 취소의 합을 뺀 값이다. 시도의 결제 모드 키로 토스페이먼츠를 부른다. 취소되면 status=done, 거절되면 status=failed와 failure_code, failure_message가 남고 둘 다 201이다. 토스페이먼츠 응답으로 결과를 확인하지 못하면 status=pending인 취소를 201로 돌려준다. 시도 하나에 pending인 취소는 하나뿐이다. 있으면 409다. API 키의 모드가 취소 대상과 다르면 409다. Idempotency-Key를 주면 같은 도입사와 환경의 같은 요청을 다시 보내도 그 취소를 지금 상태로 201로 돌려준다. 같은 키로 다른 시도, 금액, 사유를 보내면 409다. 이 키는 고객과 미터 등록의 Idempotency-Key와 계약이 다르다. UUID만 받고, 충돌 code는 payment_cancellation_idempotency_conflict이며, 다시 돌려준 응답에 Idempotency-Replayed 헤더를 붙이지 않는다. requested_at과 completed_at은 KST(+09:00)로 나온다. operationId: createPaymentCancellation parameters: - description: 취소할 결제 시도의 id. in: path name: id required: true schema: type: string format: uuid - description: 취소 요청마다 발급한 UUID. 응답을 받지 못해 다시 요청할 때는 같은 값을 보낸다. in: header name: Idempotency-Key required: false schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePaymentCancellationRequest' required: true responses: '201': content: '*/*': schema: $ref: '#/components/schemas/PaymentCancellationResponse' description: 결제 취소. status는 done, failed, pending 중 하나 '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: > code=validation_error: 경로의 id나 Idempotency-Key가 UUID가 아니거나, amount가 양수가 아니거나, reason이 비었거나 200자를 넘거나 NUL 문자나 짝이 없는 UTF-16 서로게이트가 있다. code=malformed_request_body: 본문을 JSON으로 읽을 수 없거나 amount가 정수가 아니다. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: | code=authentication_required: Authorization 헤더가 없다. code=invalid_credentials: 키나 토큰의 형식이 틀렸거나, 모르는 값이거나, 폐기 또는 만료됐다. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: > code=permission_denied: 키의 스코프나 계정의 역할로는 할 수 없는 요청이거나, 도입사가 정해지지 않은 로그인 세션이다. code=organization_not_active: 도입사가 활성 상태가 아니다. code=consent_required: 로그인 세션의 사용자가 필수 안내에 아직 동의하지 않았다. POST /v1/sessions/current/consents로 동의한다. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: 'code=payment_attempt_not_found: 그런 결제 시도가 없다' '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: > code=payment_mode_mismatch: API 키의 모드가 취소 대상의 모드와 다르다. code=payment_attempt_not_cancelable: 시도가 done이 아니다. code=payment_attempt_fully_canceled: done인 시도를 이미 전액 취소해 남은 결제 금액이 0원이다. code=payment_cancellation_in_progress: 이 시도에 pending인 취소가 있다. code=payment_cancellation_amount_exceeded: amount가 남은 결제 금액보다 크다. code=payment_cancellation_idempotency_conflict: 같은 Idempotency-Key를 다른 취소 요청에 사용했다. '429': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- code=rate_limit_exceeded: 키의 분당 요청 한도를 넘었다. Retry-After 헤더의 초만큼 기다린 뒤 다시 보낸다. headers: Retry-After: description: 다시 보내기 전에 기다릴 초 required: true schema: type: integer format: int32 components: schemas: CreatePaymentCancellationRequest: type: object properties: amount: type: integer format: int64 description: 취소할 금액. 원 단위 양의 정수. 빼면 남은 결제 금액 전부를 취소한다 reason: type: string description: 취소 사유. 토스페이먼츠에 그대로 넘긴다 maxLength: 200 minLength: 0 required: - reason PaymentCancellationResponse: type: object properties: amount: type: integer format: int64 description: 취소한 금액. 원 단위 정수 completed_at: type: string format: date-time failure_code: type: string description: > failed일 때만 있다. 토스페이먼츠가 준 값: 취소 거절 코드(예: NOT_CANCELABLE_AMOUNT). MeterEngine이 정한 값: HTTP_<상태>(토스페이먼츠 거절 응답에 코드가 없을 때 그 HTTP 상태), NOT_FOUND_CANCELLATION(취소를 요청하고 payment.not-found-failure-delay(기본 10분)가 지나도 토스페이먼츠 결제 조회에 이 취소에 맞는 취소 거래가 없을 때. 토스페이먼츠 코드가 아니다), toss_payments_credential_missing(토스페이먼츠를 부르기 전에 결제 모드의 키가 없었다). failure_message: type: string description: >- failed일 때만 있다. 토스페이먼츠가 준 거절 문구이거나, failure_code가 MeterEngine 코드면 그 오류 문구다 id: type: string format: uuid mode: type: string description: 취소한 결제 시도의 결제 모드. test 또는 live enum: - test - live payment_attempt_id: type: string format: uuid reason: type: string description: 취소 사유 requested_at: type: string format: date-time status: type: string description: pending은 토스페이먼츠 결과를 아직 확인하지 못한 취소다 enum: - pending - done - failed ErrorResponse: type: object description: 오류 응답. code로 오류 종류를 구분하고, message는 code마다 하나인 한국어 문구다. properties: code: type: string description: 오류 종류. 오류별 처리는 이 값으로 분기한다. enum: - validation_error - malformed_request_body - invalid_billable_metric - invalid_price_rate - event_too_old - invalid_toss_payments_credential - payment_method_rejected - toss_payments_test_code_in_live_mode - invalid_webhook_url - invalid_webhook_event_type - authentication_required - invalid_credentials - permission_denied - organization_not_active - environment_mismatch - consent_required - customer_not_found - event_not_found - billable_metric_not_found - price_rate_not_found - invoice_not_found - invoice_view_link_not_found - endpoint_not_found - api_key_not_found - organization_not_found - user_account_not_found - payment_method_not_found - payment_method_registration_not_found - payment_attempt_not_found - toss_payments_credential_not_found - price_plan_not_found - webhook_endpoint_not_found - webhook_delivery_not_found - invitation_not_found - method_not_allowed - response_type_not_acceptable - resource_version_conflict - idempotency_conflict - customer_archived - resource_archived - environment_not_ready - archive_restoration_conflict - customer_has_events - customer_has_payment_attempts - billable_metric_has_events - billable_metric_has_price_rate - billable_metric_already_exists - billable_metric_event_type_target_property_already_exists - invoice_already_paid - payment_result_unconfirmed - payment_retry_unavailable - payment_retry_stale - invoice_amount_zero - email_already_exists - organization_status_transition_invalid - organization_member_already_exists - toss_payments_credential_missing - payment_method_missing - payment_mode_mismatch - payment_attempt_not_cancelable - payment_attempt_fully_canceled - payment_cancellation_amount_exceeded - payment_cancellation_in_progress - payment_cancellation_idempotency_conflict - webhook_delivery_not_retryable - price_rate_history_immutable - price_plan_history_immutable - webhook_endpoint_disabled - webhook_endpoint_limit_exceeded - invitation_unavailable - last_owner_required - owner_scopes_required - last_operator_required - api_key_unavailable - upload_size_exceeded - request_type_not_supported - rate_limit_exceeded - internal_server_error - request_timed_out - toss_payments_unavailable errors: type: array description: 틀린 필드 목록. 400 응답에만 실린다. items: $ref: '#/components/schemas/FieldError' message: type: string description: code마다 하나인 한국어 문구. 예고 없이 바뀔 수 있으니 분기에 쓰지 않는다. example: 서버 내부 오류입니다 required: - code - message FieldError: type: object description: 틀린 필드 하나 properties: field: type: string description: 틀린 값을 보낸 자리의 이름. 요청에 쓴 이름과 같다. example: event_type message: type: string description: 이 자리의 값이 거절된 이유. example: 공백일 수 없습니다 securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.