# Floosak / فلوسك

Method ID: `8`. 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: `ApiFloosakUrl`.

Active source fallback: `https://floosak.ye/`.

Active fallback is labelled live; the commented staging.fintech-expert.net URL is an alternative only.

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 |
| --- | --- | --- | --- |
| Merchant request key | POST | `https://floosak.ye/api/v1/request/key` | Merchant onboarding/authentication. |
| Merchant verify key | POST | `https://floosak.ye/api/v1/verify/key` | Merchant OTP/key verification. |
| Initiate | POST | `https://floosak.ye/api/v1/merchant/p2mcl` | Customer purchase initiation. |
| Confirm | POST | `https://floosak.ye/api/v1/merchant/p2mcl/confirm` | Customer OTP confirmation. |
| Refund | POST | `https://floosak.ye/api/v1/merchant/p2mcl/refund` | Adapter helper; generic cancellation is not wired universally. |


## 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. |
| key / token / tokenType | Merchant authentication key and token type retained after merchant verification. These are runtime credentials, not customer checkout fields. |
| AccountUserId | Also used as merchant-auth request_id during verification, depending on operation. |
| source_wallet_id | Selected from merchant account_detail by the adapter; not the customer wallet number. |


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 phone/short_code start merchant authentication; otp/request_id verify it. Customer payments then use the stored merchant key/access-token context. Merchant OTP and customer payment OTP are different stages.

## Customer and server inputs

| Field | Requirement | Meaning |
| --- | --- | --- |
| payment_account_id | Required | Customer mobile/wallet target_phone. |
| code | Required at confirmation | Customer OTP. |
| voucher | Optional adapter alias | A purchase reference when provided; the saved provider purchase_id normally supplies this reference. |


## Payment flow

1. Provision/verify merchant authentication first and obtain account_detail/key.
2. Select source_wallet_id, submit p2mcl with customer target_phone, order request_id and amount. Keep the returned purchase_id/reference_id; order status is 2.
3. Customer enters the payment OTP. Submit p2mcl/confirm with otp and saved purchase_id.
4. Successful confirmation sets payment_status=3.

## Provider requests

### Merchant request key

```json
{
  "phone": "<MERCHANT_PHONE>",
  "short_code": "<MERCHANT_SHORT_CODE>"
}
```

### Merchant verification

```json
{
  "otp": "<MERCHANT_AUTH_OTP>",
  "request_id": "<MERCHANT_AUTH_REQUEST_ID>"
}
```

### Initiate

```json
{
  "source_wallet_id": "<MERCHANT_WALLET_ID>",
  "request_id": "<ORDER_REFERENCE>",
  "target_phone": "<CUSTOMER_MOBILE>",
  "amount": 1000,
  "purpose": "فاتورة مشتريات"
}
```

### Confirm

```json
{
  "otp": "<CUSTOMER_OTP>",
  "purchase_id": "<SAVED_PURCHASE_ID>"
}
```

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

### Merchant authentication — consumed fields

```json
{
  "message": "<PROVIDER_MESSAGE>",
  "request_id": "<AUTH_REQUEST_ID>",
  "key": "<MERCHANT_ACCESS_KEY>",
  "account_detail": {}
}
```

### Payment — consumed fields

```json
{
  "is_success": true,
  "message": "<PROVIDER_MESSAGE>",
  "data": {
    "id": "<PURCHASE_ID>",
    "reference_id": "<REFERENCE_ID>"
  }
}
```

- Payment parsing requires truthy is_success and reads data.id/data.reference_id. Error handling also reads errors, error and error_description.
- The wrapper normalizes key into token where appropriate and retains purchase_id/reference_id for confirmation.

## 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": 8,
  "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": 8,
    "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.

- The admin screen has a separate merchant key/OTP setup flow. A customer payment OTP cannot substitute for this merchant setup.

## Source evidence

- Endpoints: [functions/FunctionsPaymentFloosakAcount.php:3980](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymentFloosakAcount.php:3980>)

- Wire fields: [functions/FunctionsPaymentFloosakAcount.php:4182](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymentFloosakAcount.php:4182>)

- Payment response: [functions/FunctionsPaymentFloosakAcount.php:5779](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymentFloosakAcount.php:5779>)

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

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

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

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

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

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

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

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

- 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>)
