# Mahfathati / محفظتي — Tadhamon Bank

Method ID: `4`. Payment type: `4`. Source reviewed: 2026-10-24. This is an archived-code contract, not a live-provider certification. Examples are illustrative partial schemas; placeholder values are not credentials or captured transactions.

## URLs

Base selector: `ApiTadhamonBankUrl`.

Active source fallback: `https://agentapi.tadhamonbank.com/`.

The actual request functions use hard-coded HTTPS endpoint strings. Changing the base constant alone does not prove these functions will use the new host.

Most legacy base constants are wrapped in `if (!defined(...))`; an earlier bootstrap definition can override the fallback. Hard-coded full-URL exceptions are called out above. Merchant JSON is not automatically a base-URL override.

| Operation | HTTP method | Full URL | Use |
| --- | --- | --- | --- |
| Provider availability | POST | `https://agentapi.tadhamonbank.com/AgentWs/resources/Agent/agentApiStatus` | Availability helper. |
| Initiate | POST | `https://agentapi.tadhamonbank.com/AgentWs/resources/Agent/agentApiRequest` | Active checkout operation. |
| Transaction status | POST | `https://agentapi.tadhamonbank.com/AgentWs/resources/Agent/agentApiStatus` | Status helper shares the same endpoint name. |
| Confirm | POST | `https://agentapi.tadhamonbank.com/AgentWs/resources/Agent/agentApiConfirmRequest` | Active confirmation operation. |


## Configuration fields

| Field / source setting | Meaning |
| --- | --- |
| AccountUserId | Merchant/agent/client identifier where used; stored in ElectronicPaymentAccountApiInfo. |
| AccountUserName | Merchant login/account name; not the customer phone unless the provider contract specifically uses it. |
| AccountUserPassword | Merchant password/short code; keep server-side. |
| TadhamonBankMahfathatiAccountId / TadhamonBankMahfathatiAccountUserName / TadhamonBankMahfathatiAccountPassword | Constants populated by Set_TadhamonBank_App_Info; actual outgoing values are obtained through Get_TadhamonBank_App_Info. Inspect this loader when provisioning credentials. |


Configuration location: merchant row `platform_payment_ways.ElectronicPaymentAccountApiInfo`, plus named server constants/transport files where stated. Common listing fields (`type`, titles, descriptions, icon, account_number, order_view, status, active) are documented in [00-common-contract.md](00-common-contract.md).

Authentication/transport: Merchant userName/password are included in the JSON request body; the generic transport POSTs JSON.

## Customer and server inputs

| Field | Requirement | Meaning |
| --- | --- | --- |
| payment_account_id | Required | Customer wallet/mobile account. |
| code | Required at confirmation | Customer OTP; the original transNo is loaded from server-side payment metadata. |


## Payment flow

1. Validate enabled method and wallet account. Resolve merchant credentials through Get_TadhamonBank_App_Info.
2. POST agentApiRequest with the wallet account and order amount. Persist the returned transNo and provider response; set payment_status=2.
3. Flutter asks for an OTP. Backend reloads the saved transaction and POSTs agentApiConfirmRequest.
4. Successful provider confirmation changes payment_status to 3.

## Provider requests

### Initiation

```json
{
  "userName": "<MERCHANT_USERNAME>",
  "password": "<MERCHANT_PASSWORD>",
  "fromAccount": "<CUSTOMER_WALLET>",
  "trans_type": "pos",
  "pin": "",
  "amount": 1000
}
```

### Confirmation

```json
{
  "userName": "<MERCHANT_USERNAME>",
  "password": "<MERCHANT_PASSWORD>",
  "transId": "<SAVED_TRANS_NO>",
  "otp": "<CUSTOMER_OTP>"
}
```

The examples show fields used by the archived adapter. Additional transport headers, derived identifiers and conditional helper-operation fields must be read with the source evidence below. Secrets and calculated security values are supplied/generated server-side.

## Provider responses and success rules

### Payment response — consumed fields

```json
{
  "transNo": "<TRANSACTION_REFERENCE>",
  "errCode": "0",
  "errDesc": "<PROVIDER_MESSAGE>"
}
```

- The adapter interprets provider errCode, errDesc and transNo; success responses use errCode=0. A returned transNo is a reference, not proof that the OTP-confirmed payment has completed.
- Normalized request/confirmation helpers additionally expose error, TimeOut and message/response details; casing differs from the generic adapters.

## Adapter result returned to the application layer

```json
{
  "error": false,
  "TimeOut": false,
  "Message": "<NORMALIZED_MESSAGE>",
  "Response": {
    "<provider-fields>": "<RAW_PROVIDER_RESPONSE>"
  }
}
```

This is a representative partial adapter result, not the public Flutter response. Keys are conditional and provider-specific. `error=true` or `TimeOut=true` prevents treating an initiation/confirmation as successful; transport errors can return before all keys exist. RequestType, saved references, token/cache metadata and provider-specific values may also be present. Raw merchant credentials/request logs must not be included in a customer-facing response.

## Application API requests and responses

The archived Flutter default for `APP_API_BASE` is **`https://platformdgtl.com/yemensnackfood/connect/v1/`**, set in Remote Config defaults. Fetched Remote Config can override it; this is a source default, not a verified live deployment. Trim the trailing slash when combining it with the paths below. Source: [lib/src/controllers/splash_controller.dart:234](</Users/ayman/Documents/Old Mac Data/flutter_projects/platform/yemen_snack_food/lib/src/controllers/splash_controller.dart:234>).

`APP_API_BASE` is supplied by Firebase Remote Config key `api_url` in the archived Flutter app. The resolved deployment value is not present in the reviewed source; use that runtime value rather than inventing a host. These paths belong to Yemen Snack Food, not Sharqiah v1 driver APIs.

Create: `POST {APP_API_BASE}/orders.php?action=add_order`, using multipart form data. The JSON below is a readable representation of those form fields; `items` is JSON-encoded text. The server calculates the amount.

```json
{
  "address_id": "<OWNED_ADDRESS_ID>",
  "delivery_time": "<DELIVERY_OPTION>",
  "items": "[{\"id\":1,\"quantity\":1}]",
  "payment_id": 4,
  "payment_account_id": "<CUSTOMER_WALLET_OR_MOBILE>"
}
```

Change method/details: `POST {APP_API_BASE}/orders.php?action=add_payment_info`, with `order_id`, `payment_id` and the relevant customer fields above. Changes are limited to early eligible orders and unconfirmed payment state; confirmation independently rejects ineligible/already-confirmed orders.

Confirm: `POST {APP_API_BASE}/orders.php?action=SendConfirmPayment` with form fields:

```json
{
  "order_id": "<ORDER_ID>",
  "code": "<CUSTOMER_OTP>"
}
```

Illustrative **partial** create response (business success, not proof of settlement):

```json
{
  "status": 0,
  "message": "<APPLICATION_MESSAGE>",
  "result": {
    "order_id": 123,
    "order_payment_id": 4,
    "order_payment_type": 4,
    "order_payment_status": 2
  }
}
```

Expected confirmed order state: `order_payment_status=3`. The confirm endpoint may return a message without an order object; Flutter reloads the order.

Business failure shape, illustrative and partial:

```json
{
  "status": 1,
  "message": "<VALIDATION_OR_PROVIDER_ERROR_MESSAGE>"
}
```

See [the common contract](00-common-contract.md) for auth, status meanings, shared fields and response-layer differences.


## Persistence, cancellation and implementation limits

Payment initiation uses `platform_orders_temporary_storage` and electronic-payment temporary metadata. Later operations load saved transaction references from electronic-payment metadata. The archive also uses filesystem caches; these are implementation details, not proof of atomicity or idempotency.

- No dedicated automatic Mahfathati refund call was found in the customer cancel_order.php path.
- The confirmation function assigns an older HTTP URL and then overwrites it with HTTPS; the final HTTPS value is the effective local assignment.

## Source evidence

- Initiation helper: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2033](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2033>)

- Status helper: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2630](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2630>)

- Confirmation helper: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:3089](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:3089>)

- URL assignment: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:298](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:298>)

- URL assignment: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:302](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:302>)

- URL assignment: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:1849](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:1849>)

- URL assignment: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:1851](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:1851>)

- URL assignment: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2293](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2293>)

- URL assignment: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2809](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2809>)

- URL assignment: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2811](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:2811>)

- URL assignment: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:3334](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:3334>)

- URL assignment: [functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:3336](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymenMahfathatiTadhamonBankAcount.php:3336>)

- Checkout dispatch: [connect/v1/OrderManagementPaymentWaysElectronic/AddOrder-PaymentSendInset.php:20919](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/connect/v1/OrderManagementPaymentWaysElectronic/AddOrder-PaymentSendInset.php:20919>)

- Customer validation/configuration gate: [connect/v1/contains-orders/add_order.php:926](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/connect/v1/contains-orders/add_order.php:926>)

- Flutter field selection: [lib/src/view/components/form_fields/payment_form_fields.dart:65](</Users/ayman/Documents/Old Mac Data/flutter_projects/platform/yemen_snack_food/lib/src/view/components/form_fields/payment_form_fields.dart:65>)
