API 레퍼런스
로그인
본문으로 건너뛰기

충전 주문 조회

GET/v1/organizations/{org_id}/topups/{order_id}

충전 주문 하나를 돌려줍니다, 결제창에서 돌아온 뒤 상태를 확인할 때 씁니다

콘솔 세션 전용입니다, 조직 역할 owner, admin만 부를 수 있고 API 키로 부르면 403 console_only입니다

Headers

  • Cookie: string
    콘솔 로그인 세션 쿠키, 콘솔 전용 엔드포인트라 API 키로 부르면 403 console_only입니다

Path Parameters

  • org_id: string
    조직 ID
    형식 ^org_[A-Za-z0-9]+$
  • order_id: string
    충전 주문 ID
    형식 ^[A-Za-z0-9_-]{6,64}$

Returns

200 application/json

  • Topup: object
    • order_id: string
      주문 ID, PortOne paymentId로 그대로 씁니다
      형식 ^[A-Za-z0-9_-]{6,64}$
    • organization_id: optional string
      조직 ID
    • status: "pending" or "confirming" or "paid" or "failed" or "expired" or "cancelled"
      주문 상태
    • usd: integer
      충전 USD
    • credit_micro_usd: integer
      적립될 크레딧(µUSD)
      최소 0
    • credit_usd: string
      같은 금액의 USD 문자열(센트, 소수 2자리)
      형식 ^-?[0-9]+\.[0-9]{2}$
    • amount_krw: integer
      결제 원화, ceil(usd × 고정 환율), 부가세 포함
    • supply_krw: optional integer
      공급가액
    • vat_krw: integer
      부가세
    • fx_day: string
      환율 기준일
    • fixed_krw_per_usd: string
      주문에 고정된 환율
    • payment_id: optional string or null
      PortOne paymentId
    • method: optional string or null
      결제 수단
    • paid_at: optional string or null
      결제 시각
    • receipt_url: optional string or null
      영수증 URL
    • cancelled_krw: optional integer
      취소된 원화(철회)
    • withdrawable_until: optional string or null
      청약철회 기한, 결제 시각 + 7일
    • failure_code: optional string or null
      실패 코드
    • created_at: string
      만든 시각
      RFC 3339 UTC 시각
    • expires_at: optional string
      대기 주문 만료 시각, 만든 뒤 60분
      RFC 3339 UTC 시각

오류

  • invalid_request: HTTP 400
    본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
  • session_required: HTTP 401
    콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
  • console_only: HTTP 403
    콘솔 세션 전용 엔드포인트입니다, API 키로는 결제, 키, 멤버 관리를 할 수 없습니다
  • insufficient_permission: HTTP 403
    역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
  • not_found: HTTP 404
    자원이 없거나 이 호출자에게 보이지 않습니다
  • rate_limited: HTTP 429, 다시 시도 가능
    이 키 또는 조직의 요청이 너무 많습니다, retry_after_s만큼 기다리세요
  • internal_error: HTTP 500, 다시 시도 가능
    예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다

다음 단계