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

Kriya Orders API

The Orders API from Kriya — 7 operation(s) for orders.

Kriya Orders API is one of 6 APIs that Kriya publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 8 operations across 7 paths, and defines 27 schemas. It is described by OpenAPI 3.0.1.

Requests are made against 2 base URLs: https://api.kriya.dev/onboarding/, https://api.kriya.co/onboarding/.

8 operations 7 paths 27 schemas 2 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
Base URL
https://api.kriya.co/payments/
Contact
Resource Areas
1

Paths & Operations 8

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

Orders 8
POST
/scenario/orders/{merchantOrderId}/transition
Transitions an order status
TransitionOrderStatusScenario 1 param body → 401400404200
POST
/orders
Initiates a new order transaction
CreateOrder body → 201401400404
POST
/orders/many
Searches orders by specific filters
OrdersMany body → 200401400404500
GET
/orders/{merchantOrderId}/session/{sessionId}
Get current session state
GetOrderMfaSession 2 params → 401400404200
GET
/orders/{merchantOrderId}
Retrieves order details by merchant ID
GetOrder 1 param → 200401400404500
PUT
/orders/{merchantOrderId}
Modifies order details
UpdateOrder 1 param body → 200401400404
POST
/orders/{merchantOrderId}/transition
Transitions an order status
TransitionOrderStatus 1 param body → 401400404200
POST
/orders/{merchantOrderId}/deliveryConfirmation
Uploads delivery confirmation evidence for an order
UploadDeliveryConfirmation 1 param → 200401400404

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are createOrderRequest (12 properties), getOrderResponse (12 properties), baseOrder (11 properties), updateOrderRequest (9 properties). Each schema is shown below with its type and property counts.

mfaRecipientDestination
object
2 properties
createOrderResponse
object
4 properties
repaymentMonetaryValue
object
Repayment amount and currency for the order
2 properties 2 required
uploadDeliveryConfirmationResponse
object
2 properties
paymentJourney
object
Payment journey details for if you're choosing to use our hosted web app.
5 properties 2 required
updateOrderResponse
object
5 properties
uploadedDeliveryConfirmationFile
object
2 properties
transitionOrderStatusRequest
object
2 properties
mfaRecipient
object
4 properties
paymentData
object
Payment Details of the supplier providing the goods.
2 properties 1 required
supplierCompanyDetails
object
The company providing the goods to the buyer. This is only required if the partner themselves are not fulfilling the order. Once a supplier has been set, it ca…
5 properties
repaymentData
object
The repayment details if the order is transitioned to repaid status
2 properties 2 required
paymentOptions
object
6 properties
user
object
Details of the user creating the order.
4 properties
directorDetails
object
Company director details.
6 properties
updateOrderRequest
object
9 properties
problemDetails
object
5 properties
getManyOrdersRequest
object
2 properties
orderPaymentInfo
object
The details of the payments, including the type of payment terms and the gross amount.
4 properties
createOrderRequest
object
12 properties 1 required
buyerCompanyDetails
object
The company making a purchase on the partner platform.
8 properties
getManyOrdersResponse
object
3 properties
baseOrder
object
11 properties
address
object
Director residential address.
6 properties
buyerDetails
object
The company making a purchase on the partner platform.
7 properties
getOrderMfaSessionResponse
object
4 properties
getOrderResponse
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kriya-orders-api-openapi.yml Raw ↑

Other APIs Kriya publishes across the network.

Kriya Buyers API
Kriya Onboarding API API
Kriya OnboardingJourney API
Kriya Payments API
Kriya Scenario API