docs: Updates to credit account payment sequences (#1290)

common/payment/Credit Accounts/Create New Credit Account Sequence.md

@@ -1,7 +1,3 @@
-# Sequence to create a new credit account in onRouteBC
-Note that this is used for clients who do not have a pre-existing credit account in TPS.
-
-```mermaid
 sequenceDiagram
     participant PPC
     participant onRouteBC
@@ -23,8 +19,12 @@ sequenceDiagram
         note over CFS, onRouteBC: Assuming success for all transactions.<br/>If any failures, these will result in failure<br/>message being returned to PPC.
         onRouteBC->>onRouteBC: Save credit account details to DB
         onRouteBC->>CFS: Create site for account
+        note over onRouteBC,CFS: Supply physical site address
         CFS-->>onRouteBC: Return CFS site number
         onRouteBC->>onRouteBC: Save site number to DB
+        onRouteBC->>CFS: Create contact for site
+        note over onRouteBC,CFS: Supply name, phone, and email
+        CFS-->>onRouteBC: Return CFS contact number        
+        onRouteBC->>onRouteBC: Save contact number to DB
         onRouteBC-->>PPC: Return success message<br/>with credit account number
-    end
-```
+    end

common/payment/Credit Accounts/Pay Credit Account Cheque Sequence.md

@@ -1,5 +1,24 @@
 # Sequence to make a payment against a credit account via cheque
 
 ```mermaid
-
+sequenceDiagram
+    participant cvc as CV Client
+    participant PPC
+    participant onRouteBC
+    participant CFS
+    cvc->>PPC: Provice cheque to PPC
+    note over cvc,PPC: Can send via physical mail<br/>or in person at permit centre
+    PPC->>onRouteBC: Find client by client<br/>number
+    onRouteBC-->>PPC: Show client page
+    PPC->>onRouteBC: Record payment
+    note over PPC,onRouteBC: TBD what interface will look<br/>like, but will include a form<br/>to supply amount and payment<br/>method.
+    alt CFS is unavailable
+        onRouteBC->>onRouteBC: Save payment details<br/>including cheque number<br/>and amount to DB<br/>for later processing
+    else CFS is available
+        onRouteBC->>CFS: Create receipt
+        note over onRouteBC,CFS: TBD whether the receipt will<br/>need to be explicitly applied to<br/>outstanding invoices or if it can<br/>just be left on file.
+        CFS-->>onRouteBC: Return receipt number
+        onRouteBC->>onRouteBC: Record receipt number in DB
+        onRouteBC-->>PPC: Return success message
+    end
 ```

common/payment/Credit Accounts/Pay Credit Account EFT Sequence.md

@@ -1,5 +1,37 @@
 # Sequence to make a payment against a credit account via EFT/Wire Transfer
 
 ```mermaid
-
+sequenceDiagram
+    participant cvc as CV Client
+    participant cbank as Client Bank
+    participant mbank as MoTI Bank
+    participant pt as Provincial Treasury
+    participant PPC
+    participant onRouteBC
+    participant CFS
+    cvc->>cbank: Initiate EFT/Wire Transfer
+    cbank->>mbank: Transfer funds
+    mbank-->>cbank: Success message
+    cbank-->>cvc: Success message
+    note over cvc,mbank: This process may take several days to process
+    pt->>mbank: Retrieve transactions
+    mbank-->>pt: Send transaction list
+    note over mbank,pt: The transaction list is requested<br/>daily by PT
+    pt->>PPC: Email transaction list
+    note over pt,PPC: The email is the trigger for<br/>PPC to initiate recording payment
+    loop For each transaction
+        PPC->>onRouteBC: Find client by client<br/>number
+        onRouteBC-->>PPC: Show client page
+        PPC->>onRouteBC: Record payment
+        note over PPC,onRouteBC: TBD what interface will look<br/>like, but will include a form<br/>to supply amount and payment<br/>method.
+        alt CFS is unavailable
+            onRouteBC->>onRouteBC: Save payment details<br/>including transaction id<br/>and amount to DB<br/>for later processing
+        else CFS is available
+            onRouteBC->>CFS: Create receipt
+            note over onRouteBC,CFS: TBD whether the receipt will<br/>need to be explicitly applied to<br/>outstanding invoices or if it can<br/>just be left on file.
+            CFS-->>onRouteBC: Return receipt number
+            onRouteBC->>onRouteBC: Record receipt number in DB
+            onRouteBC-->>PPC: Return success message
+        end
+    end
 ```

common/payment/Credit Accounts/Pay Credit Account Online Banking Sequence.md

@@ -1,5 +1,22 @@
 # Sequence to make a payment against a credit account via online banking bill payment
 
 ```mermaid
-
+sequenceDiagram
+    participant cvc as CV Client
+    participant cbank as Client Bank
+    participant rbank as Royal Bank
+    participant mbank as MoTI Bank
+    participant CFS
+    cvc->>cbank: Initiate online bill payment
+    cbank->>rbank: Transfer funds
+    note over cbank,rbank: Royal Bank is the broker for<br/>all online bill payments in<br/>Canada.
+    rbank->>mbank: Send funds
+    note over cvc,mbank: This process may take several days to process
+    CFS->>rbank: Request online bill payment transactions
+    note over CFS,rbank: This is provided as an FTP file, but should<br/>not matter to onRouteBC
+    rbank-->>CFS: Return transaction list
+    loop For each transaction
+        CFS->>CFS: Record receipt on account
+    end
+    note over cvc,CFS: The entire bill payment process is transparent to <br/>onRouteBC and happens automatically each day
 ```

common/payment/Credit Accounts/Pay Credit Account PayBC Sequence.md

@@ -1,5 +1,7 @@
 # Sequence to make a payment against a credit account via PayBC / Credit Card
 
+This sequence is TBD. Though paying credit accounts through PayBC has been discussed as a possible requirement no discovery has been done on it.
+
 ```mermaid
 
 ```