canonical: https://jentic.com/apis/tosspayments.com/tosspayments

# Toss Payments API

Toss Payments (토스페이먼츠) is a major Korean payment gateway. The API supports payment confirmation, payment inquiry, and payment cancellation. Authentication uses Basic auth with the secret key. Payments are initiated via the client SDK and confirmed server-side. The API exposes 4 endpoints secured with basic authentication.

## For AI agents

Programmatically confirm payment (결제 승인), query payment by paymentkey (paymentkey로 결제 조회). Covers 4 operations with basic authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Confirm Payment (결제 승인)
- Query Payment by paymentKey (paymentKey로 결제 조회)
- Cancel Payment (결제 취소)
- Query and filter Toss Payments API records by parameters
- Monitor Toss Payments API operational status and events

## Use cases

### Payments Operations

Use the Toss Payments API to perform payments operations programmatically. The API provides 4 endpoints covering core functionality including confirm payment (결제 승인), query payment by paymentkey (paymentkey로 결제 조회), query payment by orderid (orderid로 결제 조회).

Example prompt: Call POST `/v1/payments/confirm` to confirm payment (결제 승인)

### Automated Payments Management

Automate payments operations by combining multiple Toss Payments API endpoints. Agents can query payment by paymentkey (paymentkey로 결제 조회) and then query payment by orderid (orderid로 결제 조회) in a single workflow.

Example prompt: Call GET `/v1/payments/{paymentKey}` to query payment by paymentkey (paymentkey로 결제 조회), then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Toss Payments API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'confirm payment (결제 승인)', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/payments/confirm` | Confirm Payment (결제 승인) |
| GET | `/v1/payments/{paymentKey}` | Query Payment by paymentKey (paymentKey로 결제 조회) |
| GET | `/v1/payments/orders/{orderId}` | Query Payment by orderId (orderId로 결제 조회) |
| POST | `/v1/payments/{paymentKey}/cancel` | Cancel Payment (결제 취소) |

## Key resources

- **Payments** — Payment confirmation, query, and cancellation

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 41 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 50 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/tosspayments.com/tosspayments/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Toss Payments API by hand means encoding its HTTP basic auth from your secret key, tracking the api.tosspayments.com host, and coding your own request and idempotency handling for payment flows. Through Jentic you install once, import the Toss Payments API from the API Directory, store the basic credential once, and your agent calls it.
- **Permission scoping:** Toss Payments puts the payment key in the URL path (`/v1/payments/{paymentKey}`), so a rule can pin your agent to the operations it needs on a payment, such as confirming or reading it. You choose which operations it may call, so cancelling a payment is not included unless you add it.
- **Credential handling:** Your Toss Payments secret key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'confirm a payment' or 'look up a payment by order id', and Jentic returns the matching Toss Payments operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Toss Payments API use?

The Toss Payments API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I confirm payment (결제 승인) with the Toss Payments API?

Yes. Use the POST `/v1/payments/confirm` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Toss Payments API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I confirm payment (결제 승인) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'confirm payment (결제 승인)'. Jentic returns the matching Toss Payments API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Toss Payments API have?

The Toss Payments API exposes 4 endpoints covering payments operations.

### Can I limit what my agent is allowed to do with the Toss Payments API?

Yes. Jentic One is self-hosted by you, so your own rules decide which Toss Payments operations and credentials your agent may use. You can pin the agent to just the calls it needs, such as confirming a payment with POST `/v1/payments/confirm` or reading one with GET `/v1/payments/{paymentKey}`, while leaving cancellation via POST `/v1/payments/{paymentKey}/cancel` off the allowed list unless you add it. Because the payment key sits in the URL path, the operator controls exactly which operations run against a given payment.