payhero 0.1.0__tar.gz

payhero-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PayHero and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

payhero-0.1.0/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: payhero
+Version: 0.1.0
+Summary: Official Python SDK for the PayHero Africa API — collect and disburse money across Africa.
+Author: PayHero
+License: MIT
+Project-URL: Homepage, https://payhero.africa
+Project-URL: Documentation, https://docs.payhero.africa
+Project-URL: Repository, https://github.com/PAY-HERO-CONSULTING/payhero-python-sdk
+Project-URL: Issues, https://github.com/PAY-HERO-CONSULTING/payhero-python-sdk/issues
+Project-URL: Changelog, https://github.com/PAY-HERO-CONSULTING/payhero-python-sdk/blob/main/CHANGELOG.md
+Keywords: payhero,payments,africa,mpesa,mobile-money,collections,payouts
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: responses>=0.23; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# payhero (Python SDK)
+
+Official Python SDK for the **PayHero Africa API** — collect and disburse
+money across Africa over a single unified API (mobile money, bank and card
+rails).
+
+```bash
+pip install payhero
+```
+
+## Getting started
+
+Generate an API key (username + password) on your PayHero dashboard.
+
+```python
+from payhero import (
+    Client,
+    Customer,
+    GlobalPaymentRequest,
+    PaymentConfig,
+    ProviderConfig,
+    REQUEST_TYPE_PAYMENT,
+    CHANNEL_MOMO,
+    VendorConfig,
+)
+
+client = Client(username="your-username", password="your-password")
+# or: client = Client.from_env()  # PH_API_USERNAME / PH_API_PASSWORD / PH_BASE_URL
+
+# 1. Discover routing details for the customer's country.
+discovery = client.global_.discovery("KE")
+network = discovery["provider_networks"]["m-pesa"][0]
+
+# 2. Create a collection (pay-in).
+resp = client.global_.create_payment(GlobalPaymentRequest(
+    request_type=REQUEST_TYPE_PAYMENT,
+    transaction_channel=CHANNEL_MOMO,
+    provider="yellowcard",
+    amount=5500,
+    currency="KES",
+    country="KE",
+    customer=Customer(
+        first_name="John",
+        last_name="Doe",
+        email="john.doe@example.com",
+        phone="+254712345678",
+        country="KE",
+    ),
+    vendor_config=VendorConfig(vendor_id=63),
+    provider_config=ProviderConfig.from_network(network),
+    payment_config=PaymentConfig(
+        account_number="+254712345678",
+        callback_url="https://your-system.com/webhooks/payhero",
+    ),
+))
+print(resp)
+# {"status_code": "200", "merchant_reference": "9FD194041588.iI", ...}
+```
+
+A success response only means the request was **accepted** — the final result
+arrives on your `callback_url`.
+
+## API surface
+
+### `client.global_` — unified `/api/global` payments
+
+| Method | Endpoint | Description |
+| ------ | -------- | ----------- |
+| `discovery(country)` | `GET /api/global/discovery/payment-world/country` | Rails, providers & networks per country |
+| `create_payment(request)` | `POST /api/global/payments` | Unified pay-in (`REQUEST_TYPE_PAYMENT`) / pay-out (`REQUEST_TYPE_WITHDRAWAL`) |
+| `transaction_status(request_id)` | `POST /api/global/transaction-status` | Poll a transaction by request ID |
+| `balance(account_id)` | `GET /api/global/accounts/{id}/balance` | Account wallet balance |
+| `convert_currency(from, to)` | `POST /api/currency/convert` | Currency conversion rates |
+
+Global payouts use the same request shape as collections with
+`request_type=REQUEST_TYPE_WITHDRAWAL`; the destination goes in
+`payment_config.account_number`. For some corridors (TZ, ZM, NG, …) add the
+funds-owner identity via `Customer(id_type="national_id", id_number="...")`.
+Route part of a payout to savings with `payment_split=PaymentSplit(amount_to_save=100)`.
+
+### `client.kenya` — legacy V1 endpoints
+
+| Method | Endpoint | Description |
+| ------ | -------- | ----------- |
+| `create_collection(request)` | `POST /api/v2/payments` | Channel-based (`channel_id`) or wallet-based (`network_code`) collections; `is_offline=True` + `merchant_fee` for offline Paybill collections |
+| `list_payment_channels(page)` | `GET /api/v2/payment_channels` | Your external bank/Till/Paybill/wallet channels |
+| `withdraw(request)` | `POST /api/v2/withdraw` | Payouts to phone (`RECIPIENT_MSISDN`) or Paybill/Till (`RECIPIENT_PAYBILL`) |
+
+Kenya collection example:
+
+```python
+col = client.kenya.create_collection(CollectionRequest(
+    amount=10,
+    phone_number="0712345678",
+    provider="m-pesa",
+    channel_id=8949,          # from list_payment_channels (settle to your channel)
+    account_id=63,
+    external_reference="test_ext",
+    callback_url="https://your-system.com/webhooks/payhero",
+))
+print(col["CheckoutRequestID"])  # 29119 — offline: use as Paybill account ref
+```
+
+Kenya payout example:
+
+```python
+wd = client.kenya.withdraw(WithdrawRequest(
+    account_id=63,
+    amount=10,
+    phone_number="0712345678",
+    account_number="0712345678",
+    network_code="63902",
+    channel=DESTINATION_PHONE,
+    recipient_type=RECIPIENT_MSISDN,
+))
+```
+
+### `client.teams` — multi-tenancy
+
+Teams are isolated Accounts with their own wallet, payment channels, KYC and
+members — all managed through one organization's API key.
+
+| Method | Endpoint | Description |
+| ------ | -------- | ----------- |
+| `user_profile(user_id)` | `GET /api/v2/user_profile/{user_id}` | Discover your Teams, roles & organizations |
+| `create_account(request)` | `POST /api/v2/accounts` | Provision a Team (wallet created automatically) |
+| `get_account(account_id)` | `GET /api/v2/account/{account_id}` | Fetch a Team |
+| `update_account(request)` | `PUT /api/v2/accounts` | Update Team settings |
+| `delete_account(account_id)` | `DELETE /api/v2/accounts/{id}` | Remove a Team (destructive) |
+| `invite_member(request)` | `POST /api/v2/account_invites` | Invite a user into a Team |
+| `remove_member(account_id, user_id)` | `DELETE /api/v2/account_invites` | Remove a member |
+| `submit_kyc(request)` | `POST /api/v2/account_kycs` | Submit Team KYC |
+| `update_kyc(kyc_id, request)` | `PUT /api/v2/account_kycs/{id}` | Amend a KYC submission |
+
+## Errors
+
+Non-2xx responses raise `payhero.ApiError`:
+
+```python
+from payhero import ApiError
+
+try:
+    client.global_.create_payment(req)
+except ApiError as e:
+    print(e.status_code, e.error_code, e.error_message)
+```
+
+- `400 invalid_argument` — permanent rejection; fix the input before retrying.
+- `401` — missing or wrong Basic-auth credentials.
+- Network/5xx errors can be retried with backoff using the same
+  `external_reference` on your side (pass a custom `requests.Session` with a
+  `urllib3.Retry` adapter if you want automatic retries).
+
+## KYC tiers
+
+Payouts are unrestricted once KYC is complete. Collections unlock progressively:
+Level 1–2 first-party only (own number), Level 3 third-party Kenya-only,
+Level 4 global collections across all supported countries.
+
+## Development
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest tests/
+```
+
+The test suite mocks HTTP with [`responses`](https://github.com/getsentry/responses) —
+no network or credentials required.
+
+## License
+
+MIT

payhero-0.1.0/README.md

@@ -0,0 +1,173 @@
+# payhero (Python SDK)
+
+Official Python SDK for the **PayHero Africa API** — collect and disburse
+money across Africa over a single unified API (mobile money, bank and card
+rails).
+
+```bash
+pip install payhero
+```
+
+## Getting started
+
+Generate an API key (username + password) on your PayHero dashboard.
+
+```python
+from payhero import (
+    Client,
+    Customer,
+    GlobalPaymentRequest,
+    PaymentConfig,
+    ProviderConfig,
+    REQUEST_TYPE_PAYMENT,
+    CHANNEL_MOMO,
+    VendorConfig,
+)
+
+client = Client(username="your-username", password="your-password")
+# or: client = Client.from_env()  # PH_API_USERNAME / PH_API_PASSWORD / PH_BASE_URL
+
+# 1. Discover routing details for the customer's country.
+discovery = client.global_.discovery("KE")
+network = discovery["provider_networks"]["m-pesa"][0]
+
+# 2. Create a collection (pay-in).
+resp = client.global_.create_payment(GlobalPaymentRequest(
+    request_type=REQUEST_TYPE_PAYMENT,
+    transaction_channel=CHANNEL_MOMO,
+    provider="yellowcard",
+    amount=5500,
+    currency="KES",
+    country="KE",
+    customer=Customer(
+        first_name="John",
+        last_name="Doe",
+        email="john.doe@example.com",
+        phone="+254712345678",
+        country="KE",
+    ),
+    vendor_config=VendorConfig(vendor_id=63),
+    provider_config=ProviderConfig.from_network(network),
+    payment_config=PaymentConfig(
+        account_number="+254712345678",
+        callback_url="https://your-system.com/webhooks/payhero",
+    ),
+))
+print(resp)
+# {"status_code": "200", "merchant_reference": "9FD194041588.iI", ...}
+```
+
+A success response only means the request was **accepted** — the final result
+arrives on your `callback_url`.
+
+## API surface
+
+### `client.global_` — unified `/api/global` payments
+
+| Method | Endpoint | Description |
+| ------ | -------- | ----------- |
+| `discovery(country)` | `GET /api/global/discovery/payment-world/country` | Rails, providers & networks per country |
+| `create_payment(request)` | `POST /api/global/payments` | Unified pay-in (`REQUEST_TYPE_PAYMENT`) / pay-out (`REQUEST_TYPE_WITHDRAWAL`) |
+| `transaction_status(request_id)` | `POST /api/global/transaction-status` | Poll a transaction by request ID |
+| `balance(account_id)` | `GET /api/global/accounts/{id}/balance` | Account wallet balance |
+| `convert_currency(from, to)` | `POST /api/currency/convert` | Currency conversion rates |
+
+Global payouts use the same request shape as collections with
+`request_type=REQUEST_TYPE_WITHDRAWAL`; the destination goes in
+`payment_config.account_number`. For some corridors (TZ, ZM, NG, …) add the
+funds-owner identity via `Customer(id_type="national_id", id_number="...")`.
+Route part of a payout to savings with `payment_split=PaymentSplit(amount_to_save=100)`.
+
+### `client.kenya` — legacy V1 endpoints
+
+| Method | Endpoint | Description |
+| ------ | -------- | ----------- |
+| `create_collection(request)` | `POST /api/v2/payments` | Channel-based (`channel_id`) or wallet-based (`network_code`) collections; `is_offline=True` + `merchant_fee` for offline Paybill collections |
+| `list_payment_channels(page)` | `GET /api/v2/payment_channels` | Your external bank/Till/Paybill/wallet channels |
+| `withdraw(request)` | `POST /api/v2/withdraw` | Payouts to phone (`RECIPIENT_MSISDN`) or Paybill/Till (`RECIPIENT_PAYBILL`) |
+
+Kenya collection example:
+
+```python
+col = client.kenya.create_collection(CollectionRequest(
+    amount=10,
+    phone_number="0712345678",
+    provider="m-pesa",
+    channel_id=8949,          # from list_payment_channels (settle to your channel)
+    account_id=63,
+    external_reference="test_ext",
+    callback_url="https://your-system.com/webhooks/payhero",
+))
+print(col["CheckoutRequestID"])  # 29119 — offline: use as Paybill account ref
+```
+
+Kenya payout example:
+
+```python
+wd = client.kenya.withdraw(WithdrawRequest(
+    account_id=63,
+    amount=10,
+    phone_number="0712345678",
+    account_number="0712345678",
+    network_code="63902",
+    channel=DESTINATION_PHONE,
+    recipient_type=RECIPIENT_MSISDN,
+))
+```
+
+### `client.teams` — multi-tenancy
+
+Teams are isolated Accounts with their own wallet, payment channels, KYC and
+members — all managed through one organization's API key.
+
+| Method | Endpoint | Description |
+| ------ | -------- | ----------- |
+| `user_profile(user_id)` | `GET /api/v2/user_profile/{user_id}` | Discover your Teams, roles & organizations |
+| `create_account(request)` | `POST /api/v2/accounts` | Provision a Team (wallet created automatically) |
+| `get_account(account_id)` | `GET /api/v2/account/{account_id}` | Fetch a Team |
+| `update_account(request)` | `PUT /api/v2/accounts` | Update Team settings |
+| `delete_account(account_id)` | `DELETE /api/v2/accounts/{id}` | Remove a Team (destructive) |
+| `invite_member(request)` | `POST /api/v2/account_invites` | Invite a user into a Team |
+| `remove_member(account_id, user_id)` | `DELETE /api/v2/account_invites` | Remove a member |
+| `submit_kyc(request)` | `POST /api/v2/account_kycs` | Submit Team KYC |
+| `update_kyc(kyc_id, request)` | `PUT /api/v2/account_kycs/{id}` | Amend a KYC submission |
+
+## Errors
+
+Non-2xx responses raise `payhero.ApiError`:
+
+```python
+from payhero import ApiError
+
+try:
+    client.global_.create_payment(req)
+except ApiError as e:
+    print(e.status_code, e.error_code, e.error_message)
+```
+
+- `400 invalid_argument` — permanent rejection; fix the input before retrying.
+- `401` — missing or wrong Basic-auth credentials.
+- Network/5xx errors can be retried with backoff using the same
+  `external_reference` on your side (pass a custom `requests.Session` with a
+  `urllib3.Retry` adapter if you want automatic retries).
+
+## KYC tiers
+
+Payouts are unrestricted once KYC is complete. Collections unlock progressively:
+Level 1–2 first-party only (own number), Level 3 third-party Kenya-only,
+Level 4 global collections across all supported countries.
+
+## Development
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest tests/
+```
+
+The test suite mocks HTTP with [`responses`](https://github.com/getsentry/responses) —
+no network or credentials required.
+
+## License
+
+MIT

payhero-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "payhero"
+dynamic = ["version"]
+description = "Official Python SDK for the PayHero Africa API — collect and disburse money across Africa."
+readme = "README.md"
+license = { text = "MIT" }
+authors = [{ name = "PayHero" }]
+requires-python = ">=3.8"
+dependencies = ["requests>=2.25"]
+keywords = ["payhero", "payments", "africa", "mpesa", "mobile-money", "collections", "payouts"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Office/Business :: Financial",
+]
+
+[project.urls]
+Homepage = "https://payhero.africa"
+Documentation = "https://docs.payhero.africa"
+Repository = "https://github.com/PAY-HERO-CONSULTING/payhero-python-sdk"
+Issues = "https://github.com/PAY-HERO-CONSULTING/payhero-python-sdk/issues"
+Changelog = "https://github.com/PAY-HERO-CONSULTING/payhero-python-sdk/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "responses>=0.23",
+    "ruff>=0.4",
+    "build>=1.0",
+    "twine>=5.0",
+]
+
+[tool.setuptools.dynamic]
+version = { attr = "payhero.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+pythonpath = ["src"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py38"
+
+[tool.ruff.lint]
+# Pinned explicitly so a newer ruff in CI cannot widen the rule set under us.
+select = ["E", "F", "W", "I", "UP", "B", "RUF"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["payhero"]
+known-local-folder = ["conftest"]

payhero-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

payhero-0.1.0/src/payhero/__init__.py

@@ -0,0 +1,89 @@
+"""payhero — the official Python SDK for the PayHero Africa API.
+
+Collect and disburse money across Africa over a single unified API (mobile
+money, bank and card rails). All requests use HTTP Basic auth with the
+username/password pair from your PayHero dashboard API key.
+
+Example:
+    from payhero import Client, GlobalPaymentRequest, Customer, ...
+
+    client = Client(username="...", password="...")
+    discovery = client.global_.discovery("KE")
+    network = discovery["provider_networks"]["m-pesa"][0]
+
+    resp = client.global_.create_payment(GlobalPaymentRequest(
+        request_type=REQUEST_TYPE_PAYMENT,
+        transaction_channel=CHANNEL_MOMO,
+        provider="yellowcard",
+        amount=5500,
+        currency="KES",
+        country="KE",
+        customer=Customer(first_name="John", last_name="Doe", phone="+254712345678"),
+        vendor_config=VendorConfig(vendor_id=63),
+        provider_config=ProviderConfig.from_network(network),
+        payment_config=PaymentConfig(account_number="+254712345678"),
+    ))
+"""
+
+from .client import Client
+from .errors import ApiError, PayHeroError
+from .models import (
+    CHANNEL_BANK,
+    CHANNEL_CARD,
+    CHANNEL_MOMO,
+    DESTINATION_PAYBILL,
+    DESTINATION_PHONE,
+    DESTINATION_TILL,
+    RECIPIENT_MSISDN,
+    RECIPIENT_PAYBILL,
+    REQUEST_TYPE_PAYMENT,
+    REQUEST_TYPE_WITHDRAWAL,
+    AccountInformation,
+    AccountKYCRequest,
+    CollectionRequest,
+    ContactInformation,
+    CreateAccountRequest,
+    Customer,
+    EntityInformation,
+    GlobalPaymentRequest,
+    InviteMemberRequest,
+    PaymentConfig,
+    PaymentSplit,
+    ProviderConfig,
+    UpdateAccountRequest,
+    VendorConfig,
+    WithdrawRequest,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "CHANNEL_BANK",
+    "CHANNEL_CARD",
+    "CHANNEL_MOMO",
+    "DESTINATION_PAYBILL",
+    "DESTINATION_PHONE",
+    "DESTINATION_TILL",
+    "RECIPIENT_MSISDN",
+    "RECIPIENT_PAYBILL",
+    "REQUEST_TYPE_PAYMENT",
+    "REQUEST_TYPE_WITHDRAWAL",
+    "AccountInformation",
+    "AccountKYCRequest",
+    "ApiError",
+    "Client",
+    "CollectionRequest",
+    "ContactInformation",
+    "CreateAccountRequest",
+    "Customer",
+    "EntityInformation",
+    "GlobalPaymentRequest",
+    "InviteMemberRequest",
+    "PayHeroError",
+    "PaymentConfig",
+    "PaymentSplit",
+    "ProviderConfig",
+    "UpdateAccountRequest",
+    "VendorConfig",
+    "WithdrawRequest",
+]

payhero-0.1.0/src/payhero/_http.py

@@ -0,0 +1,103 @@
+"""HTTP transport for the PayHero Africa API (requests + Basic auth)."""
+
+from __future__ import annotations
+
+import time
+from typing import Any
+
+import requests
+
+from .errors import ApiError
+
+DEFAULT_BASE_URL = "https://api.payhero.africa"
+DEFAULT_TIMEOUT = 60.0  # seconds
+DEFAULT_MAX_RETRIES = 0
+RETRY_BASE_DELAY = 0.5  # seconds; doubled per attempt
+
+
+class Http:
+    def __init__(
+        self,
+        username: str,
+        password: str,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = DEFAULT_TIMEOUT,
+        session: requests.Session | None = None,
+        max_retries: int = DEFAULT_MAX_RETRIES,
+    ) -> None:
+        if not username or not password:
+            raise ValueError("PayHero requires an API username and password")
+        self._auth = (username, password)
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self.session = session or requests.Session()
+        self.max_retries = max(0, max_retries)
+
+    def request(
+        self,
+        method: str,
+        path: str,
+        params: dict[str, Any] | None = None,
+        json_body: Any = None,
+    ) -> Any:
+        body = None
+        if isinstance(json_body, dict):
+            body = {k: v for k, v in json_body.items() if v is not None}
+        else:
+            to_dict = getattr(json_body, "to_dict", None)
+            body = to_dict() if callable(to_dict) else json_body
+
+        query = {k: v for k, v in (params or {}).items() if v is not None}
+        url = self.base_url + path
+        last_response: requests.Response | None = None
+
+        for attempt in range(self.max_retries + 1):
+            response = self.session.request(
+                method,
+                url,
+                params=query,
+                json=body,
+                auth=self._auth,
+                timeout=self.timeout,
+                headers={"Accept": "application/json"},
+            )
+            if not self._should_retry(response):
+                last_response = response
+                break
+            last_response = response
+            if attempt < self.max_retries:
+                time.sleep(RETRY_BASE_DELAY * (2**attempt))
+
+        assert last_response is not None  # loop always runs at least once
+        return self._parse(last_response)
+
+    @staticmethod
+    def _should_retry(response: requests.Response) -> bool:
+        """Retry network-level failures and transient statuses (429/5xx)."""
+        return response.status_code == 429 or response.status_code >= 500
+
+    @staticmethod
+    def _parse(response: requests.Response) -> Any:
+        try:
+            payload = response.json()
+        except ValueError:
+            payload = None
+
+        if not response.ok:
+            error_code = ""
+            message = response.reason or "request failed"
+            status_code = response.status_code
+            if isinstance(payload, dict):
+                error_code = payload.get("error_code", "") or ""
+                message = payload.get("error_message", message) or message
+                raw_status = payload.get("status_code")
+                if isinstance(raw_status, int):
+                    status_code = raw_status
+            raise ApiError(
+                status_code=status_code,
+                error_code=error_code,
+                error_message=message,
+                http_status=response.status_code,
+                body=response.text,
+            )
+        return payload