Opensource Assurance Specification 1.1.0
Opensource Assurance Transaction API specification
Beckn Provider Platform (BPP)
POST /search
Search for open source assurance services and discover OASPs
Description
BAP sends a search request with its intent to find specific open source
assurance services
and the OASPs that offer them. The BPP may respond with an on_search
callback.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"intent": {
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"provider": {
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": null,
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": "string",
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": null,
"price": {
"currency": "string",
"value": null,
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": null,
"fulfillments": null,
"payments": null,
"offers": null,
"providers": null,
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "8871e058-a842-43d6-96eb-67943607a443"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
},
"fulfillment": null,
"payment": null,
"category": null,
"offer": null,
"item": null,
"tags": null
}
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"search"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"required": [
"intent"
],
"properties": {
"intent": {
"type": "object",
"properties": {
"descriptor": {
"$ref": "#/components/schemas/Descriptor"
},
"provider": {
"$ref": "#/components/schemas/Provider"
},
"fulfillment": {
"$ref": "#/components/schemas/Fulfillment"
},
"payment": {
"$ref": "#/components/schemas/Payment"
},
"category": {
"$ref": "#/components/schemas/Category"
},
"offer": {
"$ref": "#/components/schemas/Offer"
},
"item": {
"$ref": "#/components/schemas/Item"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
}
}
}
}
Response 200 OK
{
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
Schema of the response body
{
"description": "Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.",
"enum": [
"ACK",
"NACK"
]
},
"tags": {
"description": "A list of tags containing any additional information sent along with the Acknowledgement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
Other responses
{
"code": "string",
"paths": "string",
"message": "string"
}
Schema of the response body
{
"description": "Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""
},
"paths": {
"type": "string",
"description": "Path to json schema generating the error. Used only during json schema validation errors"
},
"message": {
"type": "string",
"description": "Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."
}
}
}
POST /select
Select an open source assurance service and provider (OASP)
Description
BAP selects a specific service offering and the OASP to fulfill the request.
This initiates the order process. The BPP may respond with an on_select
callback.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "67d90f77-1070-43d3-a00a-8139828d734b"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"select"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"required": [
"order"
],
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
Response 200 OK
{
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
Schema of the response body
{
"description": "Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.",
"enum": [
"ACK",
"NACK"
]
},
"tags": {
"description": "A list of tags containing any additional information sent along with the Acknowledgement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
Other responses
{
"code": "string",
"paths": "string",
"message": "string"
}
Schema of the response body
{
"description": "Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""
},
"paths": {
"type": "string",
"description": "Path to json schema generating the error. Used only during json schema validation errors"
},
"message": {
"type": "string",
"description": "Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."
}
}
}
POST /update
Update an existing order or submit a counter-offer
Description
BAP updates an existing order or submits a counter-offer to an OASP's
quotation.
To submit a counter-offer, include a quote object in the order object
within the request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "5b5b1fd9-d531-409f-8cde-03b53a9e0325"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"update"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"required": [
"order"
],
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
Response 200 OK
{
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
Schema of the response body
{
"description": "Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.",
"enum": [
"ACK",
"NACK"
]
},
"tags": {
"description": "A list of tags containing any additional information sent along with the Acknowledgement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
Other responses
{
"code": "string",
"paths": "string",
"message": "string"
}
Schema of the response body
{
"description": "Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""
},
"paths": {
"type": "string",
"description": "Path to json schema generating the error. Used only during json schema validation errors"
},
"message": {
"type": "string",
"description": "Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."
}
}
}
POST /init
Initialize the fulfillment of an order
Description
BPP initiates the fulfillment process of an order, communicating the necessary details to the OASP. This applies to both one-time orders and the initial order within a subscription.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "42c0bcba-8fc0-44ef-a36a-147cc7dd4150"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"init"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"required": [
"order"
],
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
Response 200 OK
{
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
Schema of the response body
{
"description": "Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.",
"enum": [
"ACK",
"NACK"
]
},
"tags": {
"description": "A list of tags containing any additional information sent along with the Acknowledgement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
Other responses
{
"code": "string",
"paths": "string",
"message": "string"
}
Schema of the response body
{
"description": "Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""
},
"paths": {
"type": "string",
"description": "Path to json schema generating the error. Used only during json schema validation errors"
},
"message": {
"type": "string",
"description": "Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."
}
}
}
POST /confirm
Confirm an order
Description
BAP confirms an order by agreeing to the terms and conditions of the order, including payment and fulfillment details.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "4b5fa010-5f2a-4da7-9efb-11e03c1485ab"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"confirm"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"required": [
"order"
],
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
Response 200 OK
{
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
Schema of the response body
{
"description": "Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.",
"enum": [
"ACK",
"NACK"
]
},
"tags": {
"description": "A list of tags containing any additional information sent along with the Acknowledgement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
Other responses
{
"code": "string",
"paths": "string",
"message": "string"
}
Schema of the response body
{
"description": "Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""
},
"paths": {
"type": "string",
"description": "Path to json schema generating the error. Used only during json schema validation errors"
},
"message": {
"type": "string",
"description": "Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."
}
}
}
POST /status
Get the status of an order
Description
BAP requests the latest status of an order.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order_id": "string"
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"status"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"required": [
"order_id"
],
"properties": {
"order_id": {
"type": "string",
"description": "ID of the order for which the status is requested."
}
}
}
}
}
Response 200 OK
{
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
Schema of the response body
{
"description": "Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.",
"enum": [
"ACK",
"NACK"
]
},
"tags": {
"description": "A list of tags containing any additional information sent along with the Acknowledgement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
Other responses
{
"code": "string",
"paths": "string",
"message": "string"
}
Schema of the response body
{
"description": "Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""
},
"paths": {
"type": "string",
"description": "Path to json schema generating the error. Used only during json schema validation errors"
},
"message": {
"type": "string",
"description": "Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."
}
}
}
POST /subscribe
Subscribe to an open-source assurance service plan
Description
BAP initiates a subscription to a service plan offered by an OASP.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "08b7d5a7-c90c-4862-b533-fc27a5cc17af"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"subscribe"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"required": [
"order"
],
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
Response 200 OK
{
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
Schema of the response body
{
"description": "Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.",
"enum": [
"ACK",
"NACK"
]
},
"tags": {
"description": "A list of tags containing any additional information sent along with the Acknowledgement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
Other responses
{
"code": "string",
"paths": "string",
"message": "string"
}
Schema of the response body
{
"description": "Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""
},
"paths": {
"type": "string",
"description": "Path to json schema generating the error. Used only during json schema validation errors"
},
"message": {
"type": "string",
"description": "Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."
}
}
}
POST /track
Track the progress of an order
Description
BAP requests tracking information for an active order.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order_id": "string"
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"track"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"required": [
"order_id"
],
"properties": {
"order_id": {
"type": "string",
"description": "ID of the order to track."
}
}
}
}
}
Response 200 OK
{
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
Schema of the response body
{
"description": "Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.",
"enum": [
"ACK",
"NACK"
]
},
"tags": {
"description": "A list of tags containing any additional information sent along with the Acknowledgement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
Other responses
{
"code": "string",
"paths": "string",
"message": "string"
}
Schema of the response body
{
"description": "Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""
},
"paths": {
"type": "string",
"description": "Path to json schema generating the error. Used only during json schema validation errors"
},
"message": {
"type": "string",
"description": "Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."
}
}
}
POST /cancel
Cancel an open source assurance service order
Description
BAP requests cancellation of an active open source assurance service order.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order_id": "string",
"cancellation_reason_id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
}
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"cancel"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"properties": {
"order_id": {
"$ref": "#/components/schemas/Order/properties/id"
},
"cancellation_reason_id": {
"$ref": "#/components/schemas/Option/properties/id"
},
"descriptor": {
"$ref": "#/components/schemas/Descriptor"
}
}
}
}
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /rating
Provide a rating for an entity in OSSVerse
Description
BAP submits a rating for an entity, such as an OASP, a service package, or a specific fulfillment.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"rating": {
"rating_category": "Item",
"id": "string",
"value": "string"
}
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"rating"
]
}
},
"required": [
"action"
]
}
]
},
"message": {
"type": "object",
"required": [
"rating"
],
"properties": {
"rating": {
"$ref": "#/components/schemas/Rating"
}
}
}
}
}
Response 200 OK
{
"status": "ACK",
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
Schema of the response body
{
"description": "Describes the acknowledgement sent in response to an API call. If the implementation uses HTTP/S, then Ack must be returned in the same session. Every API call to a BPP must be responded to with an Ack whether the BPP intends to respond with a callback or not. This has one property called `status` that indicates the status of the Acknowledgement.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the acknowledgement. If the request passes the validation criteria of the BPP, then this is set to ACK. If a BPP responds with status = `ACK` to a request, it is required to respond with a callback. If the request fails the validation criteria, then this is set to NACK. Additionally, if a BPP does not intend to respond with a callback even after the request meets the validation criteria, it should set this value to `NACK`.",
"enum": [
"ACK",
"NACK"
]
},
"tags": {
"description": "A list of tags containing any additional information sent along with the Acknowledgement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TagGroup"
}
}
}
}
Other responses
{
"code": "string",
"paths": "string",
"message": "string"
}
Schema of the response body
{
"description": "Describes an error object that is returned by a BAP, BPP or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Standard error code. For full list of error codes, refer to docs/protocol-drafts/BECKN-005-ERROR-CODES-DRAFT-01.md of this repo\""
},
"paths": {
"type": "string",
"description": "Path to json schema generating the error. Used only during json schema validation errors"
},
"message": {
"type": "string",
"description": "Human readable message describing the error. Used mainly for logging. Not recommended to be shown to the user."
}
}
}
POST /support
Contact support
Description
BAP requests support or assistance.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"support": {
"ref_id": "string",
"callback_phone": "string",
"phone": "string",
"email": "derp@meme.org",
"url": "string"
}
}
}
Schema of the request body
{
"type": "object",
"required": [
"context",
"message"
],
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"support"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"support": {
"$ref": "#/components/schemas/Support"
}
}
}
}
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
Beckn Application Platform (BAP)
POST /on_search
Description
BPP responds to a search request with a catalog of relevant services and providers.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"catalog": {
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": "string",
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": null,
"price": {
"currency": "string",
"value": null,
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": null,
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "01e6b5cd-fd40-4624-bcc2-4d150ba01825"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_search"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"catalog": {
"$ref": "#/components/schemas/Catalog"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_select
Description
BPP sends a quote or order confirmation in response to a select request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "35bc1bab-0dd5-45b1-b049-8170cfa51b9f"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_select"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_update
Description
BPP responds to an update request, typically after a counter-offer or order modification.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "bcda21d2-bde7-4b96-8b99-efd9d7f2e3f3"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_update"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_init
Description
BPP confirms that the fulfillment process has been initiated for an order.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "f782863e-b2de-48e6-a186-5470953bb2ca"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_init"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_confirm
Description
BPP confirms that an order has been successfully created and confirmed.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "9be50ba9-81e4-4a9b-bc25-71f8fbb3d189"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_confirm"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_status
Description
BPP provides the updated status of an order in response to a status request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "1f2a4557-3b6e-4216-ae5b-896b5d51b1b3"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_status"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_subscribe
Description
BPP confirms or rejects a subscription request initiated by the buyer.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"subscription": {
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": null,
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "d3357f51-8123-4c1d-95b6-68332963aeff"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": null,
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"payment": null
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_subscribe"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"subscription": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_track
Description
BPP provides tracking information for an active order in response to a track request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"tracking": {
"id": "string",
"url": "string",
"location": null,
"status": "active"
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_track"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"tracking": {
"$ref": "#/components/schemas/Tracking"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_cancel
Description
BPP confirms the cancellation of an order or provides a reason why it could not be cancelled.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"order": {
"id": "string",
"ref_order_ids": [
"string"
],
"status": "ACTIVE",
"type": "DRAFT",
"provider": null,
"items": [
{
"id": "string",
"parent_item_id": null,
"parent_item_quantity": null,
"descriptor": null,
"creator": null,
"price": null,
"quantity": null,
"category_ids": [
null
],
"fulfillment_ids": [
null
],
"location_ids": [
null
],
"payment_ids": [
null
],
"add_ons": [
{
"id": "string",
"descriptor": {
"name": "string",
"code": "string",
"short_desc": "string",
"long_desc": "string",
"additional_desc": {
"url": "string",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "string",
"url": "string",
"signature": "string",
"dsa": "string"
}
],
"images": [
{
"url": "string",
"size_type": "xs",
"width": "string",
"height": "string"
}
]
},
"price": {
"currency": "string",
"value": "string",
"estimated_value": null,
"computed_value": null,
"listed_value": null,
"offered_value": null,
"minimum_value": null,
"maximum_value": null
},
"applicable_item_id": "string",
"service_type": {
"catalog_id": {
"descriptor": null,
"categories": [
{
"id": "string",
"parent_category_id": "string",
"descriptor": null,
"time": {
"label": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"duration": "string",
"range": {
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z"
},
"days": "string",
"schedule": {
"frequency": null,
"holidays": [
"2022-04-13T15:42:05.901Z"
],
"times": [
"2022-04-13T15:42:05.901Z"
]
}
},
"ttl": null,
"tags": [
{
"display": true,
"descriptor": null,
"list": [
{
"descriptor": null,
"value": "string",
"display": true
}
]
}
]
}
],
"fulfillments": [
{
"id": "string",
"type": "string",
"rateable": true,
"rating": null,
"state": null,
"tracking": true,
"customer": null,
"agent": null,
"contact": {
"phone": "string",
"email": "string",
"jcard": {}
},
"vehicle": {
"category": "string",
"capacity": 0,
"make": "string",
"model": "string",
"size": "string",
"variant": "string",
"color": "string",
"energy_type": "string",
"registration": "string",
"wheels_count": "string",
"cargo_volumne": "string",
"wheelchair_access": "string",
"code": "string",
"emission_standard": "string"
},
"stops": [
{
"id": "string",
"parent_stop_id": "string",
"location": null,
"type": "string",
"time": null,
"instructions": null,
"contact": null,
"person": null,
"authorization": {
"type": "string",
"token": "string",
"valid_from": "2022-04-13T15:42:05.901Z",
"valid_to": "2022-04-13T15:42:05.901Z",
"status": "string"
}
}
],
"path": "string",
"tags": null,
"start_time": "2022-04-13T15:42:05.901Z",
"end_time": "2022-04-13T15:42:05.901Z"
}
],
"payments": [
{
"id": "string",
"collected_by": null,
"url": "string",
"params": {
"transaction_id": "string",
"amount": "string",
"currency": "string",
"bank_code": "string",
"bank_account_number": "string",
"virtual_payment_address": "string",
"source_bank_code": "string",
"source_bank_account_number": "string",
"source_virtual_payment_address": "string"
},
"type": "PRE-ORDER",
"status": "PAID",
"time": null,
"tags": null
}
],
"offers": [
{
"id": "string",
"descriptor": null,
"location_ids": [
"string"
],
"category_ids": null,
"item_ids": [
"string"
],
"time": null,
"tags": null
}
],
"providers": [
{
"id": "string",
"descriptor": null,
"category_id": "string",
"rating": "string",
"time": null,
"categories": null,
"fulfillments": null,
"payments": null,
"locations": [
{
"id": "string",
"descriptor": null,
"map_url": "string",
"gps": null,
"address": null,
"city": null,
"district": "string",
"state": null,
"country": null,
"area_code": "string",
"circle": {
"gps": "string",
"radius": {
"type": "CONSTANT",
"value": null,
"estimated_value": null,
"computed_value": null,
"range": {
"min": null,
"max": null
},
"unit": "string"
}
},
"polygon": "string",
"3dspace": "string",
"rating": null
}
],
"offers": null,
"items": null,
"exp": "2022-04-13T15:42:05.901Z",
"rateable": true,
"subscription_plan_ids": [
"string"
],
"subscriptions": [
{
"id": "string",
"plan_id": "string",
"status": "active",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"renewal_date": "2022-04-13T15:42:05.901Z",
"add_ons": null,
"payment": null
}
],
"past_projects": [
{
"project_name": "string",
"assessment_type": "string",
"date": "2022-04-13T15:42:05.901Z",
"deliverables": [
{
"id": "string",
"summary": "string",
"date_achieved": "2022-04-13T15:42:05.901Z",
"output_details": [
"string"
],
"evidences": [
{
"certificate_ref": "string",
"license_ref": "string",
"artifacts": [
{
"artifact_id": "string",
"artifact_type": "string",
"url": "string",
"tags": null
}
],
"attestation_authority": null,
"tags": null
}
],
"tags": null
}
],
"experience": {
"years": 0,
"technologies": [
"string"
]
},
"report_url": "string"
}
],
"licenses": [
{
"id": "string",
"issuer": "string",
"issue_date": "2022-04-13T15:42:05.901Z",
"validity_period": null,
"scope": {
"categories": [
"string"
],
"project_types": [
"string"
],
"assurance_levels": [
0
]
},
"terms_and_conditions": "string",
"status": "active",
"tags": null
}
],
"expertise": [
"string"
],
"service_level_agreements": [
{
"name": "string",
"details": "string"
}
],
"overall_experience": {
"years": 0,
"technologies": [
"string"
]
},
"ttl": 0,
"tags": null
}
],
"exp": "2022-04-13T15:42:05.901Z",
"ttl": "string"
},
"category_id": null
},
"billing_type": "subscription_linked",
"unit": "string"
}
],
"cancellation_terms": [
{
"fulfillment_state": null,
"reason_required": true,
"cancel_by": null,
"cancellation_fee": {
"percentage": null,
"amount": null
},
"xinput": {
"form": {
"url": "string",
"data": {},
"mime_type": "text/html",
"submission_id": "891047dd-1fdf-46ef-9733-4a65d69b78ee"
},
"required": true
},
"external_ref": null
}
],
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": [
{
"fulfillment_state": null,
"replace_within": null,
"external_ref": null
}
],
"return_terms": [
{
"fulfillment_state": null,
"return_eligible": true,
"return_time": null,
"return_location": null,
"fulfillment_managed_by": "CONSUMER"
}
],
"xinput": null,
"time": null,
"rateable": true,
"rating": null,
"matched": true,
"related": true,
"recommended": true,
"ttl": "string",
"tags": null
}
],
"add_ons": null,
"offers": null,
"billing": null,
"fulfillments": null,
"cancellation": null,
"cancellation_terms": null,
"refund_terms": [
{
"fulfillment_state": null,
"refund_eligible": true,
"refund_within": null,
"refund_amount": null
}
],
"replacement_terms": null,
"return_terms": null,
"quote": null,
"payments": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"xinput": null,
"tags": null,
"sla_id": "string",
"subscription_id": "string"
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_cancel"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_rating
Description
BPP acknowledges the receipt of a rating or provides feedback on the rating process.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"feedback_form": null
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_rating"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"feedback_form": {
"description": "A feedback form to allow the user to provide additional information on the rating provided",
"allOf": [
{
"$ref": "#/components/schemas/XInput"
}
]
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
POST /on_support
Description
BPP responds to a support request, providing contact information or initiating a support process.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
SubscriberAuth |
header | string | N/A | No | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |
Request body
{
"context": null,
"message": {
"support": {
"ref_id": "string",
"callback_phone": "string",
"phone": "string",
"email": "derp@meme.org",
"url": "string"
}
},
"error": {
"code": "string",
"paths": "string",
"message": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Context"
},
{
"properties": {
"action": {
"enum": [
"on_support"
]
}
}
}
]
},
"message": {
"type": "object",
"properties": {
"support": {
"$ref": "#/components/schemas/Support"
}
}
},
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"context"
]
}
Other responses
Refer to the common response description: #/paths/~1init/post/responses/default.
Schemas
Ack
| Name | Type |
|---|---|
status |
string |
tags |
Array<TagGroup> |
AddOn
| Name | Type |
|---|---|
applicable_item_id |
string |
billing_type |
string |
descriptor |
Descriptor |
id |
string |
price |
Price |
service_type |
Properties: catalog_id, category_id |
unit |
string |
Address
Type: string
Agent
Type:
Artifact
| Name | Type |
|---|---|
artifact_id |
string |
artifact_type |
string |
tags |
Array<TagGroup> |
url |
string |
Authorization
| Name | Type |
|---|---|
status |
string |
token |
string |
type |
string |
valid_from |
string(date-time) |
valid_to |
string(date-time) |
Billing
| Name | Type |
|---|---|
address |
|
city |
|
email |
string(email) |
name |
string |
organization |
|
phone |
string |
state |
|
tax_id |
string |
time |
Cancellation
| Name | Type |
|---|---|
additional_description |
|
cancelled_by |
string |
reason |
|
time |
string(date-time) |
CancellationTerm
| Name | Type |
|---|---|
cancel_by |
|
cancellation_fee |
Fee |
external_ref |
MediaFile |
fulfillment_state |
|
reason_required |
boolean |
xinput |
XInput |
Catalog
| Name | Type |
|---|---|
categories |
Array<Category> |
descriptor |
Descriptor |
exp |
string(date-time) |
fulfillments |
Array<Fulfillment> |
offers |
Array<Offer> |
payments |
Array<Payment> |
providers |
Array<Provider> |
ttl |
string |
Category
| Name | Type |
|---|---|
descriptor |
Descriptor |
id |
string |
parent_category_id |
Category/properties/id |
tags |
Array<TagGroup> |
time |
Time |
ttl |
Certificate
| Name | Type |
|---|---|
date_awarded |
string(date-time) |
details |
string |
id |
string |
issued_by |
string |
tags |
Array<TagGroup> |
type |
string |
valid_until |
string(date-time) |
Circle
| Name | Type |
|---|---|
gps |
Gps |
radius |
Scalar |
City
| Name | Type |
|---|---|
code |
string |
name |
string |
Contact
| Name | Type |
|---|---|
email |
string |
jcard |
|
phone |
string |
Context
| Name | Type |
|---|---|
action |
string |
assurance_level |
integer |
bap_id |
|
bap_uri |
|
bpp_id |
|
bpp_uri |
|
domain |
|
key |
string |
location |
|
message_id |
string(uuid) |
timestamp |
string(date-time) |
transaction_id |
string(uuid) |
ttl |
string |
version |
string |
Country
| Name | Type |
|---|---|
code |
string |
name |
string |
Credential
| Name | Type |
|---|---|
id |
string |
type |
string |
url |
string(uri) |
Customer
| Name | Type |
|---|---|
contact |
Contact |
person |
Person |
DecimalValue
Type: string
Deliverable
| Name | Type |
|---|---|
date_achieved |
string(date-time) |
evidences |
Array<Evidence> |
id |
string |
output_details |
Array<string> |
summary |
string |
tags |
Array<TagGroup> |
Descriptor
| Name | Type |
|---|---|
additional_desc |
Properties: url, content_type |
code |
string |
images |
Array<Image> |
long_desc |
string |
media |
Array<MediaFile> |
name |
string |
short_desc |
string |
Domain
| Name | Type |
|---|---|
additional_info |
|
code |
|
name |
string |
Duration
Type: string
Error
| Name | Type |
|---|---|
code |
string |
message |
string |
paths |
string |
Evidence
| Name | Type |
|---|---|
artifacts |
Array<Artifact> |
attestation_authority |
Provider |
certificate_ref |
string |
license_ref |
string |
tags |
Array<TagGroup> |
Fee
| Name | Type |
|---|---|
amount |
|
percentage |
Form
| Name | Type |
|---|---|
data |
|
mime_type |
string |
submission_id |
string(uuid) |
url |
string(uri) |
Fulfillment
| Name | Type |
|---|---|
agent |
|
contact |
Contact |
customer |
|
end_time |
string(date-time) |
id |
string |
path |
string |
rateable |
boolean |
rating |
|
start_time |
string(date-time) |
state |
|
stops |
Array<Stop> |
tags |
Array<TagGroup> |
tracking |
boolean |
type |
string |
vehicle |
Vehicle |
FulfillmentState
| Name | Type |
|---|---|
descriptor |
Descriptor |
updated_at |
string(date-time) |
updated_by |
string |
Gps
Type: string
Image
| Name | Type |
|---|---|
height |
string |
size_type |
string |
url |
string(uri) |
width |
string |
Intent
| Name | Type |
|---|---|
category |
|
descriptor |
|
fulfillment |
|
item |
|
offer |
|
payment |
|
provider |
|
sla |
|
tags |
Array<TagGroup> |
Item
| Name | Type |
|---|---|
add_ons |
Array<AddOn> |
cancellation_terms |
Array<CancellationTerm> |
category_ids |
Array<> |
creator |
|
descriptor |
|
fulfillment_ids |
Array<> |
id |
string |
location_ids |
Array<> |
matched |
boolean |
parent_item_id |
|
parent_item_quantity |
|
payment_ids |
Array<> |
price |
|
quantity |
|
rateable |
boolean |
rating |
|
recommended |
boolean |
refund_terms |
Array<Properties: fulfillment_state, refund_eligible, refund_within, refund_amount> |
related |
boolean |
replacement_terms |
Array<ReplacementTerm> |
return_terms |
Array<ReturnTerm> |
tags |
Array<TagGroup> |
time |
|
ttl |
string |
xinput |
ItemQuantity
| Name | Type |
|---|---|
allocated |
Properties: count, measure |
available |
Properties: count, measure |
maximum |
Properties: count, measure |
minimum |
Properties: count, measure |
selected |
Properties: count, measure |
unitized |
Properties: count, measure |
License
| Name | Type |
|---|---|
id |
string |
issue_date |
string(date-time) |
issuer |
string |
scope |
Properties: categories, project_types, assurance_levels |
status |
string |
tags |
Array<TagGroup> |
terms_and_conditions |
string |
validity_period |
Duration |
Location
| Name | Type |
|---|---|
3dspace |
string |
address |
|
area_code |
string |
circle |
Circle |
city |
|
country |
|
descriptor |
Descriptor |
district |
string |
gps |
|
id |
string |
map_url |
string(uri) |
polygon |
string |
rating |
|
state |
MediaFile
| Name | Type |
|---|---|
dsa |
string |
mimetype |
string |
signature |
string |
url |
string(uri) |
Offer
| Name | Type |
|---|---|
category_ids |
Array<Category/properties/id> |
descriptor |
Descriptor |
id |
string |
item_ids |
Array<Item/properties/id> |
location_ids |
Array<Location/properties/id> |
tags |
Array<TagGroup> |
time |
Time |
Option
| Name | Type |
|---|---|
descriptor |
Descriptor |
id |
string |
Order
| Name | Type |
|---|---|
add_ons |
Array<AddOn> |
billing |
|
cancellation |
|
cancellation_terms |
Array<CancellationTerm> |
created_at |
string(date-time) |
fulfillments |
Array<Fulfillment> |
id |
string |
items |
Array<Item> |
offers |
Array<Offer> |
payments |
Array<Payment> |
provider |
|
quote |
|
ref_order_ids |
Array<string> |
refund_terms |
Array<Item/properties/refund_terms/items> |
replacement_terms |
Array<ReplacementTerm> |
return_terms |
Array<ReturnTerm> |
sla_id |
string |
status |
string |
subscription_id |
string |
tags |
Array<TagGroup> |
type |
string |
updated_at |
string(date-time) |
xinput |
Organization
| Name | Type |
|---|---|
address |
|
city |
|
contact |
Contact |
descriptor |
Descriptor |
state |
Payment
| Name | Type |
|---|---|
collected_by |
|
id |
string |
params |
Properties: transaction_id, amount, currency, bank_code, bank_account_number, virtual_payment_address, source_bank_code, source_bank_account_number, source_virtual_payment_address |
status |
string |
tags |
Array<TagGroup> |
time |
Time |
type |
string |
url |
string(uri) |
Person
| Name | Type |
|---|---|
age |
|
creds |
Array<Credential> |
dob |
string(date) |
gender |
string |
id |
string |
image |
Image |
languages |
Array<Properties: code, name> |
name |
string |
skills |
Array<Properties: code, name> |
tags |
Array<TagGroup> |
url |
string(uri) |
Price
| Name | Type |
|---|---|
computed_value |
DecimalValue |
currency |
string |
estimated_value |
DecimalValue |
listed_value |
DecimalValue |
maximum_value |
DecimalValue |
minimum_value |
DecimalValue |
offered_value |
DecimalValue |
value |
DecimalValue |
Provider
| Name | Type |
|---|---|
categories |
Array<Category> |
category_id |
string |
descriptor |
Descriptor |
exp |
string(date-time) |
expertise |
Array<string> |
fulfillments |
Array<Fulfillment> |
id |
string |
items |
Array<Item> |
licenses |
Array<License> |
locations |
Array<Location> |
offers |
Array<Offer> |
overall_experience |
Properties: years, technologies |
past_projects |
Array<Properties: project_name, assessment_type, date, deliverables, experience, report_url> |
payments |
Array<Payment> |
rateable |
boolean |
rating |
Rating/properties/value |
service_level_agreements |
Array<Properties: name, details> |
subscription_plan_ids |
Array<string> |
subscriptions |
Array<Subscription> |
tags |
Array<TagGroup> |
time |
Time |
ttl |
integer |
Quotation
| Name | Type |
|---|---|
breakup |
Array<Properties: item, title, price> |
id |
string(uuid) |
is_negotiable |
boolean |
price |
|
state |
string |
ttl |
Duration |
version |
integer |
Rating
| Name | Type |
|---|---|
id |
string |
rating_category |
string |
value |
string |
Region
| Name | Type |
|---|---|
boundary |
string |
code |
string |
dimensions |
string |
map_url |
string |
name |
string |
type |
string |
ReplacementTerm
| Name | Type |
|---|---|
external_ref |
MediaFile |
fulfillment_state |
|
replace_within |
ReturnTerm
| Name | Type |
|---|---|
fulfillment_managed_by |
string |
fulfillment_state |
|
return_eligible |
boolean |
return_location |
|
return_time |
Scalar
| Name | Type |
|---|---|
computed_value |
DecimalValue |
estimated_value |
DecimalValue |
range |
Properties: min, max |
type |
string |
unit |
string |
value |
DecimalValue |
Schedule
| Name | Type |
|---|---|
frequency |
Duration |
holidays |
Array<string(date-time)> |
times |
Array<string(date-time)> |
ServicePackage
| Name | Type |
|---|---|
add_on_id |
string |
assurance_level |
integer |
category_ids |
Array<string> |
descriptor |
Descriptor |
id |
string |
limit |
integer |
unit |
string |
usage |
integer |
SLA
| Name | Type |
|---|---|
communication_channels |
Array<Contact> |
completion_time |
string(duration) |
escalation_procedure |
Array<Properties: step, contact> |
id |
string |
reporting |
string |
response_commitment |
string |
response_time |
string(duration) |
State
| Name | Type |
|---|---|
code |
string |
name |
string |
Stop
| Name | Type |
|---|---|
authorization |
Authorization |
contact |
|
id |
string |
instructions |
|
location |
|
parent_stop_id |
string |
person |
|
time |
|
type |
string |
Subscription
| Name | Type |
|---|---|
add_ons |
Array<AddOn> |
end_date |
string(date-time) |
id |
string |
payment |
Payment |
plan_id |
string |
renewal_date |
string(date-time) |
start_date |
string(date-time) |
status |
string |
SubscriptionPlan
| Name | Type |
|---|---|
add_ons |
Array<AddOn> |
billing_period |
string |
descriptor |
Descriptor |
id |
string |
price |
Price |
service_packages |
Array<ServicePackage> |
Support
| Name | Type |
|---|---|
callback_phone |
string(phone) |
email |
string(email) |
phone |
string(phone) |
ref_id |
string |
url |
string(uri) |
Tag
| Name | Type |
|---|---|
descriptor |
|
display |
boolean |
value |
string |
TagGroup
| Name | Type |
|---|---|
descriptor |
|
display |
boolean |
list |
Array<Tag> |
Time
| Name | Type |
|---|---|
days |
string |
duration |
Duration |
label |
string |
range |
Properties: start, end |
schedule |
Schedule |
timestamp |
string(date-time) |
Tracking
| Name | Type |
|---|---|
id |
string |
location |
|
status |
string |
url |
string(uri) |
Vehicle
| Name | Type |
|---|---|
capacity |
integer |
cargo_volumne |
string |
category |
string |
code |
string |
color |
string |
emission_standard |
string |
energy_type |
string |
make |
string |
model |
string |
registration |
string |
size |
string |
variant |
string |
wheelchair_access |
string |
wheels_count |
string |
XInput
| Name | Type |
|---|---|
form |
Form |
required |
boolean |
Security schemes
| Name | Type | Scheme | Description |
|---|---|---|---|
| SubscriberAuth | apiKey | Signature of message body using BAP or BPP subscriber's signing public key. Format: Authorization : Signature keyId="{subscriber_id}|{unique_key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)" |