How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Toss Payments Payments API

Confirm, retrieve, and cancel payments.

Toss Payments Payments API is one of 8 APIs that Toss Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 2022-11-16.

Requests are made against a single base URL, https://api.tosspayments.com.

5 operations 5 paths 9 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2022-11-16
Base URL
https://api.tosspayments.com
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Toss Payments Payments API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication. Use your Toss Payments secret key as the username and leave the password empty, then Base64 encode secretKey: for the Authorization…

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 5

Confirm, retrieve, and cancel payments.

POST
/v1/payments/confirm
Confirm a payment
confirmPayment body → 200400401403
POST
/v1/payments/key-in
Key-in (manual card) payment
keyInPayment body → 200400401
GET
/v1/payments/{paymentKey}
Get a payment by paymentKey
getPayment 1 param → 200401404
GET
/v1/payments/orders/{orderId}
Get a payment by orderId
getPaymentByOrderId 1 param → 200401404
POST
/v1/payments/{paymentKey}/cancel
Cancel a payment
cancelPayment 2 params body → 200400401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Payment (18 properties), KeyInPaymentRequest (8 properties), VirtualAccount (7 properties), Card (6 properties). Each schema is shown below with its type and property counts.

Error
object
Standard Toss Payments error body.
2 properties
ConfirmPaymentRequest
object
3 properties 3 required
Payment
object
A Toss Payments Payment object.
18 properties
KeyInPaymentRequest
object
8 properties 6 required
VirtualAccount
object
7 properties
CancelPaymentRequest
object
5 properties 1 required
Cancel
object
5 properties
Card
object
6 properties
RefundReceiveAccount
object
Refund destination account, required for virtual account cancellations.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

toss-payments-payments-api-openapi.yml Raw ↑

Other APIs Toss Payments publishes across the network.

Toss Payments Brandpay API
Toss Payments Billing API
Toss Payments Cash Receipts API
Toss Payments Payouts API
Toss Payments Settlements API
Toss Payments Transactions API
Toss Payments Virtual Accounts API
Where this information came from

This is an independent, third-party profile of Toss Payments Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.