Cash Collection Locations

Authentication & headers

Both endpoints use the same credentials as the rest of the Whish Money network, sent as HTTP headers. These are read-only GET lookups, so no request body is sent.

Environments

Whish Money provides two isolated environments. Validate against Sandbox before requesting Production access.

The cURL examples on this page target Sandbox. To go live, swap the host for the Production base URL above.

Building a request URL

Each endpoint path in this reference begins with /api/…. Append the endpoint path to the environment base URL. Note that the Sandbox base URL already ends in /api, so the full Sandbox URL contains /api/api/….

For the example endpoint GET /api/shops:

Response format

Both endpoints return HTTP 200 with Content-Type: application/json and the shared envelope. Branch on the status field in the body, never on the HTTP status code.

Data models

Shop

A collection point, returned by List shops.

Governorate

A Lebanese governorate and its districts, returned by List governorates and districts.

District

List governorates and districts

Retrieve every governorate with its districts. Use the ids to build a location picker and to filter List shops.

curl 'https://sandbox.woocash.money/api/api/governorates' \
  -H 'username: YOUR_USERNAME' \
  -H 'key: YOUR_KEY' \
  -H 'Accept: application/json' \
  -H 'Request-id: 1720598400123'

Request body: None. Parameters: None.

{
  "status": true,
  "code": null,
  "dialog": null,
  "extra": null,
  "data": [
    {
      "id": 3,
      "label": "Beirut",
      "districts": [
        { "id": 4, "governorate": "LB-BA", "label": "Beirut" }
      ]
    },
    {
      "id": 5,
      "label": "Mount Lebanon",
      "districts": [
        { "id": 9, "governorate": "LB-JL", "label": "Baabda" },
        { "id": 13, "governorate": "LB-JL", "label": "Matn" }
      ]
    }
  ]
}

The full set is listed under Governorates & districts. Pull the live values from this endpoint rather than hard-coding them.

List shops

Retrieve the collection points where a beneficiary can pick up funds. Each shop is a Whish Money branch (type: "Whish Money Branches") or a partner agent (type: "Normal").

Query parameters

Omit both to return all shops; pass either or both to narrow the list to an area.

curl 'https://sandbox.woocash.money/api/api/shops?governorateId=3&districtId=4' \
  -H 'username: YOUR_USERNAME' \
  -H 'key: YOUR_KEY' \
  -H 'Accept: application/json' \
  -H 'Request-id: 1720598400123'

{
  "status": true,
  "code": null,
  "dialog": null,
  "extra": null,
  "data": [
    {
      "id": 2,
      "name": "TALACO - RAOUCHE",
      "address": "Beirut, Beirut, Raouche, Australia, Alyaa Bld",
      "phone": "+961 1 809 555",
      "latitude": 33.88784,
      "longitude": 35.475079,
      "workingHours": null,
      "url": "https://whish.money/branch.php?id=2pkl1154715079",
      "type": "Whish Money Branches"
    },
    {
      "id": 118,
      "name": "BAGHDADI TRADING EST",
      "address": "Beirut, Beirut, Hamra, Liion Street, Al Chaikha Resto",
      "phone": "+961 1 345 312",
      "latitude": 33.901352,
      "longitude": 35.492748,
      "workingHours": null,
      "url": "https://whish.money/branch.php?id=76pkl1187033986",
      "type": "Normal"
    }
  ]
}

Governorates & districts

The full set returned by List governorates and districts, for reference. Always pull live values from the endpoint; this table can change.

Version history

Notable changes to this API and its reference, newest first.

Postman & tools

Import the ready-made Postman collection, set your username and key as collection variables (or attach a Sandbox / Production environment), and call both endpoints without writing code. Request-id auto-generates a unique numeric value per send.

Download collection OpenAPI spec All downloads & environments