Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

KOMOJU Payments API

Create, capture, refund, cancel, and query payments across all payment methods.

KOMOJU Payments API is one of 8 APIs that KOMOJU 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 8 operations across 6 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

8 operations 6 paths 5 schemas 2 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://komoju.com/api/v1
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

KOMOJU 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 KOMOJU API key as the username and leave the password empty (for example curl -u secretkey: ...). Secret keys grant full ac…

Paths & Operations 8

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

Payments 8

Create, capture, refund, cancel, and query payments across all payment methods.

GET
/payments
List payments
listPayments 4 params → 200401
POST
/payments
Create a payment
createPayment body → 200401422
GET
/payments/{id}
Show a payment
showPayment 1 param → 200401404
PATCH
/payments/{id}
Update a payment
updatePayment 1 param body → 200401404
POST
/payments/{id}/capture
Capture a payment
capturePayment 1 param → 200401404
POST
/payments/{id}/refund
Refund a payment
refundPayment 1 param body → 200401404
POST
/payments/{id}/cancel
Cancel a payment
cancelPayment 1 param → 200401404
POST
/payments/{id}/refund_request
Create a refund request
createRefundRequest 1 param body → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Payment (15 properties), PaymentCreateInput (8 properties), PaymentList (4 properties), Error (1 property). Each schema is shown below with its type and property counts.

PaymentCreateInput
object
8 properties 2 required
PaymentDetails
Payment method details. Either an object whose type selects the method (creditcard, konbini, banktransfer, payeasy, paypay, merpay, aupay, rakutenpay, linepay,…
Payment
object
15 properties
PaymentList
object
4 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

komoju-payments-api-openapi.yml Raw ↑

Other APIs KOMOJU publishes across the network.

KOMOJU Barcodes API
KOMOJU Customers API
KOMOJU Events API
KOMOJU Payment Methods API
KOMOJU Sessions API
KOMOJU Subscriptions API
KOMOJU Tokens API