find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/xdata-kr:xdata-kr-billing-standard-checkout-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: XBOSS Billing Standard Checkout API
  description: '통합 REST API 서버 (홈택스 등). Human API guide: https://developer.xdata.kr · OpenAPI Reference: /docs'
  version: 2.0.0
security:
- basicClientCredential: []
- mcpOAuth2: []
tags:
- name: Billing Standard Checkout
paths:
  /v1/subscriptions/payup-standard/prepare:
    post:
      tags:
      - Billing Standard Checkout
      summary: Prepare Checkout
      description: 서버가 금액을 확정하고 서명한다 (DB 쓰기 0건).
      operationId: prepare_checkout_v1_subscriptions_payup_standard_prepare_post
      parameters:
      - name: env_scope
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: Env Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Env-Scope
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: X-Env-Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StandardCheckoutPrepareRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardCheckoutPrepareResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/subscriptions/payup-standard/approve:
    post:
      tags:
      - Billing Standard Checkout
      summary: Approve Checkout
      description: 결제창 인증이 끝난 거래를 승인한다 (T1 COMMIT 후 승인 전송).
      operationId: approve_checkout_v1_subscriptions_payup_standard_approve_post
      parameters:
      - name: env_scope
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: Env Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 128
          title: Idempotency-Key
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Env-Scope
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: X-Env-Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StandardCheckoutApproveRequest'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardCheckoutApproveResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/subscriptions/payup-standard/status:
    post:
      tags:
      - Billing Standard Checkout
      summary: Read Checkout Status
      description: '우리 DB 에 적힌 결제 상태 조회 (결제대행사 호출 0건).


        POST 인 이유: 입력에 체크아웃 토큰이 들어가고, 토큰을 URL 에 실으면 접근 로그·리퍼러에

        남는다.'
      operationId: read_checkout_status_v1_subscriptions_payup_standard_status_post
      parameters:
      - name: env_scope
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: Env Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Env-Scope
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: X-Env-Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StandardCheckoutApproveRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardCheckoutStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    StandardCheckoutPrepareRequest:
      properties:
        organization_id:
          type: integer
          minimum: 1.0
          title: Organization Id
          description: 결제 주체 조직 PK.
        plan_id:
          type: integer
          minimum: 1.0
          title: Plan Id
          description: plans.id.
        addon_product_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Addon Product Ids
          description: 함께 구매할 추가 상품 api_products.id 목록.
        payer_name:
          type: string
          maxLength: 50
          minLength: 1
          title: Payer Name
          description: 결제창에 표시할 결제자명.
        subscription_id:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Subscription Id
          description: 대상 구독. 추가 상품을 더하거나(기본) 실패한 결제를 다시 시도할 때 필수.
        mode:
          anyOf:
          - type: string
            enum:
            - subscription
            - addon
            - retry
          - type: 'null'
          title: Mode
          description: 결제 갈래를 명시한다. 생략하면 subscription_id 유무로 정한다. 'retry' 는 결제가 실패한 구독의 미결제 금액을 다시 내는 갈래.
      additionalProperties: false
      type: object
      required:
      - organization_id
      - plan_id
      - payer_name
      title: StandardCheckoutPrepareRequest
      description: '결제창을 열기 전에 서버가 값을 확정한다 (금액을 클라이언트가 정하지 못하게).


        갈래를 요청 DTO 여럿으로 나누지 않는 이유: 결제창을 여는 절차와 승인 절차가 갈래마다 완전히

        같고, 다른 것은 금액을 어디서 계산하느냐 하나뿐이다.


        `mode` 를 주면 그 갈래다. 생략하면 `subscription_id` 유무로 정한다(없으면 신규 구독, 있으면

        추가 상품) — 재시도만은 생략으로 도달할 수 없다. 추측으로 열리면 안 되는 갈래이기 때문이다

        (`CheckoutMode` 참고).'
    StandardCheckoutApproveRequest:
      properties:
        transaction_id:
          type: string
          maxLength: 20
          minLength: 1
          title: Transaction Id
        checkout_token:
          type: string
          maxLength: 4096
          minLength: 1
          title: Checkout Token
      additionalProperties: false
      type: object
      required:
      - transaction_id
      - checkout_token
      title: StandardCheckoutApproveRequest
      description: '결제창 인증이 끝난 뒤 승인/조회에 쓰는 입력 (두 라우트 공용).


        `transaction_id` 상한 20 은 결제대행사 규격값이다. 계약과 다른 길이는 **전송 전에** 거부한다.'
    StandardCheckoutApproveResponse:
      properties:
        organization_id:
          type: integer
          minimum: 1.0
          title: Organization Id
        subscription_id:
          type: integer
          minimum: 1.0
          title: Subscription Id
        plan_id:
          type: integer
          minimum: 1.0
          title: Plan Id
        env_scope:
          type: string
          enum:
          - sandbox
          - real_test
          - production
          title: Env Scope
        invoice_id:
          type: integer
          minimum: 1.0
          title: Invoice Id
        payment_id:
          type: integer
          minimum: 1.0
          title: Payment Id
        payment_status:
          type: string
          enum:
          - SUCCEEDED
          - PENDING
          - FAILED
          title: Payment Status
          description: 이번 승인 요청의 결과. PENDING = 확인 중(미확정 포함).
      additionalProperties: false
      type: object
      required:
      - organization_id
      - subscription_id
      - plan_id
      - env_scope
      - invoice_id
      - payment_id
      - payment_status
      title: StandardCheckoutApproveResponse
      description: 승인 요청 결과 스냅샷. 신규 구독 갈래와 추가 상품 갈래가 같은 모양을 쓴다.
    StandardCheckoutPrepareResponse:
      properties:
        merchant_id:
          type: string
          title: Merchant Id
          description: 결제창이 요구하는 가맹점 식별자(시크릿 아님).
        sdk_url:
          type: string
          title: Sdk Url
          description: 결제창 스크립트 주소.
        item_name:
          type: string
          maxLength: 128
          title: Item Name
          description: 결제창에 표시할 상품명.
        amount:
          type: integer
          minimum: 1.0
          title: Amount
          description: 결제 금액 (minor unit).
        currency:
          type: string
          const: KRW
          title: Currency
          description: 통화 코드.
        order_number:
          type: string
          maxLength: 128
          title: Order Number
          description: 우리 주문번호.
        checkout_token:
          type: string
          title: Checkout Token
          description: 서버 서명 체크아웃 토큰.
        return_url:
          type: string
          title: Return Url
          description: 모바일 결제창 복귀 주소.
      additionalProperties: false
      type: object
      required:
      - merchant_id
      - sdk_url
      - item_name
      - amount
      - currency
      - order_number
      - checkout_token
      - return_url
      title: StandardCheckoutPrepareResponse
      description: '결제창을 띄우는 데 필요한 값 + 서버가 서명한 체크아웃 토큰.


        `checkout_token` 은 승인 단계에서 **서버가 정한 금액·상품** 을 되찾는 열쇠다. 금액을 응답에도

        함께 싣는 이유는 고객에게 보여 주기 위해서이고, 승인 때 믿는 값은 토큰 안의 것뿐이다.'
    StandardCheckoutStatusResponse:
      properties:
        payment_id:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Payment Id
        payment_status:
          anyOf:
          - type: string
            enum:
            - INITIATED
            - PENDING
            - SUCCEEDED
            - FAILED
            - CANCELED
            - EXPIRED
          - type: 'null'
          title: Payment Status
        retry_available:
          type: boolean
          title: Retry Available
          description: 지금 이 구독의 결제를 다시 시도할 수 있는지. false 면 결과를 확인하는 중이거나 이미 처리가 끝난 결제다.
          default: false
      additionalProperties: false
      type: object
      title: StandardCheckoutStatusResponse
      description: '우리 DB 에 적힌 결제 상태 조회 (외부 통신 0건).


        결제대행사에 거래조회 API 가 없어서 이 조회는 **우리가 아는 것만** 돌려준다.

        모르는 거래는 빈 응답이다 — 남의 거래번호를 넣어 본 사람에게 "그런 거래가 있다" 는 사실조차

        알려 주지 않는다.


        `retry_available` 이 여기 있는 이유: 결제가 실패한 고객에게 다음 행동을 알려

        주는 자리가 이 응답이다. 화면이 `payment_status` 로 추론하면 안 된다 — **실패한 결제라고 해서

        항상 다시 시도할 수 있는 것이 아니다**(결과를 모르는 승인이 남아 있으면 재시도는 이중 청구가

        된다). 그래서 버튼을 여는 판정과 실제로 문을 여는 판정을 **같은 함수 하나**로 묶는다.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    basicClientCredential:
      type: http
      scheme: basic
      description: 'Console-issued client credential. Send `Authorization: Basic base64(client_id:client_secret)`.'
    mcpOAuth2:
      type: oauth2
      description: For MCP clients. OAuth 2.0 authorization code flow with PKCE (S256) for public clients. The client_id is the HTTPS URL of an OAuth Client ID Metadata Document that XBOSS has allow-listed; dynamic client registration is not supported.
      flows:
        authorizationCode:
          authorizationUrl: https://api.xdata.kr/oauth/authorize
          tokenUrl: https://api.xdata.kr/oauth/token
          scopes: {}