Search across 357 schema types in the Beckn Protocol registry.
Sidecar array — one entry per signal the seller commits to report.
OpenADR3 `reportPayloadDescriptor` augmented with a `cardinality` field. Required fields and value enums otherwise match OpenADR3.
A time-series payload. `intervalPeriod` sets the default temporal bounds; each `interval` carries one or more typed `payloads` (valuesMap rows). `payloadDescriptors` declare units/currency/ reading-type for each `payloadType` referenced in the rows; every type used in `intervals` SHOULD be declared in `payloadDescriptors`. `payloadType` follows OpenADR's open-string convention — consumer profiles (e.g. `DemandFlexPerformance`) MAY restrict it to a domain-specific set and add cross-field membership checks.
Resource attributes describing a demand-flex need. Attached to Resource.resourceAttributes to describe what the utility needs from the network. Captures the direction (increase/reduce), event timing, capacity, and location.
Performance attributes for demand-flex M&V (Measurement & Verification). Attached to Performance.performanceAttributes in on_status callbacks.
Unified W3C Verifiable Credential issued per meter by electricity distribution utilities. Combines customer identity, consumption, generation, and storage profiles in a single credentialSubject.
Connection and consumption characteristics for load management and tariff purposes.
DER generation capability.
Battery/energy storage capability.
Reusable identity reference — an identity issued by an external authority.
Verifiable Credential containing aggregated billing period data using ESPI/Green Button types (UsageSummary, SummaryMeasurement, LineItem). Subclass of EnergyCredential. The credential subject combines a customer profile with billing summary data within a W3C VC 2.0 envelope.
ESPI/Green Button billing summary data for a single meter. Uses native ESPI types and enum codes.
Core customer identity for energy credentials — links a utility account to a physical meter.
Represents a W3C Verifiable Credential (https://www.w3.org/TR/vc-data-model-2.0/) used in enrollment flow. This is a wrapper/reference object that contains the credential data (as JWT or JSON-LD), metadata, and URLs. The actual credential follows W3C VC Data Model v2.0 structure. Can be a meter ownership credential, program eligibility credential, DER certification credential, or program enrollment credential.
Details of a credential that has been verified by the BPP. Returned in credentialVerification.verifiedCredentials array.
Details of a conflicting enrollment that prevents the requested enrollment from proceeding. Returned in conflictCheck.conflictingEnrollments array.
User authentication request - sent by BAP to BPP in init/confirm requests. Supports OTP-based or OAuth2/OIDC token-based authentication.
User authentication response - returned by BPP to BAP in on_init/on_confirm responses. Contains verification results and extracted user identity.
OTP authentication request from BAP. - Init request: Send mobile number to initiate OTP - Confirm request: Send mobile + nguid + otp for verification
OTP authentication response from BPP. - On_init response: Returns nguid and message ("OTP sent") - On_confirm response: Returns verification result
OAuth2/OIDC authentication request from BAP. Contains JWT tokens for BPP to validate. BPP extracts claims from token.
OAuth2/OIDC authentication response from BPP. Contains verification results and extracted user identity from token.
Meter details for enrollment in an energy program. Contains meter identifier (UMID) and optional utility information. Used in the meters array within orderAttributes during confirm request. At least one meter must be specified for enrollment to be confirmed.
Verifiable Credential containing historical time-series interval meter readings using ESPI/Green Button types (ReadingType, IntervalBlock, IntervalReading). Subclass of EnergyCredential. The credential subject combines a customer profile with meter data within a W3C VC 2.0 envelope.
ESPI/Green Button meter reading data for a single meter. Uses native ESPI types and enum codes.
Order attributes for P2P energy trading. Attached to Order.orderAttributes to identify BAP and BPP participants involved in a trade. NOTE: Utility IDs for inter-discom trading are captured in EnergyCustomer (buyerAttributes.utilityId and providerAttributes.utilityId).
Role-specific inputs bag. Single-valued, role-stable attributes (currency, sourceType) live flat at the top; the time-varying slots live in a BecknTimeSeries. Seller: offerTimeseries with PRICE_PER_KWH and AVAILABLE_QTY payloads. Buyer: bidTimeseries with REQUESTED_QTY payloads; interval ids must be a subset of the seller's offerTimeseries ids. Buyer does NOT repeat price or availability — those are read from the seller's offerTimeseries by matching interval id.
Payment methods accepted by a payee
New v2.0 Ack format carrying an HTTP Counter-Signature proving the receiver authenticated, received, and processed the inbound request.
Request received but no callback will follow (e.g. agents not found, inventory unavailable, provider closed, context.try preview complete).
Schema definition for AckResponse in the Beckn Protocol
Add-on to a catalog resource
**Postal address** aligned with schema.org `PostalAddress`. Use for human-readable addresses. Geometry lives in `Location.geo` as GeoJSON.
A reference to a transport line that is affected by a service disruption or alert.
Schema definition for Alert in the Beckn Protocol v2.0.1
An optional or additional service available for purchase alongside base transport, such as extra baggage or lounge access.
Error returned asynchronously during a callback. Wraps the base `Error` schema with JSON-LD type annotations to allow linked-data processing.
JSON-LD aware container for domain-specific attributes of an Item. MUST include @context (URI) and @type (compact or full IRI). Any additional properties are allowed and interpreted per the provided JSON-LD context.
A governmental or administrative body responsible for planning, regulating, and overseeing transport services within a jurisdiction.
The quantity and weight of baggage a passenger is permitted to carry or check in without incurring additional charges.
An indicator specifying whether bicycles are permitted on board a particular route or vehicle journey.
A set of rules governing how and when a demand-responsive transport service must be booked in advance.
Schema definition for Buyer in the Beckn Protocol
DEPRECATED. This schema is structurally invalid and does not validate any payloads — the oneOf keyword was incorrectly nested inside properties, which is not valid JSON Schema. The $id also lacked a version segment. Use https://schema.beckn.io/BecknAction/v2.0 instead. BecknAction is the unified envelope for all Beckn actions (both request and callback directions). Callback actions are those with on_ prefixed endpoints (e.g. beckn/on_discover, beckn/on_confirm) and are validated by the same BecknAction schema via if/then dispatch on context.action. This schema will be removed in a future major version.
Beckn /beckn/cancel message payload. Sent by a BAP to a BPP to request cancellation of an active contract. Set context.try to true to first retrieve cancellation terms and fees before committing. (Context wrapper stripped; only the message-content portion is inlined.)
Schema definition for CancellationOutcome in the Beckn Protocol v2.0.1
Schema definition for CancellationPolicy in the Beckn Protocol v2.0.1
Schema definition for CancellationReason in the Beckn Protocol v2.0.1
Availability and compensation expectation terms under which a candidate profile is offered to employers. The proposedConsideration on the core Offer carries the candidate's headline desired salary; this extension provides the full range, notice period, and contract type preferences.
Discoverable profile attributes of a candidate Resource. Captures what the candidate brings (skills, experience, availability) and what they seek (location preference, work mode, job type). Designed for privacy: no name, contact, or identity data. Credentials are referenced via SkillEntry with optional VC attestation URLs.
A Carrier is a transport service provider responsible for moving goods across distances. Carriers operate fleets of vehicles and may own/manage logistics hubs. Maps to beckn:Provider.
Catalog schema for Beckn Protocol v2.0.0 This schema is part of the Long Term Support of Beckn Protocol V2.0 API specification and MUST NOT be extended. Any domain-specific extension must use the property of this schema which is of type Attribute.
Catalog publish processing results from CDS to BPP.
Processing result for a single catalog submission.
Catalog publish request payload.
Beckn /beckn/on_catalog_publish message payload. Sent by a CDS back to a BPP after processing a catalog publish request. Contains per-catalog processing results indicating success, failure, or partial indexing.
Message payload for catalog/pull This schema is part of the Long Term Support of Beckn Protocol V2.0 API specification and MUST NOT be extended. Any domain-specific extension must use the property of this schema which is of type Attribute.
Message payload for catalog/subscription. At least one of `networkIds` or `schemaTypes` must be non-empty. An empty `schemaTypes` array is treated as the wildcard sentinel `"*"`, matching all schema types for the specified networks.
Full subscription record
Schema definition for CategoryCode in the Beckn Protocol v2.0.1
The checkout terminal where the consumer makes the payment
An authority-governed code value. The @context URI identifies the code system authority (e.g. UN ISIC, UNESCO ISCED, India NSQF). The @type identifies the class of code within that system. The code is the actual value. This pattern avoids hardcoding country-specific enumerations into the schema.
Beckn /beckn/confirm message payload. Sent by a BAP to a BPP to confirm a contract, finalising the transaction terms agreed during the select-init negotiation cycle. (Context wrapper stripped; only the message-content portion is inlined.)
Generalized representation of value exchanged under a Contract. Consideration is domain-neutral and may represent: - Monetary value - Credits / tokens - Asset transfer - Service exchange - Compliance artifact
A Consignment is a collection of packages or shipments grouped together under a single commercial transaction between a shipper and consignee. Maps to beckn:Order.
Schema definition for Constraint in the Beckn Protocol v2.0.1
Schema definition for Consumer in the Beckn Protocol v2.0
Contact information for sender, receiver, driver, or operator.
Base context schema for all Beckn API calls. Contains addressing information (BAP/BPP identifiers and API URLs), protocol version, the action being called, transaction and message IDs, timestamp, TTL, and optional encryption key. This schema defines all possible properties but imposes NO required-field constraints. Endpoint-specific validation is defined inline in operation request schemas.
This is a JSON-LD compliant, linked-data schema that specifies a generic multi-party, digitally signed Contract between a set of participants. based on the vocabulary defined in the @context. By default, it is the most generic form of contract i.e beckn:Contract. However, based on the mapping being used in @context, it could take values like retail:Order, mobility:Reservation, healthcare:Appointment, and so on, which will be defined as sub-classes of beckn:Contract. Alternate description A digitally agreed commitment between two or more participants governing the exchange of economic or non-economic value. Contract is the canonical contract object in the generalized Beckn v2.1 protocol. It replaces the commerce-specific Order construct as the canonical transaction object at the API layer. A Contract binds: - Commitments (what is agreed) - Consideration (value promised) - Performance (how execution occurs) - Settlements (how consideration is discharged) The model is domain-neutral and supports commerce, hiring, energy markets, carbon exchanges, data access, mobility, subscriptions, and other use cases.
A line item within a Contract, linking an accepted Offer and ordered Item with quantity and price.
A signed receipt transmitted in the synchronous `Ack` response body, proving that the receiver authenticated, received, and processed the inbound request. `CounterSignature` shares the same wire format as `Signature` but differs: - **Signer**: the response receiver (not the request sender) - **Location**: transmitted in the `Ack` response body (not in the `Authorization` header) - **`digest`**: covers the Ack response body (not the inbound request body) - **`(request-digest)`** and **`(message-id)`** MUST be included in the signing string Signing string format: ``` (created): {unixTimestamp} (expires): {unixTimestamp} digest: BLAKE-512={base64DigestOfAckBody} (request-digest): BLAKE-512={base64DigestOfInboundRequestBody} (message-id): {messageId} ```
A Courier is an individual delivery agent responsible for last-mile pickup and delivery of packages, typically in hyperlocal or urban delivery contexts. Maps to beckn:Agent.
Commercial and availability terms under which a course is offered. The proposedConsideration on the core Offer carries the headline fee; this extension provides pricing type context and enrollment window.
Intrinsic attributes of a training course or program Resource. Domain-generic: applicable to any skilling vertical — vocational training, professional certification, higher education, government skill schemes, etc.
A credential artifact that is either (a) a W3C Verifiable Credential (opaque JSON object) or (b) a document attachment reference requiring manual/offline verification.
A single credential requirement or prerequisite. Specifies what a candidate or enrollee must hold. Category is a broad class; subtype is the specific credential within that class.
A classification of a day (e.g., weekday, weekend, public holiday) used to define when a service pattern is valid.
Callback delivery retry configuration This schema is part of the Long Term Support of Beckn Protocol V2.0 API specification and MUST NOT be extended. Any domain-specific extension must use the property of this schema which is of type Attribute.
A DeliverySlot is a time window offered or agreed upon for delivery of a shipment. Maps to beckn:TimeSlot.
A real-time message containing predicted departure times for vehicles at a stop, as used in VDV real-time standards.
Schema definition for Descriptor in the Beckn Protocol v2.0.1
The direction of travel of a transport service along a route, typically expressed as inbound or outbound.
Beckn /beckn/discover message payload as published at schema.beckn.io. Requires all discover qualifiers to be nested inside an `intent` container object. (Context wrapper stripped; only the message-content portion is inlined.)
Schema definition for DisplayedRating in the Beckn Protocol v2.0.1
A document, that can be parsed, printed, download or displayed. This has intentionally been kept separate from MediaFile as they may contain additional attributes like signature, schema etc.
A person who operates a transport vehicle and is responsible for the safe delivery of passengers during a mobility service trip.
A set of rules governing the locations and conditions under which passengers may be dropped off at the end of a ride-hailing or on-demand transport service.
Schema definition for Eligibility in the Beckn Protocol v2.0.1
A critical safety or operational event requiring immediate response, such as an accident, vehicle breakdown, or passenger emergency.
Contract-level metadata for an employer-to-candidate hiring offer. Captures the specific role details being offered, compensation amount (as distinct from the candidate's desired range), proposed joining date, offer expiry, and candidate response state.
A contractually granted, policy-governed right that allows a specific party to access, use, or claim a defined economic resource within stated scope and validity constraints. It represents the enforceable permission created by an order, independent of the credential used to exercise it.
A selector that identifies which transport entities (routes, trips, stops, or agencies) are affected by a given alert.
Schema definition for Error in the Beckn Protocol v2.0.1
Schema definition for ErrorResponse in the Beckn Protocol v2.0.1
A real-time data delivery providing predicted departure and arrival times for a set of vehicle journeys.
Locations in a transport network where fixed-route and flexible services connect, enabling passenger interchange.
The monetary cost of travel for a specific journey or service, calculated based on applicable fare rules and passenger categories.
A detailed breakdown of the total fare into its constituent components, including base fare, taxes, surcharges, and discounts.
A component of an air travel fare that applies to a specific flight segment or leg, used in aviation pricing.
An estimated fare for a requested trip, typically returned in response to a search before the booking is confirmed.
A rule defining how a fare is applied to a single leg of a journey based on origin, destination, network, and time.
The physical or digital medium used to carry or present a fare product, such as a contactless card, mobile app, or paper ticket.
A purchasable entitlement to travel defining conditions of use, validity, and applicable passenger categories.
The calculated fare for a requested trip, returned as part of a trip planning or fare enquiry response.
A rule defining how fares from different legs are combined when a passenger makes a transfer between services.
A data publication providing transit or mobility information in a standardised format for consumption by applications or planners.
A single non-stop flight operated between two airports, forming a unit of an air travel itinerary.
Describes a form
A user's submitted response to a Beckn form. Captures the filled-in field values keyed by form field names. Typically attached to a RatingInput to convey feedback form answers alongside a rating.
A headway-based service specification indicating how often a vehicle runs on a route within a given time window.
Schema definition for Fulfillment in the Beckn Protocol v2.0.1
The entity directly involved in fulfilling the order. It could be a person, an organization, a machine, a software application, or an AI Agent.
Describes the mode of fulfillment. This is an extensible container allowing domain-specific fulfillment modes to be expressed via attributes.
Schema definition for FulfillmentStage in the Beckn Protocol v2.0.1
A credential/document/proof relevant to authorization at a fulfillment stage endpoint. This may be a token to be verified (QR/OTP/URL) or a document to be inspected manually.
A stage boundary endpoint (entry or exit) within a fulfillment, such as pickup, handover, warehouse in/out, border crossing, gate entry/exit, security check, etc. May require one or more proofs/permits/tokens/documents.
A specific location associated with a fulfillment (trip or journey) at which passengers board, alight, or transfer between services.
A real-time delivery of textual messages or alerts related to service disruptions or passenger information.
**GeoJSON geometry** per RFC 7946. Coordinates are in **EPSG:4326 (WGS-84)** and MUST follow **[longitude, latitude, (altitude?)]** order. Supported types: - Point, LineString, Polygon - MultiPoint, MultiLineString, MultiPolygon - GeometryCollection (uses `geometries` instead of `coordinates`) Notes: - For rectangles, use a Polygon with a single linear ring where the first and last positions are identical. - Circles are **not native** to GeoJSON. For circular searches, use `SpatialConstraint` with `op: s_dwithin` and a Point + `distanceMeters`, or approximate the circle as a Polygon. - Optional `bbox` is `[west, south, east, north]` in degrees.
A virtual geographic boundary used to define service areas, restricted zones, or operational boundaries for mobility assets.
A virtual geographic boundary used to define operational areas, speed limits, parking rules, or restrictions for shared mobility services.
Commercial and availability terms under which a job opportunity is offered. The proposedConsideration on the core Offer object carries the midpoint or headline compensation figure; this extension provides the full range and period breakdown for display and filtering.
Intrinsic attributes of a job opportunity Resource. Domain-generic: applicable to any hiring vertical (tech, construction, logistics, healthcare, gig economy, etc.).
Execution state of the hiring process service. Covers the pipeline from initial screening through to offer acceptance or withdrawal. Includes optional credential verification triggered by the employer during the hiring process.
A Hub is a logistics fulfillment center, sorting facility, or distribution point where goods are consolidated, sorted, and dispatched for onward delivery. Maps to beckn:Location.
A Beckn domain schema for hyperlocal (same-city, typically sub-2-hour) physical delivery of goods or prepared food from an origin to a destination within a short radius. HyperlocalDelivery is a concrete, domain-specific fulfillmentAttributes value for a beckn:Fulfillment entry. It is fully aligned with schema:ParcelDelivery. schema.org alignment: schema:ParcelDelivery (subtype of schema:Intangible) Use in: beckn:Fulfillment.fulfillmentAttributes
A reported event on the transport network that affects normal service operations, such as a disruption, roadblock, or infrastructure failure.
Beckn /beckn/init message payload. Sent by a BAP to a BPP to initialise a contract with consumer details (billing address, fulfillment preferences, etc.). (Context wrapper stripped; only the message-content portion is inlined.)
Schema definition for Instruction in the Beckn Protocol v2.0.1
A declaration of an intent to transact
A planned transfer connection point where passengers switch between two or more transport services, with defined timing constraints.
Schema definition for Invoice in the Beckn Protocol v2.0.1
Schema definition for Item in the Beckn Protocol v2.0.1
A complete planned trip containing an ordered sequence of legs, including transfer points, durations, and timing.
A component of an aviation itinerary such as a flight segment, ground transport leg, or ancillary service.
Transaction-level metadata for a job application contract. Captures the application reference, aggregate verification outcome, and reverification state. No credential payloads are stored here.
Execution metadata for the verification and routing service performed during a job application. Includes the verification method used, per-requirement results, proof integrity reference, and routing outcome. No VC or VP payloads are stored.
A complete travel itinerary from origin to destination, potentially comprising multiple legs using different transport modes.
A single uninterrupted segment of a journey made using one transport mode or service between two consecutive locations.
A floor or vertical level within a multi-level transit station or facility, used to define internal navigation paths.
A named, branded public transport service identified by a number or name, typically operating over one or more routes.
A causal attribution record asserting that the Beckn transaction in which this entry appears was triggered by a specific upstream Beckn interaction. Used in Context.lineage at transaction boundaries — when a new transaction is initiated as a direct consequence of an upstream interaction. MUST NOT be included within subsequent steps of the same transaction, and MUST NOT be propagated by downstream responses.
A place represented by GeoJSON geometry and optional address. Source: main/schema/core/v2/attributes.yaml#Location
A set of geographic locations (stops or areas) that can collectively serve as an origin or destination for flexible transit services.
An association between a stop and a location group, used in flexible transit service planning.
A request for details about a specific geographic location, stop, or point of interest in the transport network.
An Alert is a notification or warning related to a shipment, such as delays, exceptions, damage reports, or SLA breaches. Maps to beckn:Event.
Defines terms under which a shipment booking can be cancelled.
A Driver is an individual who operates a vehicle for logistics delivery. Drivers are assigned to shipments and responsible for physical transport. Maps to beckn:Agent.
Total cost charged for a logistics service including base freight, surcharges, taxes.
A single line item in the fare breakup for a logistics service.
Qualitative feedback from sender or receiver about a logistics experience.
Entity operating a logistics network or fleet, responsible for end-to-end delivery service.
A geographic location relevant to logistics such as origin, destination, hub, or waypoint. Includes structured address and GPS coordinates. Maps to beckn:Location and schema:Place.
A numeric score given by a user for a logistics service, driver, or carrier.
Digital acknowledgment of payment and delivery for a logistics service.
A Route is the planned path for a shipment from origin to destination, potentially passing through multiple hubs and waypoints. Maps to beckn:Journey.
Customer support ticket for shipment issues — loss, damage, delay, or billing.
A Vehicle is a transport asset used for logistics operations. Vehicle types range from bicycles for hyperlocal delivery to heavy trucks for long haul freight. Maps to beckn:Asset.
A Package is a physical unit of goods prepared for transport within a shipment. Maps to beckn:Item.
Proof of delivery or pickup evidence, including photos, signatures, OTP confirmations, or digital receipts. Maps to beckn:Document.
Defines conditions for returning goods and reverse logistics workflows.
A Shipment represents the movement of one or more packages from an origin to a destination. It is the top-level fulfillment entity in a logistics transaction and maps to beckn:Fulfillment.
A TrackingUpdate is a real-time or periodic update on the status and location of a shipment during transit. Maps to beckn:Event.
A Waypoint is an intermediate stop or checkpoint on a logistics route, such as a sorting hub, relay station, or customs checkpoint. Maps to beckn:Stop.
An item that has been reported lost or found in connection with a transport service.
Message payload for catalog/master_search This schema is part of the Long Term Support of Beckn Protocol V2.0 API specification and MUST NOT be extended. Any domain-specific extension must use the property of this schema which is of type Attribute.
A image, audio, or video typically intended for display purposes
Reference to an image, audio clip, or video used for multimodal search.
How the discovery engine should use the provided media inputs.
Open payload container for Beckn action messages. The specific content of the message object is determined by the action value in the accompanying Context. BecknAction constrains message content based on context.action via if/then dispatch rules. Direct use of this schema provides no payload constraints — use BecknAction for validated action payloads.
Attributes for the Mobility entity in the Beckn Mobility domain.
A real-time arrival or departure prediction for a specific vehicle at a specific stop within a monitored journey.
A real-time representation of a vehicle journey being actively tracked, including position and schedule adherence data.
NACK — Bad Request: Malformed or invalid request; the server could not parse or validate the payload.
Invalid or missing authentication credentials; signature could not be verified.
A grouping of routes and lines operated under a common brand or authority, used for fare and operational management.
Rules governing the consequences and fees applied when a passenger fails to appear for a confirmed transport service booking.
An indicator of the current passenger load level of a vehicle, such as empty, many seats available, or full.
A generalized, cross-domain Offer that captures the terms under which one or more Resources may be committed. Core intent: - Support multiple terms/eligibility/constraints/price points for the same Resource(s) - Support dynamic / on-the-fly offers (e.g., bundling, combinational discounts, eligibility changes, capacity-aware pricing) This mirrors the role of Offer in current Beckn (and schema.org patterns), but keeps the shape minimal and composable via `beckn:offerAttributes`.
Beckn /beckn/on_cancel message payload. Sent by a BPP to a BAP in response to a /beckn/cancel call, returning the contract with status set to CANCELLED and any applicable cancellation outcome. (Context wrapper stripped; only the message-content portion is inlined.)
Beckn /beckn/on_confirm message payload. Sent by a BPP to a BAP in response to a /beckn/confirm call, returning the confirmed contract with status set to CONFIRMED. (Context wrapper stripped; only the message-content portion is inlined.)
The on_discover response payload containing matching catalogs.
Beckn /beckn/on_init message payload. Sent by a BPP to a BAP in response to a /beckn/init call, with the updated contract including payment terms and billing confirmation. (Context wrapper stripped; only the message-content portion is inlined.)
Beckn /beckn/on_rate message payload. Sent by a BPP to a BAP in response to a /beckn/rate call, optionally returning rating forms to collect structured feedback from the consumer. (Context wrapper stripped; only the message-content portion is inlined.)
Beckn /beckn/on_select message payload. Sent by a BPP to a BAP in response to a /beckn/select call, with updated contract terms. (Context wrapper stripped; only the message-content portion is inlined.)
Beckn /beckn/on_status message payload. Sent by a BPP to a BAP in response to a /beckn/status call (or as an unsolicited status push), returning the current state of the contract. (Context wrapper stripped; only the message-content portion is inlined.)
Beckn /beckn/on_support message payload. Sent by a BPP to a BAP in response to a /beckn/support call, returning support contact details and available channels. (Context wrapper stripped; only the message-content portion is inlined.)
Beckn /beckn/on_track message payload. Sent by a BPP to a BAP in response to a /beckn/track call, returning a Tracking handle with the URL and/or WebSocket endpoint for real-time fulfillment tracking. (Context wrapper stripped; only the message-content portion is inlined.)
Beckn /beckn/on_update message payload. Sent by a BPP to a BAP in response to a /beckn/update call (or as an unsolicited update push), returning the updated contract state. (Context wrapper stripped; only the message-content portion is inlined.)
An organization that provides and operates public transport or shared mobility services under a defined service agreement.
Schema definition for Order in the Beckn Protocol
Schema definition for OrderItem in the Beckn Protocol
An organization such as a company, non-profit, or governmental institution. Modeled after schema.org/Organization.
Pagination metadata returned with list responses This schema is part of the Long Term Support of Beckn Protocol V2.0 API specification and MUST NOT be extended. Any domain-specific extension must use the property of this schema which is of type Attribute.
A person who travels using a transport service and is identified in a booking or travel document.
The measured number of passengers currently aboard a vehicle, used for real-time capacity and load management.
A collection of passengers traveling together as a group, with a group size and a designated lead passenger.
A connection between two points within a transit station (e.g., stairway, elevator, walkway) used for indoor navigation and accessibility routing.
A unique sequence of stops visited by trips on a route, grouping trips with identical stop sequences and timing structures.
Schema definition for Payment in the Beckn Protocol
Schema definition for PaymentAction in the Beckn Protocol v2.0.1
A single payment instruction for an order. Represents one line item in the paymentTerms array of an Order — e.g., a pre-order UPI payment, a cash-on-delivery amount, or an instalment.
Schema definition for PaymentTerms in the Beckn Protocol v2.0.1
Describes when in the order lifecycle a payment flow should be triggered. Typically useful for initiating checkouts and settlement flows.
Generalized execution/performance unit. This is where downstream objects bind: - Fulfillment-like details (where/when/how) - Tracking handles - Support touchpoints - Status updates A minimal envelope that carries identity, status, and a performanceAttributes bag that holds the concrete domain-specific delivery schema. Domain specification authors can attach rich context and types via `performanceAttributes`. For example, Hyperlocal delivery details (pickup/delivery locations, items shipped, agent, etc.) are placed inside performanceAttributes using a well-known domain schema such as HyperlocalDelivery. Use the generic Attributes schema when no well-known domain schema exists.
A person (alive, deceased, or fictional). Modeled after schema.org/Person.
A designated location used as a pickup or dropoff point for passengers in a ride-hailing or demand-responsive transport service.
A set of rules governing the locations and conditions under which passengers may be picked up for a ride-hailing or on-demand transport service.
A request for a specific accommodation or seat assignment within a transport service during the booking process.
A journey planning response containing one or more itinerary options for a given trip request.
The output of a MaaS platform planning request, listing available transport options for a requested trip.
Schema definition for Policy in the Beckn Protocol v2.0.1
Schema definition for PriceSpecification in the Beckn Protocol v2.0.1
Schema definition for ProcessingNotice in the Beckn Protocol v2.0.1
A real-time prediction of a vehicle's arrival or departure time at a stop, including an indication of prediction confidence.
Schema definition for Provider in the Beckn Protocol v2.0.1
JSON body of `GET /catalog/pull/result/{requestId}/catalogs.json`. Same structure as the inline `catalog` array in the callback payload — a list of distribution-envelope catalog objects. This schema is part of the Long Term Support of Beckn Protocol V2.0 API specification and MUST NOT be extended. Any domain-specific extension must use the property of this schema which is of type Attribute.
Schema definition for Quantity in the Beckn Protocol v2.0.1
A specific platform, bay, or boarding area within a Stop Place at which passengers board or alight from a vehicle.
A price quote generated by a BPP for a specific selection of offers and fulfillment options. Returned in on_select, on_init, and on_confirm responses. Aggregates item prices, taxes, delivery charges, and discounts into a total.
Beckn /beckn/rate message payload. Sent by a BAP to a BPP to submit one or more rating inputs for entities in a completed contract (order, fulfillment, item, provider, agent, support). (Context wrapper stripped; only the message-content portion is inlined.)
Aggregated rating information for an entity. Aligns with schema.org/AggregateRating semantics.
A form designed to capture rating and feedback from a user. This can be used by both BAP and BPP to fetch ratings and feedback of their respective users.
A form designed to capture rating and feedback from a user. This can be used by both BAP and BPP to fetch ratings and feedback of their respective users.
Defines a recurring temporal schedule such as operating hours or serviceability timing windows. Supports day-based recurrence and optional holiday exclusions.
Schema definition for RefundTerms in the Beckn Protocol v2.0.1
DEPRECATED. This schema is structurally invalid and does not validate any payloads — the oneOf keyword was incorrectly nested inside properties, which is not valid JSON Schema. Use https://schema.beckn.io/BecknAction/v2.0 instead. BecknAction is the unified envelope for all Beckn actions (both request and callback directions). The request/callback distinction is encoded in context.action (e.g. beckn/discover for requests, beckn/on_discover for callbacks). This schema will be removed in a future major version.
A cryptographic binding that explicitly ties a callback to the specific inbound request that triggered it. Establishes bilateral non-repudiation for the asynchronous leg of a Beckn interaction. Use `lineage` (on `Context`) for cross-transaction causality. Verification steps: 1. Recompute BLAKE2b-512 digest of the original request body; compare to `digest`. 2. Confirm `messageId` matches the `messageId` from the original request `Context`. This schema is part of the Long Term Support of Beckn Protocol V2.0 API specification and MUST NOT be extended. Any domain-specific extension must use the property of this schema which is of type Attribute.
A minimal, domain-neutral abstraction representing any discoverable, referenceable, or committable unit of value, capability, service, entitlement, or asset within the network. Examples: - A retail product SKU, a mobility ride, a job role, a carbon credit unit, a dataset/API entitlement, a training course, a clinic service slot. Designed for composability through `resourceAttributes` where domain packs can plug in their specific fields without changing the core.
A specific ride-hailing vehicle category and pricing option presented to a passenger in response to a ride request.
A passenger's request for an on-demand transport service between two points, specifying origin, destination, and travel preferences.
A person using a shared mobility service (such as a bike-share, scooter, or car-share) who has a registered account with the provider.
A classification of passenger type (e.g., adult, child, senior, student) used to determine applicable fare entitlements.
The physical or logical path followed by a transport service, defined as an ordered sequence of stops or waypoints.
A set of rules, protocols, and standards governing safety requirements for drivers, vehicles, and passengers on a mobility platform.
A combination of one or more fare products bundled for sale through a specific distribution channel.
A specific seat position reserved or assigned to a passenger on a flight, train, or other transport service.
A portion of a rail journey operated continuously by a single carrier between two consecutive stops or stations.
Beckn /beckn/select message payload. Sent by a BAP to a BPP to select items and offers from a catalog, initiating the negotiation cycle. (Context wrapper stripped; only the message-content portion is inlined.)
Internal failure on the network participant's application; the request could not be processed. The response body MAY contain an `error` object with additional details.
A schedule defining on which dates a transport service operates, including regular service days and exceptional dates.
A classification of the level of service offered by a transport service, such as economy, business, or first class.
The top-level response container in SIRI encapsulating one or more real-time data delivery types.
Schema definition for SettlementSchedule in the Beckn Protocol v2.0.1
Describes the terms of settlement associated with a given transaction. This is not to be confused with the PaymentAction as it describes all the places where the money gets disbursed after reconciliation.
The geographic path traced by a vehicle along a route, represented as an ordered sequence of geographic coordinates.
Total cost charged for a logistics service including base freight, surcharges, taxes.
A single line item in the fare breakup for a logistics service.
A digitally signed authentication credential in the HTTP `Authorization` header. Follows draft-cavage-http-signatures-12 as profiled by BECKN-006. Format: ``` Signature keyId="{subscriberId}|{uniqueKeyId}|{algorithm}",algorithm="{algorithm}",created="{unixTimestamp}",expires="{unixTimestamp}",headers="{signedHeaders}",signature="{base64Signature}" ``` | Attribute | Description | |-----------|-------------| | `keyId` | `{subscriberId}\|{uniqueKeyId}\|{algorithm}` — FQDN, registry UUID, signing algorithm | | `algorithm` | MUST be `ed25519` | | `created` | Unix timestamp when the signature was created | | `expires` | Unix timestamp when the signature expires | | `headers` | Space-separated signed headers. MUST include `(created)`, `(expires)`, `digest` | | `signature` | Base64-encoded Ed25519 signature over the signing string | Signing string: `(created): {value}\n(expires): {value}\ndigest: BLAKE-512={digest}` where `digest` is a BLAKE2b-512 hash of the request body, Base64-encoded.
Schema definition for Skill in the Beckn Protocol v2.0.1
A single skill, qualification, or credential held by a candidate. The attested flag and proof_request_url are optional — allowing the schema to function in early-stage ecosystems where VC infrastructure is not yet universal. As VCs become available for specific skills, the proof_request_url can be populated without any schema change.
**Spatial predicate** using **OGC CQL2 (JSON semantics)** applied to one or more geometry targets in an item. This is where clients express spatial intent. Key ideas: - `targets`: one or more **JSONPath-like** pointers that locate geometry fields within each item document (e.g., `$['availableAt'][*]['geo']`). - `op`: spatial operator (CQL2). Common ones: • `S_WITHIN` (A is completely inside B) • `S_INTERSECTS` (A intersects B) • `S_CONTAINS` (A contains B) • `S_DWITHIN` (A within distance of B) - `geometry`: **GeoJSON** literal used as the predicate reference geometry. - `distanceMeters`: required for `S_DWITHIN` when using a GeoJSON Point/shape. - `quantifier`: if a target resolves to an array, choose whether **ANY** (default), **ALL**, or **NONE** of elements must satisfy the predicate. CRS: unless otherwise stated, all coordinates are **EPSG:4326**.
Schema definition for State in the Beckn Protocol v2.0.1
A major transit facility serving as a hub for one or more transport modes, typically offering waiting areas, ticketing, and interchange facilities.
Static descriptive information about a shared mobility docking station, including its location, capacity, and features.
The real-time operational state of a shared mobility station, including the number of available docks and vehicles.
Beckn /beckn/status message payload. Sent by a BAP to a BPP to query the current state of a contract/order by its identifier. (Context wrapper stripped; only the message-content portion is inlined.)
A designated location where vehicles stop to allow passengers to board or alight from a transport service.
A group of stops that collectively define a zone from which a demand-responsive service may pick up or drop off passengers.
A departure or arrival event at a stop, used to retrieve the next or previous vehicle movements at a specific location.
A real-time data service providing predicted arrivals and departures of vehicles at a specific stop.
A physical location serving as a transit stop facility, comprising one or more quays, entrances, and associated infrastructure.
An abstract or scheduled point in a public transport network at which passengers can board or alight from a service.
The scheduled arrival and departure times for a vehicle at a specific stop within a vehicle journey.
A real-time update to the predicted arrival or departure time of a vehicle at a specific stop within a journey.
Describes a support session info
Beckn /beckn/support message payload. Sent by a BAP to a BPP to request support contact information or to open a support ticket for an existing order/contract. (Context wrapper stripped; only the message-content portion is inlined.)
Canonical support contact for an entity, mapped to schema.org ContactPoint.
Support request by a user. If no field is set, the user can expect a public support contact info
Support response payload returned by a BPP to a BAP in the /beckn/on_support callback. Contains the support ticket reference, available contact channels, SLA commitment, and optional consumer acknowledgement details.
A support ticket raised against an order
A dynamic pricing factor applied during periods of high demand that increases base fares proportionally to balance supply and demand.
A pricing plan defined by a shared mobility system, describing costs and billing rules for vehicle use.
A geographic zone used to define and apply fare structures, within which a single fare or set of rules applies.
A document or digital record granting the holder the right to travel on a specific transport service or within a defined validity scope.
Represents a moment or duration in time. Can express a timestamp, a duration, or a time range.
Time window with date-time precision for availability/validity This schema is part of the Long Term Support of Beckn Protocol V2.0 API specification and MUST NOT be extended. Any domain-specific extension must use the property of this schema which is of type Attribute.
A structured schedule listing planned arrival and departure times for vehicles at each stop along a route.
Details required to initiate real-time tracking (if relevant) for an ongoing transaction
Information regarding live tracking of the fufillment of a contract
Schema definition for TrackingRequest in the Beckn Protocol v2.0.1
Beckn protocol transaction endpoint identifier.
A defined connection rule between two routes or services at a common stop, specifying minimum transfer time or transfer type.
A generic transport entity in the OSLO mobility ontology representing any object involved in transport operations.
A document (physical or digital) issued to a passenger proving entitlement to travel, used for validation or inspection.
A confirmed and booked journey from an origin to a destination, representing a completed mobility service order.
An identifier that uniquely references a specific vehicle journey in a real-time transit feed.
A request submitted to a journey planning system specifying origin, destination, travel time, and preferences.
The result of a trip planning request, containing one or more journey options with leg details and timing.
A description of the desired journey used as input to search and price transport options.
A multi-dimensional update to an in-progress or upcoming mobility trip, covering contract modifications (added/removed services, route changes), status notifications (driver arriving, trip started), and real-time tracking endpoint information.
Beckn /beckn/update message payload. Sent by a BAP to a BPP to request changes to an active contract (e.g., update fulfillment address, add items, change quantities). The context.try flag must be true during negotiation. (Context wrapper stripped; only the message-content portion is inlined.)
A motorized or human-powered mobility asset used to carry passengers or goods between locations.
A broad classification of vehicles by their physical type, such as two-wheeler, three-wheeler, four-wheeler, or bus.
An identifier that uniquely references a specific vehicle in a real-time transit feed.
A specific operational instance of a vehicle traveling a defined route at a scheduled time on a given service day.
A real-time data delivery providing current positions and operational states of a set of vehicles.
The current real-time geographic position, bearing, and speed of a vehicle operating a transport service.
The real-time operational state of a vehicle or mobility asset, such as available, in use, reserved, or disabled.
A class or category of vehicle defined by its mode of transport, capacity, propulsion type, and accessibility features.
Summary of a credential verification check. Contains the overall result, reason codes for any failures, and which credential categories were successfully verified. No VC or VP payloads are included.
Rules governing the maximum time a driver is required to wait for a passenger at the pickup location before being permitted to cancel the booking.
Container for retail contract attributes (migrated from v2 orderAttributes)
Container for retail performance execution attributes (migrated from v2 fulfillmentAttributes)