khushalps/api_utils_converse_v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(20241217) Payment callback ready for Safaricom M-Pesa Express.

Browse Source
This commit is contained in:
khushal
2024-12-17 13:27:15 +05:30
parent b6ba54abd4
commit 9de9542fda
12 changed files with 632 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/blueprints/finstitutions/payments/callback.py
+65 -15
View File
@@ -113,14 +113,14 @@ def init(blueprint_setup_state):
# ---------------------------------------------------------------------------------------------------------------------
@pg_callback_bp.route("/callback/<payment_id>", methods = ["POST"])
@pg_callback_bp.route("/callback/safaricom/mpesaexpress", methods = ["POST"])
@set_api_version(api_version = "1.0.0")
@read_input(sanitize_headers = False, sanitize_data = False)
@log_request_to_mongo(
attr_name = "logs_mongo",
project = constants.PROJECT_NAME,
log_type = constants.MODULE_NAME,
operation = "pgClbkApi",
operation = "pgSafaricomMPesaExpressClbkApi",
log_input = True,
log_output = True,
sensitive_keys = None
@@ -128,8 +128,7 @@ def init(blueprint_setup_state):
@log_chain_to_mongo(attr_name = "logs_mongo")
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
@handle_cancelled_request()
async def payment_event_callback(
payment_id: str = None,
async def safaricom_m_pesa_express_callback(
inbound_headers: dict = None,
inbound_data: dict = None,
inbound_files: dict = None,
@@ -138,7 +137,6 @@ async def payment_event_callback(
"""
We receive payment updates for various payment gateways here.
:param payment_id: The id of the document in MongoDB that holds the reference to the payment.
:param inbound_headers: auto-extracted by the decorators.
:param inbound_data: auto-extracted by the decorators.
:param inbound_files: auto-extracted by the decorators.
@@ -146,28 +144,80 @@ async def payment_event_callback(
:return: A standard response structure.
"""
# ┏┓ ┏┓ ┳ ┏
# ┃┓┏┓╋ ┃┃┏┓┓┏┏┳┓┏┓┏┓╋ ┃┏┓╋┏┓
# ┗┛┗ ┗ ┣┛┗┻┗┫┛┗┗┗ ┛┗┗ ┻┛┗┛┗┛
# ┛
# payment_info = await current_app.payment_controller.get_payment_internal(
# mongo_conn = current_app.data_mongo,
# payment_id = ObjectId(payment_id)
# )
# print("PAYMENT INFO:", json.to_string(payment_info.model_dump(), default=str))
# ┏┓ ┓ ┓ ┏┓
# ┣┫┏┫┏┫ ┣ ┓┏┏┓┏┓╋
# ┛┗┗┻┗┻ ┗┛┗┛┗ ┛┗┗
# Map out the documented codes provided by the payment gateway.
# URL: https://developer.safaricom.co.ke/APIs/MpesaExpressSimulate
code_map = {
0: {
"status": "settled",
"message": "Payment successful :)"
}, # ... Success
1037: {
"status": "failed",
"message": "The payment gateway could not reach your customer."
}, # ... DS Timeout. User could not be reached.
1025: {
"status": "failed",
"message": "There was a system error in the payment gateway (1025)."
}, # ... System error while trying to send the push request.
9999: {
"status": "failed",
"message": "There was a system error in the payment gateway (9999)."
}, # ... System error while trying to send the push request.
1032: {
"status": "rejected",
"message": "Your customer declined the payment request."
}, # ... Request Cancelled by the user.
1: {
"status": "failed",
"message": "Your customer has insufficient balance."
}, # ... The user has insufficient balance.
2001: {
"status": "failed",
"message": "The payment gateway says your credentials are invalid."
}, # ... Invalid credentials of the initiator.
1019: {
"status": "failed",
"message": "The transaction expired before your customer processed it."
}, # ... Transaction expired.
1001: {
"status": "failed",
"message": "Your customer is already in the middle of some transaction on the payment gateway."
}, # ... The payer is already making some transaction.
}
# Figure out which of the above codes is relevant to you:
pg_reference_id = inbound_data["Body"]["stkCallback"]["CheckoutRequestID"]
pg_result_code = int(inbound_data["Body"]["stkCallback"]["ResultCode"])
relevant_code = code_map.get(
pg_result_code,
{
"status": "unknown",
"message": f"Unknown code '{pg_result_code}' from the payment gateway."
}
)
# For now, we just insert the event into the record:
event_note_success = await current_app.payment_controller.add_event(
event_note_success = await current_app.payment_controller.add_event_by_client_reference_id(
mongo_conn = current_app.data_mongo,
payment_id = ObjectId(payment_id),
event = PaymentEvent(
paymentStatus = "unknown",
paymentStatus = relevant_code["status"],
message = relevant_code["message"],
initByPG = True,
httpCode = None,
headers = inbound_headers,
payload = inbound_data
)
),
client_reference_id = pg_reference_id
)
# ┳┓
@@ -178,7 +228,7 @@ async def payment_event_callback(
# Done here:
return ResponseModel(
status_code = StatusCodes.OK if event_note_success else StatusCodes.FAILED,
http_code = HttpCodes.NOT_IMPLEMENTED
http_code = HttpCodes.SUCCESS if event_note_success else HttpCodes.INTERNAL_SERVER_ERROR
)
api/blueprints/finstitutions/payments/list.py
+212
View File
@@ -0,0 +1,212 @@
"""
AUTHOR:
Khushal P Soonderji
DATE:
Tuesday, 17th Dec., 2024
OBJECTIVE:
To list payment records that are already present in our database.
REFERENCES:
N/A
DOWNLOADS:
N/A
NOTES:
N/A
"""
# *****************************************************************************************************************
# ***** ****
# *** IMPORT ***
# ***** ****
# *****************************************************************************************************************
# To make sibling directories accessible for imports:
import sys
sys.path.append(".")
sys.path.append("..")
# For using Quart:
from quart import Blueprint, current_app, request
# My utils:
from utils_v2.string import json
from utils_v2.api.codes import StatusCodes, HttpCodes
from utils_v2.api.response import ResponseModel
from utils_v2.api.async_quart import (
set_api_version,
read_input,
get_session_info,
log_request_to_mongo,
log_chain_to_mongo,
should_not_be_under_maintenance,
only_whitelisted_ips,
limit_rate,
validate_input,
handle_cancelled_request
)
# Common:
from shared import constants
# To work with MongoDB:
from bson.objectid import ObjectId
# Data Models:
from models.api.finstitutions.payments.list import PGPaymentListHeaders, PGPaymentListData
from models.core.auth_token import CoreAuthTokenModel
from models.core.payment import CorePaymentModel, PaymentEvent
# For asynchronous activities:
import asyncio
# *****************************************************************************************************************
# ***** ****
# *** MACROS / ONE-TIME INIT ***
# ***** ****
# *****************************************************************************************************************
# Related to Quart:
pg_list_bp = Blueprint("pg_list", __name__)
# *****************************************************************************************************************
# ***** ****
# *** VARIABLES ***
# ***** ****
# *****************************************************************************************************************
# --- Nothing Yet
# *****************************************************************************************************************
# ***** ****
# *** FUNCTIONS ***
# ***** ****
# *****************************************************************************************************************
@pg_list_bp.record_once
def init(blueprint_setup_state):
# This gets called when the blueprint is registered.
# Consider this to be a one-time setup for the whole blueprint:
pass
# ---------------------------------------------------------------------------------------------------------------------
@pg_list_bp.route("/list", methods = ["GET"])
@set_api_version(api_version = "1.0.0")
@read_input(sanitize_headers = False, sanitize_data = False)
@get_session_info(key = "X-Session-Token", session_coro = "get_session")
@log_request_to_mongo(
attr_name = "logs_mongo",
project = constants.PROJECT_NAME,
log_type = constants.MODULE_NAME,
operation = "pgListApi",
log_input = True,
log_output = 1,
sensitive_keys = ["sessionToken", "X-Session-Token"]
)
@log_chain_to_mongo(attr_name = "logs_mongo")
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
@validate_input(
header_validator = lambda x: PGPaymentListHeaders(**x).model_dump(),
data_validator = lambda x: PGPaymentListData(**x)
)
@handle_cancelled_request()
async def payment_list(
inbound_headers: dict | PGPaymentListHeaders = None,
inbound_data: dict | PGPaymentListData = None,
inbound_files: dict = None,
**kwargs
):
"""
To filter and enlist payment records here.
:param inbound_headers: auto-extracted by the decorators.
:param inbound_data: auto-extracted by the decorators.
:param inbound_files: auto-extracted by the decorators.
:param kwargs: Any number of extra inputs supplied by the decorators.
:return: A standard response structure.
"""
# ┏┓ ┓ ┏┓┓ ┓
# ┣┫┓┏╋┣┓ ┃ ┣┓┏┓┏┃┏
# ┛┗┗┻┗┛┗ ┗┛┛┗┗ ┗┛┗
# If the session token is invalid/expired:
if kwargs.get("session_info") is None:
return ResponseModel(
status_code = StatusCodes.FAILED,
http_code = HttpCodes.UNAUTHORIZED,
message = "invalid session"
)
# ┏┓ ┓• ┳┳┓ •┓
# ┣ ┏┓┃┓┏╋ ┃┃┃┏┓┓┃┏
# ┗┛┛┗┗┗┛┗ ┛ ┗┗┻┗┗┛
# Get the token ids from the token keys:
auth_tokens = await current_app.payment_controller.get_tokens(
mongo_conn = current_app.data_mongo,
token_keys = inbound_data.tokenKeys
)
token_ids = [t.authTokenId for t in auth_tokens]
print("TOKEN IDS:", json.to_string(token_ids, default = str))
# Build the additional filter:
additional_filter = {}
if inbound_data.tags: additional_filter["tags"] = {"$in": inbound_data.tags}
if inbound_data.paymentStatus: additional_filter["lastPaymentStatus"] = {"$in": inbound_data.paymentStatus}
additional_filter = additional_filter or None
print("ADDFIL:", json.to_string(additional_filter))
# Get the mails:
payment_records = await current_app.payment_controller.list_payments(
mongo_conn = current_app.data_mongo,
token_ids = token_ids,
limit = inbound_data.count,
skip = inbound_data.fromCount,
additional_filter = additional_filter
)
# Done here:
return ResponseModel(
status_code = StatusCodes.OK if payment_records else StatusCodes.FAILED,
http_code = HttpCodes.SUCCESS if payment_records else HttpCodes.NOT_FOUND,
data = [record.preview for record in payment_records],
message = f"{len(payment_records) if payment_records else 0} records(s) found"
)
# *****************************************************************************************************************
# ***** ****
# *** MAIN PROGRAM ***
# ***** ****
# *****************************************************************************************************************
if __name__ == "__main__":
pass
api/blueprints/mail/retrieve/list.py
+1 -1
View File
@@ -172,7 +172,7 @@ async def list_mails(
return ResponseModel(
status_code = StatusCodes.FAILED,
http_code = HttpCodes.UNAUTHORIZED,
messge = "invalid session"
message = "invalid session"
)
# ┏┓ ┓• ┳┳┓ •┓