ShamCash API
Version: 1.0.0

Authenticated ShamCash API with readable JSON responses.

Authentication:
- Protected API endpoints require the X-API-Key header.
- Header example: X-API-Key: sham_xxxxxxxxxxxxxxxxx

Machine-readable schema:
- /openapi.json

Endpoints:

GET /health
  Notes: Public health check. This endpoint does not require X-API-Key.
  Summary: Health
  Responses:
  - 200 - Successful Response

GET /api/session
  Notes: Returns account session status, login state, request stats, and masked API key.
  Summary: Session Status
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

GET /api/account/history
  Notes: Returns the latest received account transactions.
  Summary: Api History
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/account/history/search
  Notes: Searches the latest received transaction history by transaction id.
  Summary: Api History Search
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "tranId": "150010700"
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

GET /api/account/balances
  Notes: Returns account balances with normalized currency values.
  Summary: Api Balances
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

GET /api/account/profile
  Notes: Returns the authenticated ShamCash profile.
  Summary: Api Profile
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

GET /api/account/by-address
  Notes: Finds a ShamCash account by account address. Pass address as a query parameter.
  Summary: Api By Address
  Parameters:
  - query: address (string, required)
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/syriatel/prepaid/recharge
  Summary: Api Syriatel Dynamic Recharge
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0933333333",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/SyriatelWallet/dynamicRecharge
  Summary: Api Syriatel Dynamic Recharge
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0933333333",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/syriatel/postpaid/charge
  Summary: Api Syriatel Charge Postpaid
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0933333333",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/SyriatelWallet/chargePostPaid
  Summary: Api Syriatel Charge Postpaid
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0933333333",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/syriatel/cash-in
  Summary: Api Syriatel Cash In
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0933333333",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/SyriatelWallet/cashIn
  Summary: Api Syriatel Cash In
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0933333333",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/mtn/cash-in
  Summary: Api Mtn Cash In
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0933333333",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/MtnWallet/cashIn
  Summary: Api Mtn Cash In
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0933333333",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/syriatel/prepaid/calculate-paid-amount
  Summary: Api Syriatel Calculate Paid Amount
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0999448072",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/SyriatelWallet/calculatePaidAmount
  Summary: Api Syriatel Calculate Paid Amount
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "PhoneNumber": "0999448072",
    "amount": 6
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/Billing/presentment
  Notes: Billing presentment endpoint. Use serviceId=39 for electricity or serviceId=41 for landline.
  Summary: Api Billing Presentment
  Parameters:
  - query: serviceId (integer, required)
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "gov": "04",
    "subscription": "349034",
    "billingno": "248667"
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/Billing/pay
  Notes: Billing payment endpoint. Use serviceId=39 for electricity or serviceId=41 for landline.
  Summary: Api Billing Pay
  Parameters:
  - query: serviceId (integer, required)
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "gov": "04",
    "billingno": "248667",
    "subscription": "349034",
    "bill_no": "68839134",
    "amount": "19215",
    "note": "customer note from presentment"
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/billing/electricity/presentment
  Summary: Api Electricity Presentment
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "gov": "04",
    "subscription": "349034",
    "billingno": "248667"
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/billing/electricity/pay
  Summary: Api Electricity Pay
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "gov": "04",
    "billingno": "248667",
    "subscription": "349034",
    "bill_no": "68839134",
    "amount": "19215",
    "note": "customer note from presentment"
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/billing/landline/presentment
  Summary: Api Landline Presentment
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "phone": "0186589536"
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/billing/landline/pay
  Summary: Api Landline Pay
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "phone": "0182228248",
    "bill_no": "3145743185",
    "amount": "38",
    "date": "2026-04-30",
    "note": "0182228248 / 202601"
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/transaction/new
  Notes: Creates a new transfer to another ShamCash account.
  Summary: Api Transaction New
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "amount": 5,
    "currency": "SYP",
    "accountAddress": "account-address"
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error

POST /api/Transaction/new
  Notes: Legacy alias for /api/transaction/new.
  Summary: Api Transaction New
  Parameters:
  - query: api_key (string | null, optional)
  - header: X-API-Key (string | null, optional)
  Request body:
  - status: required
  - content-type: application/json
  - schema: Payload
  Request JSON example:
  {
    "amount": 5,
    "currency": "SYP",
    "accountAddress": "account-address"
  }
  Responses:
  - 200 - Successful Response
  - 422 - Validation Error