Skip to main content

Endpoint Map

Reference document mapping every backend endpoint to its consumer(s).

Legend: C = Customer portal, S = Support portal, A = Android app, T = tx-bundler Status: wired | recommended | n/a

merchant-api​

AuthController​

EndpointCSA
GET /api/v1/auth/mewiredwiredn/a
POST /api/v1/auth/change-passwordwiredn/an/a

BatchController (/api/v1/orgs/{orgId}/stores/{storeId}/batches)​

EndpointCSA
GET .../batcheswiredn/awired (terminal-api)
GET .../batches/{batchId}wiredn/awired (terminal-api)
POST .../batches/{batchId}/settlewiredn/awired (terminal-api)

CategoryController (/api/v1/orgs/{orgId}/categories)​

EndpointCSA
GET .../categorieswiredn/an/a
GET .../categories/treewiredn/an/a
GET .../categories/{categoryId}wiredn/an/a
POST .../categorieswiredn/an/a
PUT .../categories/{categoryId}wiredn/an/a
DELETE .../categories/{categoryId}wiredn/an/a

ComplianceController (/api/v1/stores/{storeId}/compliance)​

EndpointCSA
GET .../compliancewiredn/an/a
GET .../compliance/{checkId}wiredn/an/a
GET .../compliance/summarywiredn/an/a
POST .../compliance/verify-agen/an/awired (terminal-api)
POST .../compliance/overridewiredn/awired (terminal-api)

CustomerController (/api/v1/orgs/{orgId}/customers)​

EndpointCSA
GET .../customerswiredn/an/a
GET .../customers/{customerId}wiredn/an/a
POST .../customerswiredn/awired (terminal-api, ID scan)
PUT .../customers/{customerId}wiredn/an/a
POST .../customers/{customerId}/pointswiredn/an/a
DELETE .../customers/{customerId}wiredn/an/a

DeviceTokenController​

EndpointCSA
POST /api/v1/deviceswiredwiredwired (terminal-api)
DELETE /api/v1/deviceswiredwiredwired (terminal-api)
GET /api/v1/deviceswiredn/an/a

DiscountController (/api/v1/stores/{storeId}/discounts)​

EndpointCSA
GET .../discountswiredn/an/a
GET .../discounts/{id}wiredn/an/a
GET .../discounts/activewiredn/awired
POST .../discountswiredn/an/a
PUT .../discounts/{id}wiredn/an/a
DELETE .../discounts/{id}wiredn/an/a
POST .../discounts/{id}/togglewiredn/an/a

HealthController​

EndpointCSA
GET /healthwiredwiredn/a

InventoryController (/api/v1/stores/{storeId}/inventory)​

EndpointCSA
GET .../inventorywiredn/an/a
GET .../inventory/{id}wiredn/an/a
GET .../inventory/{id}/historywiredn/an/a
POST .../inventory/receivewiredn/an/a
POST .../inventory/adjustwiredn/an/a
POST .../inventory/transferwiredn/an/a

InviteController (standalone, unauthenticated)​

EndpointCSA
POST /api/v1/invites/validatewiredn/an/a
POST /api/v1/invites/acceptwiredn/an/a

MkonnektController​

EndpointCSA
POST .../mkonnekt/skandatan/an/awired

NotificationController (/api/v1/orgs/{orgId}/notifications)​

EndpointCSA
GET .../notificationswired (read-only)wiredwired (terminal-api)
GET .../notifications/unread-countwiredwiredwired
GET .../notifications/{id}wiredwiredwired
POST .../notifications/{id}/readwiredwiredwired
POST .../notifications/read-allwiredwiredwired
POST .../notifications (create)n/awiredn/a
DELETE .../notifications/{id}n/awiredn/a

OnboardingController (/api/v1/stores/{storeId}/onboarding)​

EndpointCSA
GET .../onboarding/statuswiredn/an/a
POST .../onboarding/completewiredn/an/a

OrgActivityLogController (/api/v1/orgs/{orgId}/activity-log)​

EndpointCSA
GET .../activity-logwiredwiredn/a

OrgInviteController (/api/v1/orgs/{orgId}/invites)​

EndpointCSA
GET .../inviteswiredn/an/a
POST .../inviteswiredn/an/a
POST .../invites/{id}/revokewiredn/an/a
DELETE .../invites/{id}n/an/an/a

OrgMemberController (/api/v1/orgs/{orgId}/members)​

EndpointCSA
GET .../memberswiredwiredn/a
POST .../memberswiredwiredn/a
PUT .../members/{userId}wiredwiredn/a
DELETE .../members/{userId}wiredwiredn/a

OrgSerialNumberController (/api/v1/orgs/{orgId}/serial-numbers)​

EndpointCSA
GET .../serial-numberswiredn/an/a
GET .../serial-numbers/{serialId}wiredn/an/a
GET .../serial-numbers/lookup/{serial}wiredn/awired
POST .../serial-numberswiredn/an/a
POST .../serial-numbers/{id}/sellwiredn/awired
POST .../serial-numbers/{id}/returnwiredn/awired

PinAuthController (/api/v1/stores/{storeId}/auth)​

EndpointCSA
POST .../auth/pin-loginn/an/awired (terminal-api)

ProductController (/api/v1/stores/{storeId}/products)​

EndpointCSA
GET .../productswiredn/awired (terminal-api sync)
GET .../products/{id}wiredn/an/a
GET .../products/barcode/{barcode}wiredn/awired
GET .../products/typeswiredn/an/a
POST .../productswiredn/an/a
PUT .../products/{id}wiredn/an/a
DELETE .../products/{id}wiredn/an/a

ProductImageController (/api/v1/orgs/{orgId}/products/{productId}/image)​

EndpointCSA
POST .../imagewiredn/an/a
DELETE .../imagewiredn/an/a

PromotionController (/api/v1/orgs/{orgId}/promotions)​

EndpointCSA
GET .../promotionswiredn/an/a
GET .../promotions/activewiredn/awired
GET .../promotions/{id}wiredn/an/a
POST .../promotionswiredn/an/a
PUT .../promotions/{id}wiredn/an/a
DELETE .../promotions/{id}wiredn/an/a
POST .../promotions/{id}/togglewiredn/an/a

ReturnController (/api/v1/stores/{storeId}/returns)​

EndpointCSA
GET .../returnswiredn/an/a
GET .../returns/{id}wiredn/an/a
POST .../returnswiredn/awired (terminal-api)

SettingsController (/api/v1/stores/{storeId}/settings)​

EndpointCSA
GET .../settingswiredn/an/a
PUT .../settingswiredn/an/a
PUT .../settings/timezonewiredn/an/a
PUT .../settings/dual-pricingwiredn/an/a
PUT .../settings/operating-hourswiredn/an/a

ShiftController (/api/v1/stores/{storeId}/shifts)​

EndpointCSA
GET .../shifts/preferenceswiredn/an/a
GET .../shifts/preferences/mewiredn/awired
POST .../shifts/preferenceswiredn/an/a
PUT .../shifts/preferences/{id}wiredn/an/a
DELETE .../shifts/preferences/{id}wiredn/an/a
GET .../shifts/assignedwiredn/awired
POST .../shifts/assignedwiredn/an/a
PUT .../shifts/assigned/{id}wiredn/an/a
DELETE .../shifts/assigned/{id}wiredn/an/a
GET .../shifts/statuswiredn/awired
POST .../shifts/clock-inwiredn/awired
POST .../shifts/clock-outwiredn/awired
GET .../shifts/requestswiredn/awired
GET .../shifts/requests/pendingwiredn/an/a
POST .../shifts/requestswiredn/awired
POST .../shifts/requests/{id}/reviewwiredn/an/a
GET .../shifts/blockswiredn/an/a
POST .../shifts/blockswiredn/an/a
PUT .../shifts/blocks/{blockId}wiredn/an/a
DELETE .../shifts/blocks/{blockId}wiredn/an/a

StockTransferController (/api/v1/orgs/{orgId}/stock-transfers)​

EndpointCSA
GET .../stock-transferswiredn/awired
GET .../stock-transfers/{id}wiredn/an/a
POST .../stock-transferswiredn/an/a
POST .../stock-transfers/{id}/shipwiredn/an/a
POST .../stock-transfers/{id}/receivewiredn/awired
POST .../stock-transfers/{id}/cancelwiredn/an/a

StoreActivityLogController (/api/v1/stores/{storeId}/activity-log)​

EndpointCSA
GET .../activity-logwiredwiredn/a
GET .../activity-log/actionswiredwiredn/a
GET .../activity-log/entity-typeswiredwiredn/a
GET .../activity-log/user/{userId}wiredwiredn/a
GET .../activity-log/{logId}wiredwiredn/a

StoreInviteController (/api/v1/stores/{storeId}/invites)​

EndpointCSA
GET .../inviteswiredn/an/a
POST .../inviteswiredn/an/a
POST .../invites/{id}/revokewiredn/an/a
DELETE .../invites/{id}wiredn/an/a

StoreMemberController (/api/v1/stores/{storeId}/members)​

EndpointCSA
GET .../memberswiredn/an/a
POST .../memberswiredn/an/a
PUT .../members/{userId}wiredn/an/a
DELETE .../members/{userId}wiredn/an/a

SupplierController (/api/v1/orgs/{orgId}/suppliers)​

EndpointCSA
GET .../supplierswiredn/an/a
GET .../suppliers/{id}wiredn/an/a
GET .../suppliers/{id}/productswiredn/an/a
POST .../supplierswiredn/an/a
PUT .../suppliers/{id}wiredn/an/a
DELETE .../suppliers/{id}wiredn/an/a
POST .../suppliers/{id}/productswiredn/an/a
DELETE .../suppliers/{id}/products/{productId}wiredn/an/a

TaxConfigController (/api/v1/stores/{storeId}/tax-configs)​

EndpointCSA
GET .../tax-configswiredn/an/a
GET .../tax-configs/activewiredn/an/a
GET .../tax-configs/{id}wiredn/an/a
POST .../tax-configswiredn/an/a
PUT .../tax-configs/{id}wiredn/an/a
DELETE .../tax-configs/{id}wiredn/an/a

TerminalController (merchant-api) (/api/v1/orgs/{orgId}/stores/{storeId}/terminals)​

EndpointCSA
GET .../terminalswiredwired (via mgmt-api)n/a
GET .../terminals/{id}wiredwired (via mgmt-api)n/a
POST .../terminalsn/awired (via mgmt-api)n/a
PUT .../terminals/{id}n/awired (via mgmt-api)n/a
POST .../terminals/{id}/regenerate-secretn/awiredn/a
POST .../terminals/{id}/heartbeatn/an/awired (terminal-api)
GET .../terminals/{id}/payment-configwiredn/an/a
DELETE .../terminals/{id}n/awired (via mgmt-api)n/a

TransactionController (merchant-api) (/api/v1/orgs/{orgId}/stores/{storeId}/transactions)​

EndpointCSA
GET .../transactionswiredn/awired (terminal-api)
GET .../transactions/{id}wiredn/awired (terminal-api)
GET .../transactions/summarywiredn/an/a
GET .../transactions/daily-saleswiredn/an/a
POST .../transactions/{id}/voidwiredn/awired (terminal-api)

UserController (/api/v1/orgs/{orgId}/stores/{storeId}/users)​

EndpointCSA
GET .../userswiredn/an/a
PUT .../users/{userId}wiredn/an/a
POST .../users/{userId}/activatewiredn/an/a
POST .../users/{userId}/deactivatewiredn/an/a

UserPinController (/api/v1/orgs/{orgId}/stores/{storeId}/users)​

EndpointCSA
PUT .../users/{userId}/pinwiredn/awired

IntegrationController (/api/v1/orgs/{orgId}/integrations)​

EndpointCSA
GET .../integrationswiredn/an/a
GET .../integrations/{id}wiredn/an/a
POST .../integrationswiredn/an/a
PUT .../integrations/{id}wiredn/an/a
DELETE .../integrations/{id}wiredn/an/a
POST .../integrations/{id}/togglewiredn/an/a

LoyaltyController (/api/v1/orgs/{orgId}/loyalty)​

EndpointCSA
GET .../loyalty/programswiredn/an/a
GET .../loyalty/programs/{programId}wiredn/an/a
POST .../loyalty/programswiredn/an/a
PUT .../loyalty/programs/{programId}wiredn/an/a
DELETE .../loyalty/programs/{programId}wiredn/an/a
GET .../loyalty/programs/{programId}/tierswiredn/an/a
POST .../loyalty/programs/{programId}/tierswiredn/an/a
PUT .../loyalty/programs/{programId}/tiers/{tierId}wiredn/an/a
DELETE .../loyalty/programs/{programId}/tiers/{tierId}wiredn/an/a
GET .../loyalty/programs/{programId}/rewardswiredn/an/a
POST .../loyalty/programs/{programId}/rewardswiredn/an/a
PUT .../loyalty/programs/{programId}/rewards/{rewardId}wiredn/an/a
DELETE .../loyalty/programs/{programId}/rewards/{rewardId}wiredn/an/a
GET .../loyalty/customers/{customerId}wiredn/awired (terminal-api)

OrgUserController (/api/v1/orgs/{orgId}/users)​

EndpointCSA
GET .../userswiredn/an/a

StoreController (merchant-api) (/api/v1/orgs/{orgId}/stores)​

EndpointCSA
GET .../storeswiredn/an/a
GET .../stores/{storeId}wiredn/an/a
PUT .../stores/{storeId}wiredn/an/a

UpsellController (/api/v1/stores/{storeId}/upsells)​

EndpointCSA
GET .../upsellswiredn/an/a
GET .../upsells/{id}wiredn/an/a
POST .../upsells/recommendationswiredn/an/a
POST .../upsellswiredn/an/a
PUT .../upsells/{id}wiredn/an/a
DELETE .../upsells/{id}wiredn/an/a
POST .../upsells/{id}/togglewiredn/an/a

IamCatalogController (/api/v1/orgs/{orgId}/iam/permissions)​

EndpointCSA
GET .../permissionswiredn/an/a

IamGroupController (/api/v1/orgs/{orgId}/iam/groups)​

EndpointCSA
GET .../groupswiredn/an/a
POST .../groupswiredn/an/a
GET .../groups/{groupId}wiredn/an/a
PUT .../groups/{groupId}wiredn/an/a
DELETE .../groups/{groupId}wiredn/an/a

IamRoleController (/api/v1/orgs/{orgId}/iam/roles)​

EndpointCSA
GET .../roleswiredn/an/a
POST .../roleswiredn/an/a
GET .../roles/{roleId}wiredn/an/a
PUT .../roles/{roleId}wiredn/an/a
DELETE .../roles/{roleId}wiredn/an/a
GET .../roles/users/{userId}wiredn/an/a
POST .../roles/users/{userId}wiredn/an/a
DELETE .../roles/users/{userId}/{roleId}wiredn/an/a

InternalController (/internal/v1/orgs)​

EndpointCSA
POST .../{orgId}/superadminn/an/an/a
GET .../{orgId}/ownersn/an/an/a
POST .../{orgId}/owners/{userId}/activaten/an/an/a
DELETE .../{orgId}/owners/{userId}n/an/an/a

InternalSessionController (/internal/v1/sessions)​

EndpointCSA
POST .../usersn/an/an/a
DELETE .../users/{userId}n/an/an/a

terminal-api (mTLS auth, Android only)​

EndpointA
GET /healthn/a
POST /v1/auth/pinwired
GET /v1/terminal/configwired
POST /v1/terminal/heartbeatwired
POST /v1/terminal/renew-certwired
GET /v1/sync/productswired
GET /v1/sync/products/countwired
GET /v1/sync/config-versionwired
GET /v1/transactionswired
GET /v1/transactions/{id}wired
POST /v1/transactionswired
PUT /v1/transactions/{id}/statuswired
PUT /v1/transactions/{id}/tipwired
POST /v1/transactions/{id}/voidwired
POST /v1/transactions/{id}/card-authorizationswired
GET /v1/batcheswired
GET /v1/batches/{id}wired
POST /v1/batcheswired
POST /v1/batches/{id}/closewired
POST /v1/batches/{id}/settlewired
POST /internal/v1/batches/{id}/settlen/a
POST /v1/compliance/verifywired
POST /v1/compliance/overridewired
POST /v1/customerswired
POST /v1/deviceswired
DELETE /v1/deviceswired
GET /v1/notificationswired
GET /v1/notifications/unread-countwired
POST /v1/notifications/{id}/readwired
POST /v1/notifications/read-allwired
POST /v1/returnswired
POST /v1/loyalty/redeemwired

Internal (service-to-service only)​

EndpointCaller
POST /internal/v1/devices/{terminalId}/commandmanagement-api

terminal-onboarding (Android only)​

EndpointA
GET /healthn/a
POST /v1/onboarding/pollwired
POST /v1/onboarding/certificatewired
POST /v1/onboarding/internal/renew-certificaten/a

management-api (Firebase JWT, support portal via /management/ LB path)​

EndpointCS
GET /healthn/an/a
GET /api/v1/auth/men/awired
GET /api/v1/orgsn/awired
POST /api/v1/orgsn/awired
GET /api/v1/orgs/{orgId}n/awired
PUT /api/v1/orgs/{orgId}n/awired
DELETE /api/v1/orgs/{orgId}n/awired
POST /api/v1/orgs/{orgId}/activaten/awired
POST /api/v1/orgs/{orgId}/superadminn/awired
GET .../storeswiredwired
POST .../storesn/awired
GET .../stores/{storeId}wiredwired
PUT .../stores/{storeId}wiredwired
DELETE .../stores/{storeId}n/awired
POST .../stores/{storeId}/activaten/awired
GET /api/v1/orgs/{orgId}/stores/{storeId}/terminalsn/awired
GET .../terminals/{id}n/awired
POST .../terminalsn/awired
PUT .../terminals/{id}n/awired
DELETE .../terminals/{id}n/awired
POST .../terminals/{id}/revoken/awired
POST .../terminals/{id}/onboarding-tokensn/awired
POST .../terminals/{id}/onboarding-tokens/{tokenId}/confirmn/awired
GET .../terminals/{id}/payment-confign/awired
PUT .../terminals/{id}/payment-confign/awired
GET /api/v1/orgs/{orgId}/notificationsn/awired
GET /api/v1/orgs/{orgId}/notifications/unread-countn/awired
GET /api/v1/orgs/{orgId}/notifications/{id}n/awired
POST /api/v1/orgs/{orgId}/notificationsn/awired
POST /api/v1/orgs/{orgId}/notifications/{id}/readn/awired
POST /api/v1/orgs/{orgId}/notifications/read-alln/awired
DELETE /api/v1/orgs/{orgId}/notifications/{id}n/awired
GET /api/v1/staffn/awired
DELETE /api/v1/staff/{userId}n/awired
POST /api/v1/staff/{userId}/activaten/awired
GET /api/v1/staff/invitesn/awired
POST /api/v1/staff/invitesn/awired
POST /api/v1/staff/invites/{inviteId}/revoken/awired
DELETE /api/v1/staff/invites/{inviteId}n/awired
POST /api/v1/staff/invites/validaten/awired
POST /api/v1/staff/invites/acceptn/awired
GET /api/v1/support/ticketsn/awired
GET /api/v1/support/tickets/{ticketId}n/awired
GET /api/v1/support/knowledgen/awired
GET /api/v1/support/knowledge/{articleId}n/awired
GET /api/v1/admin/reports/overviewn/awired
GET /api/v1/admin/reports/orgsn/awired
GET /api/v1/admin/reports/terminalsn/awired
GET /api/v1/admin/reports/transactionsn/awired
GET /api/v1/admin/reports/onboardingn/awired
GET /api/v1/admin/email/suppressionsn/an/a
DELETE /api/v1/admin/email/suppressions/{email}n/an/a
GET /api/v1/orgs/{orgId}/ownersn/awired
POST /api/v1/orgs/{orgId}/owners/{userId}/activaten/awired
DELETE /api/v1/orgs/{orgId}/owners/{userId}n/awired
POST /api/v1/support/sessionsn/awired
GET /api/v1/support/sessions/activen/awired
DELETE /api/v1/support/sessions/{sessionId}n/awired
GET /api/v1/demosn/awired
GET /api/v1/demos/{name}n/awired
POST /api/v1/demosn/awired
DELETE /api/v1/demos/{name}n/awired

Fleet & Geofence​

EndpointCS
GET /api/v1/admin/fleet/{orgId}/devicesn/awired
GET /api/v1/admin/fleet/{orgId}/devices/{terminalId}n/awired
POST /api/v1/admin/fleet/{orgId}/devices/{terminalId}/restartn/awired
POST /api/v1/admin/fleet/{orgId}/devices/{terminalId}/app-restartn/awired
POST /api/v1/admin/geofencesn/awired
GET /api/v1/admin/geofences/org/{orgId}n/awired
PUT /api/v1/admin/geofences/{geofenceId}n/awired
DELETE /api/v1/admin/geofences/{geofenceId}n/awired
GET /api/v1/admin/geofences/violations/org/{orgId}n/awired
POST /api/v1/admin/geofences/violations/{violationId}/resolven/awired

tx-bundler (Firebase JWT, via /integrations/ LB path)​

HealthController​

EndpointCS
GET /healthn/an/a

IntegrationRuntimeController (/api/v1/orgs/{orgId}/integrations/runtime)​

EndpointCS
GET .../runtimewiredn/a
POST .../runtime/syncwiredn/a
POST .../runtime/{integrationId}/syncwiredn/a

ReportController (/api/v1/stores/{storeId}/reports)​

EndpointCS
GET .../reports/dashboardwiredwired
GET .../reports/dashboard/streamwiredn/a
GET .../reports/saleswiredwired
GET .../reports/inventorywiredwired
GET .../reports/memberswiredwired

ExportController (/api/v1/stores/{storeId}/export)​

EndpointCS
GET .../export/transactionswiredwired
GET .../export/saleswiredwired
GET .../export/inventorywiredwired
GET .../export/batcheswiredwired

OAuthCallbackController​

EndpointCS
GET /api/v1/orgs/{orgId}/integrations/quickbooks/authorizewiredn/a
GET /api/v1/quickbooks/callbackn/an/a
POST /api/v1/orgs/{orgId}/integrations/quickbooks/{integrationId}/disconnectwiredn/a
GET /api/v1/orgs/{orgId}/integrations/freshbooks/authorizewiredn/a
GET /api/v1/freshbooks/callbackn/an/a
POST /api/v1/orgs/{orgId}/integrations/freshbooks/{integrationId}/disconnectwiredn/a
GET /api/v1/orgs/{orgId}/integrations/xero/authorizewiredn/a
GET /api/v1/xero/callbackn/an/a
POST /api/v1/orgs/{orgId}/integrations/xero/{integrationId}/disconnectwiredn/a
GET /api/v1/orgs/{orgId}/integrations/gusto/authorizewiredn/a
GET /api/v1/gusto/callbackn/an/a
POST /api/v1/orgs/{orgId}/integrations/gusto/{integrationId}/disconnectwiredn/a
GET /api/v1/orgs/{orgId}/integrations/uber-eats/authorizewiredn/a
GET /api/v1/uber-eats/callbackn/an/a
POST /api/v1/orgs/{orgId}/integrations/uber-eats/{integrationId}/disconnectwiredn/a

QuickBooksWebhookController​

EndpointCS
POST /api/v1/quickbooks/webhookn/an/a

FreshBooksWebhookController​

EndpointCS
POST /api/v1/freshbooks/webhookn/an/a

XeroWebhookController​

EndpointCS
POST /api/v1/xero/webhookn/an/a

GustoWebhookController​

EndpointCS
POST /api/v1/gusto/webhookn/an/a

UberEatsWebhookController​

EndpointCS
POST /api/v1/uber-eats/webhookn/an/a

status (internal, no auth)​

The status service is an internal health-check aggregator. It polls the Cloud Run API for every other service and returns a combined status. Not consumed by any portal; used by uptime monitoring and ops dashboards.

HealthController​

EndpointConsumer
GET /monitoring / ops
GET /healthmonitoring / ops

Both endpoints return identical responses. CloudRunHealthService checks: pinpointpos-merchant-api, pinpointpos-management-api, pinpointpos-terminal-api, pinpointpos-terminal-onboarding, pinpointpos-tx-bundler.

Recommendations (not yet wired)​

All mapped endpoints are currently implemented for the active portal surfaces in this repository.