# One Cash / ون كاش

Method ID: `5`. 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: `ApiOneCashUrl`.

Active source fallback: `https://82.114.171.42:49049/`.

The IP-address URL is the active fallback. portal.onecash.com.ye:49049 appears as a commented alternative, not the active fallback.

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 |
| --- | --- | --- | --- |
| Initiate | POST | `https://82.114.171.42:49049/INTEG/rest/CheckPay` | Active checkout. |
| Status | POST | `https://82.114.171.42:49049/INTEG/rest/GetPayStatus` | Called before executing confirmation. |
| Execute | POST | `https://82.114.171.42:49049/INTEG/rest/ExePay` | Executes payment using OTP. |
| Full refund | POST | `https://82.114.171.42:49049/INTEG/rest/PayRefund` | Adapter capability; not a universal cancellation hook. |
| Partial refund | POST | `https://82.114.171.42:49049/INTEG/rest/PayPartialRefund` | Adapter capability. |
| Change merchant password helper | POST | `https://82.114.171.42:49049/INTEG/rest/UserPassChn` | Administrative helper; not customer checkout. |


## 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. |
| ApiOneCashPublicKey | Server constant used by the RSA password-encoding helper. Supply the provider-issued public key; the archive value is intentionally omitted. |


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: No separate OAuth login. Each JSON operation carries id, userName, RSA-encoded pass, timeStamp and a generated hash. The hash input varies by operation; use CreateOneCashPaymentHash rather than copying a hash between operations.

## Customer and server inputs

| Field | Requirement | Meaning |
| --- | --- | --- |
| payment_account_id | Required | Customer One Cash wallet/mobile. |
| code | Required at confirmation | Customer OTP. |


## Payment flow

1. POST CheckPay with customer wallet and order amount. Save exTranRef, salesOrder when supplied, and the request metadata; leave payment_status=2.
2. The Flutter flow displays the provider initiation message specially for method 5 and asks for confirmation.
3. Confirmation checks GetPayStatus using saved references. If execution is needed, POST ExePay with the saved exTranRef and customer OTP.
4. Record confirmed payment_status=3 only after the confirmation flow succeeds.

## Provider requests

### CheckPay

```json
{
  "id": "<MERCHANT_ID>",
  "userName": "<MERCHANT_USERNAME>",
  "pass": "<RSA_ENCODED_MERCHANT_PASSWORD>",
  "timeStamp": "<GENERATED_TIMESTAMP>",
  "hash": "<GENERATED_HASH>",
  "amount": 1000,
  "endUserId": "<CUSTOMER_ID>",
  "oneCutomerWallet": "<CUSTOMER_WALLET>"
}
```

### ExePay adds

```json
{
  "exTranRef": "<SAVED_EX_TRAN_REF>",
  "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
{
  "error": 0,
  "message": "<PROVIDER_MESSAGE>",
  "exTranRef": 12345,
  "totalFees": 0,
  "salesOrder": 67890,
  "paymentStatus": "<PROVIDER_STATUS>"
}
```

- Provider error must be integer 0; the wrapper converts nonzero errors to error=true.
- The source checks for the literal key "paymentStatus " with a trailing space before reading "paymentStatus". A normal paymentStatus key can therefore be missed. Do not silently reproduce this bug in a new implementation.
- The wrapper returns errorCode, Message, exTranRef, salesOrder, totalFees and paymentStatus alongside the raw Response. Amounts are formatted to one decimal place before sending.

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

- Refund endpoints exist in the adapter, but the customer cancellation path does not automatically invoke them for every One Cash order.

## Source evidence

- Wire payloads: [functions/FunctionsPaymentOneCashAcount.php:2006](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymentOneCashAcount.php:2006>)

- Response parsing: [functions/FunctionsPaymentOneCashAcount.php:2700](</Users/ayman/Documents/Old Mac Data/Downloads/yemensnackfood/functions/FunctionsPaymentOneCashAcount.php:2700>)

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

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

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

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

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

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

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

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

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