---
title: "List Payment Methods"
method: GET
path: "/v1/payment-methods"
tags: ["Billing Payment Methods"]
---

# List Payment Methods

`GET /v1/payment-methods`

## 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/payment-methods`
- 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`)

결제수단 목록 조회.

## Query parameters

- `query` PaymentMethodListQuery, required: 결제수단 목록 조회 쿼리. 자동 필터(라우트/서비스 강제 적용, 쿼리 미노출): - `organization_id = principal.organization_id` - `env_scope = X-Env-Scope` - `status != 'REVOKED'` (REVOKED는 명시적 옵션으로만 포함)
  - `include_revoked` boolean: REVOKED 결제수단 포함 여부. 기본 False (활성만 노출).
  - `limit` integer: 페이지 크기.
  - `cursor` string, nullable: 이전 응답의 next_cursor.
- `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

- `Authorization` string, 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 `200`

Successful Response

- PageEnvelopePaymentMethodResponse
  - `items` PaymentMethodResponse[]: Page result items. Empty list allowed.
    - `payment_method_id` integer, required: payment_methods.id (BIGSERIAL PK).
    - `organization_id` integer, required: 소유 조직 PK.
    - `method_kind` 'CARD' | 'VBANK' | 'MOBILE' | 'SIMPLE' | 'PAYPAL' | 'OTHER', required: 결제수단 종류.
    - `pg_provider` 'portone' | 'toss' | 'payup' | 'offline', required: PG 사업자.
    - `label` string, nullable: 사용자 표시 라벨.
    - `last4` string, nullable: 마스킹 마지막 자리.
    - `issuer_name` string, nullable: 발급사 명칭.
    - `status` 'ACTIVE' | 'REVOKED' | 'EXPIRED', required: 결제수단 상태.
    - `env_scope` 'sandbox' | 'real_test' | 'production', required: 환경 스코프.
    - `expires_at` string, date-time, nullable: 만료 시각 (aware datetime, naive 입력 시 422).
    - `created_at` string, date-time, required: 등록 시각 (aware datetime, naive 입력 시 422).
  - `next_cursor` string, nullable: Opaque cursor for next page, or null on last page.
  - `has_more` boolean: Whether another page exists. False when next_cursor is null.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/xdata/apis/xboss-api.md) · [All operations](https://skmtc.dev/xdata/apis/xboss-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xdata/apis/xboss-api/revisions/816de78950db?raw)