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

Komerce Payments API

The Payments API from Komerce — 4 operation(s) for payments.

Komerce Payments API is one of 7 APIs that Komerce 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, an API reference, authentication docs, and pricing.

This API exposes 4 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against 2 base URLs: https://api.collaborator.komerce.id/user, https://api-sandbox.collaborator.komerce.id/user.

4 operations 4 paths 6 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://rajaongkir.komerce.id/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Komerce Payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Payment API key from the Collaborator dashboard — the same key used for Komerce Shipping (RajaOngkir). Sandbox keys use the sandbox prefix, production keys the…

Paths & Operations 4

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

Payments 4
GET
/api/v1/user/methods
Get payment methods
getPaymentMethods → 200401
POST
/api/v1/user/payment/create
Create a payment transaction
createPayment body → 200400401
GET
/api/v1/user/payment/status/{payment_id}
Get payment status
getPaymentStatus 1 param → 200401404
POST
/api/v1/user/payment/cancel
Cancel a Virtual Account payment
cancelPayment body → 200400401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CreatePaymentRequest (9 properties), PaymentMethod (7 properties), Meta (3 properties), PaymentCustomer (3 properties). Each schema is shown below with its type and property counts.

PaymentItem
object
3 properties 3 required
PaymentCustomer
object
3 properties 3 required
PaymentMethodList
object
2 properties
CreatePaymentRequest
object
9 properties 6 required
PaymentMethod
object
7 properties
Meta
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

komerce-payments-api-openapi.yml Raw ↑

Other APIs Komerce publishes across the network.

Komerce Cost API
Komerce Destinations API
Komerce Orders API
Komerce Pickup API
Komerce QRIS API
Komerce Tracking API