Skip to main content
Glama
portone-io

PortOne MCP Server

Official
by portone-io
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

포트원 결제 내역 검색

getPaymentsByFilter

Search and retrieve payment records by applying filters like date range, payment method, status, and more from PortOne's server.

Instructions

포트원 서버에서 주어진 조건을 모두 만족하는 결제 내역을 검색합니다.

Note: 소문자 imp_ 혹은 imps_ 로 시작하는 거래번호는 고객사 거래번호가 아닌 V1 포트원 거래번호(imp_uid)일 가능성이 있습니다. 날짜 및 시간 정보 입출력 시에는 반드시 타임존을 명시합니다.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNopaymentId / txId / imp_uid / merchant_uid 검색 필드
pgNo포함할 PG사 모듈 목록
toYes조회 종료 시간 (ISO 8601 형식)
fromYes조회 시작 시간 (ISO 8601 형식)
pageYes검색할 페이지 위치입니다. 0부터 시작합니다.
orderNo결제건의 주문명
typesNo일반 / 정기결제 여부
fieldsYes검색 결과로 받을 필드 목록입니다.
methodNo포함할 결제수단 목록
statusNo포함할 결제 상태 목록
channelNo실연동 및 테스트 포함 목록
webhookNo포함할 결제건의 웹훅 상태 목록
currencyNo포함할 통화 목록, 세 자리 통화 코드
pageSizeNo한 페이지에 반환할 결과의 수
timeTypeYesfrom, to로 제약할 결제건의 기준 시각 조건

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
countYes페이지와 관계없이 조건에 맞는 결제 총 개수
itemsYes조회된 결제 목록

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.20.0
    • changedInput schema / properties / fields / items / enum
      Previous value: -[
-  "amount",
-  "billKey",
-  "channel",
-  "group",
-  "currency",
-  "customer",
-  "history",
-  "webhook",
-  "order",
-  "txId",
-  "storeId",
-  "schedule",
-  "requestAt",
-  "paymentId",
-  "method",
-  "amount.total",
-  "amount.taxFree",
-  "amount.vat",
-  "amount.supply",
-  "amount.dc",
-  "amount.cancel",
-  "amount.taxFreeCancel",
-  "amount.cardDc",
-  "amount.easyDc",
-  "amount.promotionDc",
-  "amount.balance",
-  "channel.type",
-  "channel.id",
-  "channel.key",
-  "channel.name",
-  "channel.pg",
-  "channel.mid",
-  "group.id",
-  "group.name",
-  "group.test",
-  "history.status",
-  "history.changedAt",
-  "history.paid",
-  "history.cancel"
-]New value: +[
+  "amount",
+  "billKey",
+  "channel",
+  "group",
+  "currency",
+  "customer",
+  "history",
+  "webhook",
+  "order",
+  "txId",
+  "storeId",
+  "schedule",
+  "requestAt",
+  "paymentId",
+  "method",
+  "failure",
+  "cancellation",
+  "amount.total",
+  "amount.taxFree",
+  "amount.vat",
+  "amount.supply",
+  "amount.dc",
+  "amount.cancel",
+  "amount.taxFreeCancel",
+  "amount.cardDc",
+  "amount.easyDc",
+  "amount.promotionDc",
+  "amount.balance",
+  "channel.type",
+  "channel.id",
+  "channel.key",
+  "channel.name",
+  "channel.pg",
+  "channel.mid",
+  "group.id",
+  "group.name",
+  "group.test",
+  "history.status",
+  "history.changedAt",
+  "history.paid",
+  "history.cancel",
+  "failure.reason",
+  "failure.pgCode",
+  "failure.pgMessage",
+  "cancellation.reason",
+  "cancellation.amount",
+  "cancellation.requestAt",
+  "cancellation.cancelAt",
+  "cancellation.trigger"
+]
    • addedOutput schema / properties / items / items / properties / cancellation
      Added value: +{
+  "description": "결제 취소 내역. 전체 / 부분 취소된 결제건에만 존재함.",
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "amount": {
+        "description": "취소 금액",
+        "type": "number"
+      },
+      "cancelAt": {
+        "description": "취소 완료 시각",
+        "type": "string"
+      },
+      "reason": {
+        "description": "결제 취소 사유",
+        "type": "string"
+      },
+      "requestAt": {
+        "description": "취소 요청 시각",
+        "type": "string"
+      },
+      "trigger": {
+        "description": "취소 요청 주체 (CONSOLE, API, PORTONE_ADMIN, CHARGEBACK)",
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  "type": "array"
+}
    • addedOutput schema / properties / items / items / properties / failure
      Added value: +{
+  "additionalProperties": false,
+  "description": "결제 실패 정보. 실패한 결제건에만 존재함.",
+  "properties": {
+    "pgCode": {
+      "description": "PG사 실패 코드",
+      "type": "string"
+    },
+    "pgMessage": {
+      "description": "PG사 실패 메시지",
+      "type": "string"
+    },
+    "reason": {
+      "description": "결제 실패 사유",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  2. Addedv0.15.0

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description must disclose behavioral traits itself. It does clarify AND semantics ('모두 만족하는') and includes two useful cautions about imp_uid identification and timezone handling. However, it does not discuss pagination behavior, rate limits, or error conditions, leaving some gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact and well-structured: one main sentence followed by two bullet-point notes. Every sentence provides useful information, with no filler. It is front-loaded with the core purpose and followed by essential caveats.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Although the tool has 15 parameters and an output schema, the description is brief. It covers AND semantics and two caveats, but does not mention pagination defaults, how filters combine across multiple parameters, or any prerequisites. The output schema fills return-value details, but overall context feels slightly under-specified for such a complex tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds meaningful value by explaining that IDs starting with imp_/imps_ may be V1 imp_uid values, which clarifies the 'id' parameter. The timezone note directly informs the 'from' and 'to' parameters, enriching the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it searches payment history on the PortOne server that satisfies all given conditions. The verb '검색합니다' (search) and resource '결제 내역' (payment history) are specific and distinguish it from sibling settlement or reconciliation search tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no explicit guidance on when to use this tool versus alternatives such as getReconciliationsByFilter or getSettlementSummaries. The notes about imp_uid and timezone are cautions, not usage directives. No exclusions or alternative recommendations are given.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools