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 householdPaymentGateway API

The householdPaymentGateway API from Kaltura — 8 operation(s) for householdpaymentgateway.

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

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

This API exposes 8 operations across 8 paths, and defines 6 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.

8 operations 8 paths 6 schemas 8 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 householdPaymentGateway 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 8

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

householdPaymentGateway 8
POST
/service/householdpaymentgateway/action/disable
Disable payment-gateway on the household
householdPaymentGateway.disable 1 param → 200x-Errors
POST
/service/householdpaymentgateway/action/enable
Enable a payment-gateway provider for the household.
householdPaymentGateway.enable 1 param → 200x-Errors
POST
/service/householdpaymentgateway/action/getChargeID
Get a household’s billing account identifier (charge ID) for a given payment gateway
householdPaymentGateway.getChargeID 1 param → 200x-Errors
POST
/service/householdpaymentgateway/action/invoke
Gets the Payment Gateway Configuration for the payment gateway identifier given
householdPaymentGateway.invoke 1 param → 200x-Errors
POST
/service/householdpaymentgateway/action/list
Get a list of all configured Payment Gateways providers available for the account. For each payment is provided with the household associated payment methods.
householdPaymentGateway.list 1 param → 200x-Errors
POST
/service/householdpaymentgateway/action/resume
Resumes all the entitlements of the given payment gateway
householdPaymentGateway.resume 1 param → 200x-Errors
POST
/service/householdpaymentgateway/action/setChargeID
Set user billing account identifier (charge ID), for a specific household and a specific payment gateway
householdPaymentGateway.setChargeID 1 param → 200x-Errors
POST
/service/householdpaymentgateway/action/suspend
Suspends all the entitlements of the given payment gateway
householdPaymentGateway.suspend 1 param → 200x-Errors

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are KalturaHouseholdPaymentGateway (4 properties), KalturaKeyValue (2 properties), OTTRequest (2 properties), KalturaListResponse (1 property). Each schema is shown below with its type and property counts.

OTTRequest
object
2 properties
KalturaHouseholdPaymentGatewayListResponse
object
List of household payment gateways.
1 property
KalturaKeyValue
object
2 properties
KalturaHouseholdPaymentGateway
object
4 properties
KalturaPaymentGatewayConfiguration
object
1 property
KalturaListResponse
object
Base list wrapper
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-householdpaymentgateway-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