BusinessBusiness and branches

Business

Business and branches

Business settings, branches and places.

Pilotv1

The business's name, category, average bill and counter script, its join QR, and its branches with their QRs and map places. A key limited to some branches reads and changes only those.

Paths are relative to https://app.revisit.cards/v1/developer.

Endpoints

GET/business
Read business settings
PUT/business/name
Change name
PUT/business/card-category
Change card-category
PUT/business/average-bill
Change average-bill
PUT/business/counter-script-language
Change counter-script-language
GET/business/qr
Download business enrollment QR
GET/branches
Read permitted business branches
POST/branches
Create a branch
GET/branches/{id}
Read a permitted branch
PATCH/branches/{id}
Change branch details
DELETE/branches/{id}
Close a branch while retaining history
POST/branches/{id}/activate
Activate a pending enterprise branch
GET/branches/{id}/qr
Download a permitted active branch QR
GET/branches/{id}/geo
Read branch geographic settings
PUT/branches/{id}/geo
Replace branch geographic settings

Read business settings

GET/business

Scopebusiness:read

Requires business:read. See business.md for key restrictions and original billing/licence rules.

Returns 200

idstringRequired
namestringRequired
slugstringRequired
typestring or nullRequired
storeLogoUrlstring or nullRequired
joinUrlstringRequired
suspendedbooleanRequired
averageBillnumber or nullRequired
counterScriptLanguageenumRequired: One of banglish, english.
cardCategoryenumRequired: One of loyalty, everyday, travel.

Request

curl "https://app.revisit.cards/v1/developer/business" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY"

Response

{
  "data": {
    "averageBill": 350,
    "cardCategory": "loyalty",
    "counterScriptLanguage": "banglish",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "name": "Mishti Ghor",
    "slug": "mishti-ghor",
    "storeLogoUrl": "https://app.revisit.cards/api/media/logo.png",
    "suspended": false,
    "type": "Café"
  },
  "requestId": "feed9480-6320-4909-8556-d1fa1be74cf8",
  "success": true
}

Change name

PUT/business/name

Scopebusiness:write

Requires business:write. See business.md for key restrictions and original billing/licence rules.

Send an Idempotency-Key header. Safe to retry.

Body

namestringRequired: 2 to 60 characters.

Returns 200

idstringRequired
namestringRequired
slugstringRequired
typestring or nullRequired
storeLogoUrlstring or nullRequired
joinUrlstringRequired
suspendedbooleanRequired
averageBillnumber or nullRequired
counterScriptLanguageenumRequired: One of banglish, english.
cardCategoryenumRequired: One of loyalty, everyday, travel.

Request

curl -X PUT "https://app.revisit.cards/v1/developer/business/name" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -H "Idempotency-Key: 5f0c2a8e-7b1d-4c3e-9a6f-0d4b8e9412f5" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mishti Ghor"
  }'

Response

{
  "data": {
    "averageBill": 350,
    "cardCategory": "loyalty",
    "counterScriptLanguage": "banglish",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "name": "Mishti Ghor",
    "slug": "mishti-ghor",
    "storeLogoUrl": "https://app.revisit.cards/api/media/logo.png",
    "suspended": false,
    "type": "Café"
  },
  "requestId": "5e4cb52e-b52f-48e8-9ecd-3762c72dd80b",
  "success": true
}

Change card-category

PUT/business/card-category

Scopebusiness:write

Requires business:write. See business.md for key restrictions and original billing/licence rules.

Send an Idempotency-Key header. Safe to retry.

Body

cardCategoryenumRequired: One of loyalty, everyday, travel.

Returns 200

idstringRequired
namestringRequired
slugstringRequired
typestring or nullRequired
storeLogoUrlstring or nullRequired
joinUrlstringRequired
suspendedbooleanRequired
averageBillnumber or nullRequired
counterScriptLanguageenumRequired: One of banglish, english.
cardCategoryenumRequired: One of loyalty, everyday, travel.

Request

curl -X PUT "https://app.revisit.cards/v1/developer/business/card-category" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -H "Idempotency-Key: 5f0c2a8e-7b1d-4c3e-9a6f-0d4b8e4913ea" \
  -H "Content-Type: application/json" \
  -d '{
    "cardCategory": "loyalty"
  }'

Response

{
  "data": {
    "averageBill": 350,
    "cardCategory": "loyalty",
    "counterScriptLanguage": "banglish",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "name": "Mishti Ghor",
    "slug": "mishti-ghor",
    "storeLogoUrl": "https://app.revisit.cards/api/media/logo.png",
    "suspended": false,
    "type": "Café"
  },
  "requestId": "439bdc0e-e8ef-4e18-b79e-a10e8fa64f8d",
  "success": true
}

Change average-bill

PUT/business/average-bill

Scopebusiness:write

Requires business:write. See business.md for key restrictions and original billing/licence rules.

Send an Idempotency-Key header. Safe to retry.

Body

averageBillinteger or nullRequired

Returns 200

idstringRequired
namestringRequired
slugstringRequired
typestring or nullRequired
storeLogoUrlstring or nullRequired
joinUrlstringRequired
suspendedbooleanRequired
averageBillnumber or nullRequired
counterScriptLanguageenumRequired: One of banglish, english.
cardCategoryenumRequired: One of loyalty, everyday, travel.

Request

curl -X PUT "https://app.revisit.cards/v1/developer/business/average-bill" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -H "Idempotency-Key: 5f0c2a8e-7b1d-4c3e-9a6f-0d4b8e0e37b7" \
  -H "Content-Type: application/json" \
  -d '{
    "averageBill": 350
  }'

Response

{
  "data": {
    "averageBill": 350,
    "cardCategory": "loyalty",
    "counterScriptLanguage": "banglish",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "name": "Mishti Ghor",
    "slug": "mishti-ghor",
    "storeLogoUrl": "https://app.revisit.cards/api/media/logo.png",
    "suspended": false,
    "type": "Café"
  },
  "requestId": "8c0e74a6-b153-4243-a1fa-bede84c310f0",
  "success": true
}

Change counter-script-language

PUT/business/counter-script-language

Scopebusiness:write

Requires business:write. See business.md for key restrictions and original billing/licence rules.

Send an Idempotency-Key header. Safe to retry.

Body

counterScriptLanguageenumRequired: One of banglish, english.

Returns 200

idstringRequired
namestringRequired
slugstringRequired
typestring or nullRequired
storeLogoUrlstring or nullRequired
joinUrlstringRequired
suspendedbooleanRequired
averageBillnumber or nullRequired
counterScriptLanguageenumRequired: One of banglish, english.
cardCategoryenumRequired: One of loyalty, everyday, travel.

Request

curl -X PUT "https://app.revisit.cards/v1/developer/business/counter-script-language" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -H "Idempotency-Key: 5f0c2a8e-7b1d-4c3e-9a6f-0d4b8e97b9ad" \
  -H "Content-Type: application/json" \
  -d '{
    "counterScriptLanguage": "banglish"
  }'

Response

{
  "data": {
    "averageBill": 350,
    "cardCategory": "loyalty",
    "counterScriptLanguage": "banglish",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "name": "Mishti Ghor",
    "slug": "mishti-ghor",
    "storeLogoUrl": "https://app.revisit.cards/api/media/logo.png",
    "suspended": false,
    "type": "Café"
  },
  "requestId": "b79529ff-b1cc-4a4d-9d9c-74e1c125f400",
  "success": true
}

Download business enrollment QR

GET/business/qr

Scopebusiness:read

Requires business:read. See business.md for key restrictions and original billing/licence rules.

Answers with a file: image/png.

Request

curl "https://app.revisit.cards/v1/developer/business/qr" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -o download

Response

HTTP/1.1 200
Content-Type: image/png

(file)

Read permitted business branches

GET/branches

Scopebranches:read

Requires branches:read. See business.md for key restrictions and original billing/licence rules.

Request

curl "https://app.revisit.cards/v1/developer/branches" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY"

Response

{
  "data": [
    {
      "activatedAt": "2026-11-03T08:41:12.000Z",
      "address": "House 12, Road 7, Dhanmondi, Dhaka 1209",
      "code": "WELCOME10",
      "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
      "isDefault": false,
      "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
      "lapsedAt": "2026-11-03T08:41:12.000Z",
      "name": "Dhanmondi",
      "phone": "01XXXXXXXXX",
      "removedAt": null,
      "staffCount": 12,
      "status": "pending",
      "suspended": false
    }
  ],
  "requestId": "45829487-cfb6-446c-ac0b-c5a8e8d7c64a",
  "success": true
}

Create a branch

POST/branches

Scopebranches:write

Requires branches:write. See business.md for key restrictions and original billing/licence rules.

Send an Idempotency-Key header. Safe to retry.

Body

namestringRequired: 1 to 60 characters.
addressstring or null
phonestring or null

Returns 200

idstringRequired
namestringRequired
addressstring or nullRequired
phonestring or nullRequired: Intentionally public business contact number, not a customer number.
codestringRequired
isDefaultbooleanRequired
joinUrlstring or nullRequired
statusenumRequired: One of pending, active, lapsed, removed.
activatedAtstring or nullRequired
lapsedAtstring or nullRequired
removedAtstring or nullRequired
staffCountintegerRequired
suspendedbooleanRequired

Request

curl -X POST "https://app.revisit.cards/v1/developer/branches" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -H "Idempotency-Key: 5f0c2a8e-7b1d-4c3e-9a6f-0d4b8e465d90" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dhanmondi"
  }'

Response

{
  "data": {
    "activatedAt": "2026-11-03T08:41:12.000Z",
    "address": "House 12, Road 7, Dhanmondi, Dhaka 1209",
    "code": "WELCOME10",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "isDefault": false,
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "lapsedAt": "2026-11-03T08:41:12.000Z",
    "name": "Dhanmondi",
    "phone": "01XXXXXXXXX",
    "removedAt": null,
    "staffCount": 12,
    "status": "pending",
    "suspended": false
  },
  "requestId": "ca031317-511d-4e8f-a8cd-09a335f88c50",
  "success": true
}

Read a permitted branch

GET/branches/{id}

Scopebranches:read

Requires branches:read. See business.md for key restrictions and original billing/licence rules.

Path

iduuidRequired

Returns 200

idstringRequired
namestringRequired
addressstring or nullRequired
phonestring or nullRequired: Intentionally public business contact number, not a customer number.
codestringRequired
isDefaultbooleanRequired
joinUrlstring or nullRequired
statusenumRequired: One of pending, active, lapsed, removed.
activatedAtstring or nullRequired
lapsedAtstring or nullRequired
removedAtstring or nullRequired
staffCountintegerRequired
suspendedbooleanRequired

Request

curl "https://app.revisit.cards/v1/developer/branches/e01b010d-2c65-48e1-83a0-acad79f8d3b4" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY"

Response

{
  "data": {
    "activatedAt": "2026-11-03T08:41:12.000Z",
    "address": "House 12, Road 7, Dhanmondi, Dhaka 1209",
    "code": "WELCOME10",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "isDefault": false,
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "lapsedAt": "2026-11-03T08:41:12.000Z",
    "name": "Dhanmondi",
    "phone": "01XXXXXXXXX",
    "removedAt": null,
    "staffCount": 12,
    "status": "pending",
    "suspended": false
  },
  "requestId": "394a8d4f-70d6-4109-8d4d-07ed971fc08a",
  "success": true
}

Change branch details

PATCH/branches/{id}

Scopebranches:write

Requires branches:write. See business.md for key restrictions and original billing/licence rules.

Send an Idempotency-Key header. Safe to retry.

Path

iduuidRequired

Body

namestring: 1 to 60 characters.
addressstring or null
phonestring or null

Returns 200

idstringRequired
namestringRequired
addressstring or nullRequired
phonestring or nullRequired: Intentionally public business contact number, not a customer number.
codestringRequired
isDefaultbooleanRequired
joinUrlstring or nullRequired
statusenumRequired: One of pending, active, lapsed, removed.
activatedAtstring or nullRequired
lapsedAtstring or nullRequired
removedAtstring or nullRequired
staffCountintegerRequired
suspendedbooleanRequired

Request

curl -X PATCH "https://app.revisit.cards/v1/developer/branches/e01b010d-2c65-48e1-83a0-acad79f8d3b4" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -H "Idempotency-Key: 5f0c2a8e-7b1d-4c3e-9a6f-0d4b8eea04eb" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "House 12, Road 7, Dhanmondi, Dhaka 1209",
    "name": "Dhanmondi"
  }'

Response

{
  "data": {
    "activatedAt": "2026-11-03T08:41:12.000Z",
    "address": "House 12, Road 7, Dhanmondi, Dhaka 1209",
    "code": "WELCOME10",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "isDefault": false,
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "lapsedAt": "2026-11-03T08:41:12.000Z",
    "name": "Dhanmondi",
    "phone": "01XXXXXXXXX",
    "removedAt": null,
    "staffCount": 12,
    "status": "pending",
    "suspended": false
  },
  "requestId": "e3d052e6-df3e-4556-b31f-66c64225a95a",
  "success": true
}

Close a branch while retaining history

DELETE/branches/{id}

Scopebranches:write

Requires branches:write. See business.md for key restrictions and original billing/licence rules.

Send an Idempotency-Key header. Safe to retry.

Path

iduuidRequired

Returns 200

idstringRequired
namestringRequired
addressstring or nullRequired
phonestring or nullRequired: Intentionally public business contact number, not a customer number.
codestringRequired
isDefaultbooleanRequired
joinUrlstring or nullRequired
statusenumRequired: One of pending, active, lapsed, removed.
activatedAtstring or nullRequired
lapsedAtstring or nullRequired
removedAtstring or nullRequired
staffCountintegerRequired
suspendedbooleanRequired

Request

curl -X DELETE "https://app.revisit.cards/v1/developer/branches/e01b010d-2c65-48e1-83a0-acad79f8d3b4" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -H "Idempotency-Key: 5f0c2a8e-7b1d-4c3e-9a6f-0d4b8efac533"

Response

{
  "data": {
    "activatedAt": "2026-11-03T08:41:12.000Z",
    "address": "House 12, Road 7, Dhanmondi, Dhaka 1209",
    "code": "WELCOME10",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "isDefault": false,
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "lapsedAt": "2026-11-03T08:41:12.000Z",
    "name": "Dhanmondi",
    "phone": "01XXXXXXXXX",
    "removedAt": null,
    "staffCount": 12,
    "status": "pending",
    "suspended": false
  },
  "requestId": "d0e953ea-2cc8-44fb-aa1b-a1d73192d6fc",
  "success": true
}

Activate a pending enterprise branch

POST/branches/{id}/activate

Scopebranches:write

Requires branches:write. See business.md for key restrictions and original billing/licence rules.

Send an Idempotency-Key header. Safe to retry.

Path

iduuidRequired

Returns 200

idstringRequired
namestringRequired
addressstring or nullRequired
phonestring or nullRequired: Intentionally public business contact number, not a customer number.
codestringRequired
isDefaultbooleanRequired
joinUrlstring or nullRequired
statusenumRequired: One of pending, active, lapsed, removed.
activatedAtstring or nullRequired
lapsedAtstring or nullRequired
removedAtstring or nullRequired
staffCountintegerRequired
suspendedbooleanRequired

Request

curl -X POST "https://app.revisit.cards/v1/developer/branches/e01b010d-2c65-48e1-83a0-acad79f8d3b4/activate" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -H "Idempotency-Key: 5f0c2a8e-7b1d-4c3e-9a6f-0d4b8e5a35cd"

Response

{
  "data": {
    "activatedAt": "2026-11-03T08:41:12.000Z",
    "address": "House 12, Road 7, Dhanmondi, Dhaka 1209",
    "code": "WELCOME10",
    "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
    "isDefault": false,
    "joinUrl": "https://app.revisit.cards/join/mishti-ghor",
    "lapsedAt": "2026-11-03T08:41:12.000Z",
    "name": "Dhanmondi",
    "phone": "01XXXXXXXXX",
    "removedAt": null,
    "staffCount": 12,
    "status": "pending",
    "suspended": false
  },
  "requestId": "eed9d71a-4af7-4126-ba9d-3624f3c5ca87",
  "success": true
}

Download a permitted active branch QR

GET/branches/{id}/qr

Scopebranches:read

Requires branches:read. See business.md for key restrictions and original billing/licence rules.

Path

iduuidRequired

Answers with a file: image/png.

Request

curl "https://app.revisit.cards/v1/developer/branches/e01b010d-2c65-48e1-83a0-acad79f8d3b4/qr" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -o download

Response

HTTP/1.1 200
Content-Type: image/png

(file)

Read branch geographic settings

GET/branches/{id}/geo

Scopegeo:read

Requires geo:read. See business.md for key restrictions and original billing/licence rules.

Path

iduuidRequired

Returns 200

branchobject or nullRequired
branch.addressstring or nullRequired
branch.namestringRequired
radiusMinteger or nullRequired
spotsElsewhereintegerRequired
locationsobject[]Required
locations[].idstringRequired
locations[].branchIdstring or nullRequired
locations[].labelstringRequired
locations[].latitudenumberRequired
locations[].longitudenumberRequired
locations[].messagestringRequired
locations[].zoneMintegerRequired

Request

curl "https://app.revisit.cards/v1/developer/branches/e01b010d-2c65-48e1-83a0-acad79f8d3b4/geo" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY"

Response

{
  "data": {
    "branch": {
      "address": "House 12, Road 7, Dhanmondi, Dhaka 1209",
      "name": "Dhanmondi"
    },
    "locations": [
      {
        "branchId": "5eff65d7-d01c-4bd3-b26a-3d06b21fd005",
        "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
        "label": "Morning menu",
        "latitude": 23.7465,
        "longitude": 90.376,
        "message": "Your 10th chai is on us this week.",
        "zoneM": 100
      }
    ],
    "radiusM": 100,
    "spotsElsewhere": 1
  },
  "requestId": "993f209b-e32e-45e0-913e-43b020b7cc98",
  "success": true
}

Replace branch geographic settings

PUT/branches/{id}/geo

Scopegeo:write

Requires geo:write. See business.md for key restrictions and original billing/licence rules.

Send an Idempotency-Key header. Safe to retry.

Path

iduuidRequired

Body

radiusMinteger or nullRequired
locationsobject[]Required
locations[].latitudenumberRequired: -90 to 90.
locations[].longitudenumberRequired: -180 to 180.
locations[].messagestring: No links; omitted or blank uses the existing default message.
locations[].zoneMenum: One of 100, 250, 500, 1000. Default 100.

Returns 200

branchobject or nullRequired
branch.addressstring or nullRequired
branch.namestringRequired
radiusMinteger or nullRequired
spotsElsewhereintegerRequired
locationsobject[]Required
locations[].idstringRequired
locations[].branchIdstring or nullRequired
locations[].labelstringRequired
locations[].latitudenumberRequired
locations[].longitudenumberRequired
locations[].messagestringRequired
locations[].zoneMintegerRequired

Request

curl -X PUT "https://app.revisit.cards/v1/developer/branches/e01b010d-2c65-48e1-83a0-acad79f8d3b4/geo" \
  -H "Authorization: Bearer $DEVELOPER_API_KEY" \
  -H "Idempotency-Key: 5f0c2a8e-7b1d-4c3e-9a6f-0d4b8e8e083e" \
  -H "Content-Type: application/json" \
  -d '{
    "locations": [
      {
        "latitude": 23.7465,
        "longitude": 90.376
      }
    ],
    "radiusM": 100
  }'

Response

{
  "data": {
    "branch": {
      "address": "House 12, Road 7, Dhanmondi, Dhaka 1209",
      "name": "Dhanmondi"
    },
    "locations": [
      {
        "branchId": "5eff65d7-d01c-4bd3-b26a-3d06b21fd005",
        "id": "d12cc02b-02fe-4a1f-83b0-5414e70fd99c",
        "label": "Morning menu",
        "latitude": 23.7465,
        "longitude": 90.376,
        "message": "Your 10th chai is on us this week.",
        "zoneM": 100
      }
    ],
    "radiusM": 100,
    "spotsElsewhere": 1
  },
  "requestId": "74be8c1e-4d80-4a95-8e84-602c5f9b9b7e",
  "success": true
}