From 7b4fe493261b4876e917dfe56f2627263e341a97 Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Wed, 14 Aug 2024 12:40:58 +0200 Subject: [PATCH 1/2] Update User Stories for Carrier Billing APIs - MetaRelease Fall 24 --- .../Carrier Billing Refund User Story.md | 52 +++++++++++++++++++ .../Carrier Billing User Story.md | 30 +++++------ 2 files changed, 67 insertions(+), 15 deletions(-) create mode 100644 documentation/API_documentation/Carrier Billing Refund User Story.md diff --git a/documentation/API_documentation/Carrier Billing Refund User Story.md b/documentation/API_documentation/Carrier Billing Refund User Story.md new file mode 100644 index 0000000..05fc19f --- /dev/null +++ b/documentation/API_documentation/Carrier Billing Refund User Story.md @@ -0,0 +1,52 @@ +**User Story: Make a Payment Refund request in one step** +
+ +| **Item** | **Details** | +| ---- | ------- | +| ***Summary*** | As an application developer belonging to an enterprise, I want to request (using my application server/backend service) a payment refund (_total_: requesting whole payment amount or whole remaining payment amount not yet refunded, so as no more refunds can be requested; or _partial_: requesting a specific payment amount refund less than the overall amount related to the payment done, so as in principle more refunds can be requested, until performing a total refund or not having remaining payment amount to be refunded) to be billed against a customer's carrier bill. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User
**Actors:** Application service providers, hyperscalers, application developers.
**Scope:** *Request Refund on Carrier Bill* \- Initiate Carrier Billing Refund process with Customer from Carrier Channels (SMS/App) | +| ***Pre-conditions*** |The preconditions are listed below:
  1. The Customer:User has Carrier Billing activated as payment method.
  2. The Customer:User has initiated Refund via Carrier Billing from application/portal/product channel
  3. The RefundRequester has verified that associated carrier billing service belongs to the Customer:User (Generally as part of adding a new payment method, 2-Factor-Authorization or equivalent)
| +| ***Activities/Steps*** | **Starts when:** The customer application server makes a request to the Carrier Billing Refund service (API) to trigger the refund.
**Ends when:** The refund is completed and the customer application customer can query details of that refund.
| +| ***Post-conditions*** | After customer application server performs the refund, refund details can be queried. | +| ***Exceptions*** | Several exceptions might occur during the Carrier Billing Refund API operations:
| + + +**User Story: Retrieve a Payment Refund from its identifier** +
+ +| **Item** | **Details** | +| ---- | ------- | +| ***Summary*** | As an application developer belonging to an enterprise, I want to get details of one performed refund (from its id) by means of that application. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User
**Actors:** Application service providers, hyperscalers, application developers.
**Scope:** *Request Refund Details done against Carrier Billing* | +| ***Pre-conditions*** |The preconditions are listed below:
  1. The Customer:User has performed refunds via application, both success and failed
  2. The Customer:User has payment identification and refund identification.
| +| ***Activities/Steps*** | **Starts when:** The customer application server makes a request to the Carrier Billing Refund service (API) to get refund details performed via that application providing payment identifier and refund identifier.
**Ends when:** Response is received from Carrier Billing Refund service showing the refund details | +| ***Post-conditions*** | Requester receives a complete representation of the refund. | +| ***Exceptions*** | Several exceptions might occur during the Carrier Billing Refund API operations:
| + + +**User Story: Retrieve a Payment Refunds list** +
+ +| **Item** | **Details** | +| ---- | ------- | +| ***Summary*** | As an application developer belonging to an enterprise, I want to get a list of performed refunds from criteria (using my application server/backend service), by means of that application. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User
**Actors:** Application service providers, hyperscalers, application developers.
**Scope:** *Request Refunds list done against Carrier Billing* | +| ***Pre-conditions*** |The preconditions are listed below:
  1. The Customer:User has performed refunds via application, both success and failed
  2. The requester provides a list of criteria(s) to select refund (Customer/user identifier, refund status)
| +| ***Activities/Steps*** | **Starts when:** The customer application server makes a request to the Carrier Billing Refund service (API) to get refund/refunds details performed via that application
**Ends when:** Response is received from Carrier Billing Refund service showing the details | +| ***Post-conditions*** | N/A | +| ***Exceptions*** | Several exceptions might occur during the Carrier Billing Refund API operations:
| + + +**User Story: Retrieve a Payment Amount Not Refunded yet** +
+ +| **Item** | **Details** | +| ---- | ------- | +| ***Summary*** | As an application developer belonging to an enterprise, I want to get the remaining amount not yet refunded for a given payment (using my application server/backend service), by means of that application. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User
**Actors:** Application service providers, hyperscalers, application developers.
**Scope:** *Request Remaining Amount not yet refunded done against Carrier Billing* | +| ***Pre-conditions*** |The preconditions are listed below:
  1. The Customer:User has performed refunds via application, both success and failed
  2. The requester provides payment identification
| +| ***Activities/Steps*** | **Starts when:** The customer application server makes a request to the Carrier Billing Refund service (API) to get the remaining amount not yet refunded for a given paymentId performed via that application
**Ends when:** Response is received from Carrier Billing Refund service showing the remaining amount not yet refunded | +| ***Post-conditions*** | N/A | +| ***Exceptions*** | Several exceptions might occur during the Carrier Billing Refund API operations: