# Saba Cash / سبأ كاش

Method ID: `11`. 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: `ApiSabaCashUrl`.

Active source fallback: `https://api.sabacash.com:49901/`.

The active source definition is labelled For Test, while comments also show a live URL with the same host. This archive does not establish the production environment merely from the hostname.

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 |
| --- | --- | --- | --- |
| Login | POST | `https://api.sabacash.com:49901/api/user-ms/v1/login` | Merchant token. |
| Initiate | POST | `https://api.sabacash.com:49901/api/accounts/v1/adjustment/onLinePayment` | Create online payment. |
| Confirm | PATCH | `https://api.sabacash.com:49901/api/accounts/v1/adjustment/onLinePayment` | Same endpoint, different HTTP method and OTP payload. |
| Status | GET | `https://api.sabacash.com:49901/api/accounts/v1/adjustment/checkAdjustmentByTransactionId` | transactionId query parameter. |
| Refund | POST | `https://api.sabacash.com:49901/api/accounts/v1/adjustment/onlineMoneyReturn` | Adapter capability. |


## 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. |
| SabaCashAccountPaymentSecretKey / SabaCashAccountcertificatePassword | Server cryptographic/certificate helper defaults; do not put these in Flutter. Read certificate transport branch before treating a particular helper as required for a deployed account. |


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: JSON username/password login; token is used by authenticated payment calls. Shared adapter metadata/caches hold the authentication result.

## Customer and server inputs

| Field | Requirement | Meaning |
| --- | --- | --- |
| payment_account_id | Required | Customer source.code/mobile account. |
| code | Required at confirmation | Customer OTP. |


## Payment flow

1. Login and obtain a nonempty token.
2. POST onLinePayment with customer source, merchant terminal beneficiary and amount. Save adjustment.id and adjustment.transactionId; status 2.
3. PATCH onLinePayment with saved id and customer otp. Successful confirmation changes status to 3.
4. A GET transaction check can inspect transactionDate, transactionId and statusCode; test-only calls in checkout may be disabled.

## Provider requests

### Login

```json
{
  "username": "<MERCHANT_USERNAME>",
  "password": "<MERCHANT_PASSWORD>"
}
```

### Initiate

```json
{
  "source": {
    "code": "<CUSTOMER_MOBILE>",
    "currencyId": "2"
  },
  "beneficiary": {
    "terminal": "1",
    "currencyId": "2"
  },
  "amount": "1000",
  "amountCurrencyId": "2",
  "note": "فاتورة مشتريات"
}
```

### Confirm

```json
{
  "id": "<ADJUSTMENT_ID>",
  "otp": "<CUSTOMER_OTP>",
  "note": "فاتورة مشتريات"
}
```

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

### Login

```json
{
  "token": "<ACCESS_TOKEN>"
}
```

### Initiate — consumed fields

```json
{
  "adjustment": {
    "id": "<ADJUSTMENT_ID>",
    "transactionId": "<TRANSACTION_ID>",
    "currencyId": "2"
  },
  "source": {},
  "destination": {}
}
```

### Confirmation — consumed fields

```json
{
  "completed": true,
  "id": "<ADJUSTMENT_ID>",
  "transactionId": "<TRANSACTION_ID>"
}
```

### Status — consumed fields

```json
{
  "transactionDate": "<DATE>",
  "transactionId": "<TRANSACTION_ID>",
  "statusCode": "<PROVIDER_STATUS>"
}
```

- Initiation requires nonempty adjustment.id and adjustment.transactionId. Confirmation similarly requires id and transactionId.
- The source reads completed but does not use it as the sole success gate; error metadata and missing identifiers also matter.
- statusCode "not-exist" is treated as a failure. Errors may include errors and nested error-code/message details; the exact complete vendor schema is not available from this review.

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

- Keep the test-labelled fallback distinct from confirmed production configuration.
- Provider refund support is not a universal automatic customer-cancellation implementation.

## Source evidence

- URLs: [functions/FunctionsPaymentSabaCashAcount.php:4527](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymentSabaCashAcount.php:4527>)

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

- HTTP verbs: [functions/FunctionsPaymentSabaCashAcount.php:6737](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymentSabaCashAcount.php:6737>)

- Response parser: [functions/FunctionsPaymentSabaCashAcount.php:8256](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymentSabaCashAcount.php:8256>)

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

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

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

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

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

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

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

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

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