Billing Refunds

Get Refund

환불 단건 조회.

get/v1/refunds/{refund_id}

Request

  • Base URL: https://api.xdata.kr (the document declares no server; this is the origin it was published from)
  • URL: https://api.xdata.kr/v1/refunds/{refund_id}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://api.xdata.kr/oauth/authorize, token URL https://api.xdata.kr/oauth/token)

Path parameters

refund_idinteger required

Query parameters

env_scope'production' | 'real_test' | 'sandbox' nullable

환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.

Headers

Authorizationstring nullable
X-Env-Scope'production' | 'real_test' | 'sandbox' nullable

환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.

Response

Successful Response

refund_idinteger required

refunds.id.

organization_idinteger required

소유 조직 PK.

payment_idinteger required

원 결제 ID.

invoice_idinteger nullable

연결된 인보이스 ID. NULL 허용.

env_scope'sandbox' | 'real_test' | 'production' required

환경 스코프.

pg_provider'portone' | 'toss' | 'payup' | 'offline' required

PG 사업자.

provider_refund_idstring nullable

PG 발급 환불 식별자. PG 비동기 처리 중에는 NULL일 수 있다. BFF/관리자/대사 입력용. 외부 사용자 UI 표시 권장 X.

amount_minorinteger required

환불 금액 (minor unit). 0 과 음수는 받지 않는다.

currency'KRW' required

통화 코드. v1=KRW.

status'PENDING' | 'SUCCEEDED' | 'FAILED' | 'CANCELED' required

환불 상태 (4값 enum).

reason'USER_REQUEST' | 'OPS_DISPUTE_RESOLUTION' | 'DUPLICATE_PAYMENT' | 'PAYMENT_FAILED_REVERSAL' | 'FRAUDULENT_PAYMENT' | 'OTHER' nullable

환불 사유 enum. SCHEMA 자유 텍스트를 enum으로 정규화 노출 (자유 텍스트 원문은 audit_logs.billing.refund.transition.payload.reason_raw로 보존).

requested_atstring date-time required

환불 요청 시각 (aware datetime, naive 입력 시 422).

confirmed_atstring date-time nullable

환불 확정 시각 (SUCCEEDED 진입 시 채워짐).

created_atstring date-time required

환불 행 생성 시각 (aware datetime, naive 입력 시 422).

Changes

No recorded changes to this operation across all 1 revision of this API.