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

Kaltura transaction API

The transaction API from Kaltura — 7 operation(s) for transaction.

Kaltura transaction API is one of 222 APIs that Kaltura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include transaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 7 operations across 7 paths, and defines 7 schemas. It is described by OpenAPI 2.0, at version 3.6.287.20720.

Requests are made against the base URL https://www.kaltura.com/api_v3.

7 operations 7 paths 7 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.6.287.20720
Base URL
https://www.kaltura.com/api_v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kaltura transaction API declares 1 security scheme for authenticating requests. An API key is passed in the body as ks (ks). By default, every request must be authenticated.

  • ks — A Kaltura session ID

Paths & Operations 7

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

transaction 7
POST
/service/transaction/action/downgrade
downgrade specific subscription for a household. entitlements will be updated on the existing subscription end date.
transaction.downgrade 1 param → 200x-Errors
POST
/service/transaction/action/getPurchaseSessionId
Retrieve the purchase session identifier
transaction.getPurchaseSessionId 1 param → 200
POST
/service/transaction/action/purchase
Purchase specific product or subscription for a household. Upon successful charge entitlements to use the requested product or subscription are granted.
transaction.purchase 1 param → 200x-Errors
POST
/service/transaction/action/setWaiver
This method shall set the waiver flag on the user entitlement table and the waiver date field to the current date.
transaction.setWaiver 1 param → 200
POST
/service/transaction/action/updateStatus
Updates a pending purchase transaction state.
transaction.updateStatus 1 param → 200
POST
/service/transaction/action/upgrade
upgrade specific subscription for a household. Upon successful charge entitlements to use the requested product or subscription are granted.
transaction.upgrade 1 param → 200x-Errors
POST
/service/transaction/action/validateReceipt
Verifies PPV/Subscription/Collection client purchase (such as InApp) and entitles the user.
transaction.validateReceipt 1 param → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are KalturaTransaction (6 properties), KalturaPurchase (6 properties), KalturaTransactionStatus (5 properties), KalturaPurchaseBase (3 properties). Each schema is shown below with its type and property counts.

KalturaPurchase
object
6 properties
KalturaExternalReceipt
object
2 properties
KalturaTransaction
object
6 properties
KalturaPurchaseSession
object
1 property
KalturaPurchaseBase
object
3 properties
KalturaTransactionStatus
object
5 properties
OTTRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-transaction-api-openapi.yml Raw ↑

Other APIs Kaltura publishes across the network.

Kaltura accessControl API
Kaltura accessControlProfile API
Kaltura adminUser API
Kaltura analytics API
Kaltura annotation API
Kaltura announcement API
Kaltura appToken API
Kaltura aspera API
Kaltura asset API
Kaltura assetComment API
Kaltura assetFile API
Kaltura assetHistory API