Payments BB APIs and Diagrams

Payments/Diagrams/Bulk Payment BB - Payment Gateway in the bulk payment use cases.txt

@@ -0,0 +1,17 @@
+title Bulk Payment BB - Payment Gateway in the bulk payment use cases
+note right of Beneficiary System: CompileList
+Beneficiary System->Bulk payment: transmit w timing
+Bulk payment->ALS: lookup alias
+ALS->FSP: Validate Account
+FSP->ALS: Return status
+ALS->Bulk payment: Return Lookup Status
+note right of Bulk payment: validate
+FSP->Payment Gateway: Qoute Fee
+note right of Bulk payment: Batch
+Bulk payment->Payment Gateway: Send Batch
+Payment Gateway->FSP: Make PAyments
+FSP->Beneficiary: Get Notifcation
+Beneficiary->FSP: Request
+FSP->Channels: Funds move
+Channels->Beneficiary System: Success
+note right of Bulk payment: Recocile

Payments/Diagrams/P2G Mobile Money Payment with QR code -2.txt

@@ -0,0 +1,27 @@
+title P2G Mobile Money Payment with QR code
+
+Registration BB->Payments BB: Send Transaction details
+Payments BB --> Registration BB: Generates payment reference
+
+Registration BB -> Registration BB: Generate QR code
+
+Registration BB -> Payer: QR code is reads Payment reference
+Payer --> FSP: Invoke Bill Payment service
+
+FSP -> FSP: Debit Payer
+
+FSP -> FSP: Credit Gov
+
+FSP -> Payments BB: Payment notification
+Payments BB --> FSP: Confirm payment
+
+Payments BB --> Registration BB: Payment success notification
+Registration BB --> Payer: Payment success notification
+
+alt Error 401: Incorrect Payment Reference
+    FSP -> FSP: Rollback Payer Debit
+    FSP -> FSP: Rollback Gov Credit
+    FSP --> Payments BB: Rollback successful
+    Payments BB --> Registration BB: Payment failure notification
+    Registration BB --> Payer: Payment failure notification    
+end

Payments/Diagrams/P2G Mobile Money Payment with QR code.txt

@@ -0,0 +1,27 @@
+title P2G Mobile Money Payment with QR code
+
+Registration BB->Payments BB: Send Transaction details
+Payments BB --> Registration BB: Generates payment reference
+
+Registration BB -> Registration BB: Generate QR code
+
+Registration BB -> Payer: QR code is reads Payment reference
+Payer --> FSP: Invoke Bill Payment service
+
+FSP -> FSP: Debit Payer
+
+FSP -> FSP: Credit Gov
+
+FSP -> Payments BB: Payment notification
+Payments BB --> FSP: Confirm payment
+
+Payments BB --> Registration BB: Payment success notification
+Registration BB --> Payer: Payment success notification
+
+alt Error 401: Incorrect Payment Reference
+    FSP -> FSP: Rollback Payer Debit
+    FSP -> FSP: Rollback Gov Credit
+    FSP --> Payments BB: Rollback successful
+    Payments BB --> Registration BB: Payment failure notification
+    Registration BB --> Payer: Payment failure notification    
+end

Payments/Diagrams/Voucher Activation v3.txt

@@ -0,0 +1,34 @@
+title Voucher Activation v3
+
+Source BB->Payment BB: Activate voucher
+Payment BB-->Source BB: Voucher successfully Activated
+
+alt Error 400
+    Payment BB-->Source BB: Invalid request
+end
+
+alt Error 456
+    Payment BB-->Source BB: Invalid voucher serial number
+end
+
+alt Error 460
+    Payment BB-->Source BB: Gov Stack Building Block does not exist
+end
+
+alt Error 455
+    Payment BB-->Source BB: Voucher group exhausted
+end
+
+alt Error 500
+    Payment BB-->Source BB: Internal Server error
+end
+
+alt Error 503
+    Payment BB-->Source BB: Service Unavailable
+end
+
+alt Error 599
+    Payment BB-->Source BB: Network connection timeout error
+end
+
+

Payments/Diagrams/Voucher Cancellation v3.txt

@@ -0,0 +1,20 @@
+title Voucher Cancellation v3
+
+Source BB -> Payment BB: Cancel Voucher
+Payment BB-->Source BB: Voucher Cancelled
+
+alt Error 499
+    Payment BB-->Source BB: Invalid Request
+end
+
+alt Error 463
+    Payment BB-->Source BB: Invalid Voucher
+end
+
+alt Error 464
+    Payment BB-->Source BB: Voucher is already cancelled
+end
+
+alt Error 599
+    Payment BB-->Source BB: Network connection timeout error
+end

Payments/Diagrams/Voucher Pre-activation v3.txt

@@ -0,0 +1,46 @@
+title Voucher Pre-activation v3
+
+Source BB->Payment BB: Pre-activate voucher
+Payment BB-->Source BB: Voucher successfully pre-activated
+
+alt Error 400
+    Payment BB-->Source BB: Invalid request
+end
+
+alt Error 452
+    Payment BB-->Source BB: Invalid amount
+end
+
+alt Error 453
+    Payment BB-->Source BB: Invalid currency
+end
+
+alt Error 454
+    Payment BB-->Source BB: Invalid voucher group
+end
+
+alt Error 455
+    Payment BB-->Source BB: Voucher group exhausted
+end
+
+alt Error 460
+    Payment BB-->Source BB: Gov Stack Building Block does not exist
+end
+
+alt Error 455
+    Payment BB-->Source BB: Voucher group exhausted
+end
+
+alt Error 500
+    Payment BB-->Source BB: Internal Server error
+end
+
+alt Error 503
+    Payment BB-->Source BB: Service Unavailable
+end
+
+alt Error 599
+    Payment BB-->Source BB: Network connection timeout error
+end
+
+

Payments/Diagrams/Voucher Redemption v3.txt

@@ -0,0 +1,48 @@
+title Voucher Redemption v3
+
+Source BB (Merchant Interface) -> Merchant registry: Submit voucher details
+Merchant registry --> Source BB (Merchant Interface): Merchant name and payment details
+Source BB (Merchant Interface) -> Payment BB: Submit voucher and merchant details
+
+alt Error 400
+    Payment BB-->Source BB (Merchant Interface): Invalid request
+end
+
+Payment BB -> Payment BB: Check Voucher
+
+alt Error 458
+    Payment BB-->Source BB (Merchant Interface): Voucher number already used
+end
+
+alt Error 461
+    Payment BB-->Source BB (Merchant Interface): Invalid voucher number
+end
+
+Payment BB->FSP: Debit request
+
+alt Error 599
+    Payment BB-->Source BB (Merchant Interface): Network connection error
+end
+
+FSP->Funding A/c: Debit request
+Funding A/c --> FSP: Debit successful
+
+alt Error 462
+    FSP --> Payment BB: Insufficient funds
+    Payment BB --> Source BB (Merchant Interface): Insufficient funds
+end
+
+FSP->Merchant A/c: Credit Request
+Merchant A/c --> FSP: Credit Request successful
+
+alt Error 463
+    FSP --> Payment BB: Cannot credit merchant
+    Payment BB --> Source BB (Merchant Interface): Cannot credit merchant
+end
+
+Payment BB -> Payment BB: Consume Voucher
+Payment BB -> Source BB (Merchant Interface): Amount credited to merchant account and voucher is consumed
+
+
+
+

Payments/Diagrams/Voucher Status Check v3.txt

@@ -0,0 +1,26 @@
+
+title Voucher Status Check v3
+
+Source BB -> Payment BB: Voucher Status Check
+Payment BB-->Source BB: Voucher Status
+
+alt Error 400
+    Payment BB-->Source BB: Invalid Request
+end
+
+alt Error 456
+    Payment BB-->Source BB: Invalid Voucher Serial number
+end
+
+alt Error 500
+    Payment BB-->Source BB: Internal server error
+end
+
+alt Error 503
+    Payment BB-->Source BB: Service unavailable
+end
+
+alt Error 599
+    Payment BB-->Source BB: Network connection error
+end
+

Payments/Diagrams/Voucher management.txt

@@ -0,0 +1,11 @@
+title Voucher management
+
+Originatin BB->Voucher Issuing: 
+note left of Admin: Voucher provisioning
+note right of Voucher Issuing: Vocher printing
+Voucher Issuing-> Redemption: 
+note right of Redemption: Merchant Redemption
+note right of Redemption: Agent Cashout
+note left of Admin: Merchant/Agent Registration
+Admin->Redemption:
+