---
title: "Payments API"
url: "https://kongair.terwilligar.com/apis/payments-api/versions/f6b27cfe-b147-4a9e-af56-9802bfc4bc86"
---

# Payments API

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Payments API","description":"Example Payments API used for testing Konnect Dev Portal V3","version":"1.0.1"},"servers":[{"url":"https://api.example.com"}],"paths":{"/payments":{"get":{"summary":"List payments","operationId":"listPayments","responses":{"200":{"description":"A list of payments","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}}}}}}}}},"post":{"summary":"Create a payment","operationId":"createPayment","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPayment"}}}},"responses":{"201":{"description":"Payment created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}}}}},"/payments/{paymentId}":{"get":{"summary":"Get payment by ID","operationId":"getPayment","parameters":[{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Payment details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Payment":{"type":"object","required":["id","amount","currency","status"],"properties":{"id":{"type":"string","example":"pay_12345"},"amount":{"type":"number","format":"float","example":49.99},"currency":{"type":"string","example":"USD"},"status":{"type":"string","enum":["pending","completed","failed"]},"created_at":{"type":"string","format":"date-time"}}},"NewPayment":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","format":"float","example":49.99},"currency":{"type":"string","example":"USD"}}},"Error":{"type":"object","properties":{"message":{"type":"string","example":"Resource not found"}}}}}}
```