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

CAMARA Project Two Step Payment API

Operations to manage Two Step Payment procedure

CAMARA Project Two Step Payment API is one of 30 APIs that CAMARA Project publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, {apiRoot}/call-forwarding-signal/vwip.

4 operations 4 paths 18 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
wip
Server
{apiRoot}/call-forwarding-signal/vwip
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

CAMARA Project Two Step Payment API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration.

  • openId — to support Consent Management

Paths & Operations 4

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

Two Step Payment 4

Operations to manage Two Step Payment procedure

POST
/payments/prepare
Prepare (reserve) a payment
preparePayment 1 param body → 201400401403404409422429
POST
/payments/{paymentId}/validate
Validate a payment
validatePayment 2 params body → 204400401403404409429
POST
/payments/{paymentId}/confirm
Confirm a payment
confirmPayment 2 params body → 202400401403404409422429
POST
/payments/{paymentId}/cancel
Cancel a payment
cancelPayment 2 params body → 202400401403404409422429

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ChargingMetaData (7 properties), CloudEvent (7 properties), PaymentItem (6 properties), AmountReservationTransactionForReserve (6 properties). Each schema is shown below with its type and property counts.

PaymentAmountForReserve
object
3 properties 1 required
BodyAmountReservationTransactionForReserve
object
6 properties 4 required
CloudEvent
object
The notification format
7 properties 5 required
AmountReservationTransactionForReserve
object
6 properties 3 required
ChargingInformation
object
5 properties 3 required
AmountReservationTransactionForReserveInput
object
4 properties 2 required
ChargingMetaData
object
7 properties
XCorrelator
string
PhoneNumber
object
1 property
ValidationInfo
object
1 property 1 required
Source
string
Identifies the context in which an event happened - be a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-w…
ErrorInfo
object
3 properties 3 required
SinkCredential
object
1 property 1 required
ValidatePayment
object
2 properties 2 required
DateTime
string
Timestamp when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) and must have time zone.
PaymentItem
object
6 properties 4 required
PaymentDetails
array
Detailed description of the concepts/items considered within a specific payment procedure.
BodyAmountReservationTransactionForReserveInput
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camara-project-two-step-payment-api-openapi.yml Raw ↑

Other APIs CAMARA Project publishes across the network.

CAMARA Project Age Verification API
CAMARA Project Call Forwarding information retrieval API
CAMARA Project Check Device Swap API
CAMARA Project Check SIM swap API
CAMARA Project Connected Network Type API
CAMARA Project Device reachability status API
CAMARA Project Discovery API
CAMARA Project Fill-in API
CAMARA Project Geofencing subscriptions API
CAMARA Project Home Devices QoD API
CAMARA Project Location retrieval API
CAMARA Project Location verification API