From 85a008a0a6c619a6521dd2a759ae4c161fbffcfc Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Wed, 19 Jun 2024 12:34:39 +0200 Subject: [PATCH] description_enhancements_based_on_Ludovic_14_JUN_review --- code/API_definitions/carrier_billing.yaml | 6 ++++-- code/API_definitions/carrier_billing_refund.yaml | 8 +++++--- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/code/API_definitions/carrier_billing.yaml b/code/API_definitions/carrier_billing.yaml index 0530359..d971ab0 100644 --- a/code/API_definitions/carrier_billing.yaml +++ b/code/API_definitions/carrier_billing.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: description: |- - Service Enabling Payments against OB Carrier Billing Systems + Service Enabling Payments against Operator Carrier Billing Systems # Introduction @@ -99,7 +99,9 @@ info: # Authorization and authentication - CAMARA guidelines defines a set of authorization flows which can grant API clients access to the API functionality, as outlined in the document [CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md). Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. + [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token. + + Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. diff --git a/code/API_definitions/carrier_billing_refund.yaml b/code/API_definitions/carrier_billing_refund.yaml index 66647f6..a4cae99 100644 --- a/code/API_definitions/carrier_billing_refund.yaml +++ b/code/API_definitions/carrier_billing_refund.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: description: |- - Service Enabling Refunds against OB Carrier Billing Systems + Service Enabling Refunds against Operator Carrier Billing Systems # Introduction @@ -27,7 +27,7 @@ info: - An endpoint to request a refund, named `createRefund`. - A set of endpoints to retrieve information about a list of refunds or a specific refund (identified by its specific `refundId`), named `retrieveRefunds` and `retrieveRefund` respectively. - A callback endpoint where API Server can send notifications about a refund procedure, as defined within `createRefund` operation, towards the `sink` when provided by API client. - + - An endpoint to retrieve remaining amount on a payment taken into consideration processed refund, named `retrievePaymentRemainingAmount`. State transitions: @@ -43,7 +43,9 @@ info: # Authorization and authentication - CAMARA guidelines defines a set of authorization flows which can grant API clients access to the API functionality, as outlined in the document [CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md). Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. + [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token. + + Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.