Legacy

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's DenialSummaryType.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the landing screen's flat counter row.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

DELETE accounts/bank-info/{id}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST|PUT accounts/bank-info/{id} — parked at metadata.bank_info (no v3 table).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST|PUT accounts/bank-info/{id} — parked at metadata.bank_info (no v3 table).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

detach the edge; member wallets stay (v2 kept them).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 replaced the whole blob.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

per-wallet loan terms, a typed 1:1 row since 0052 (wallet_overdraft_terms; v2's parking in settings.overdraft_configs ended when loans shipped in 0050). Wire echo keeps v2's major units.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

cash received by the tenant.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

one wallet's page, bare v2 paginator.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

group membership edges.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

open another wallet.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET accounts/{id}/credit-logs

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the account's current standing.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the account's current KYC standing + last gateway check.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the KYC call history for ONE account. gateway_call_logs carries no account FK (the gateway is keyed by the id document), so the account's national_id IS the join: rows whose params.id_number match it, live ∪ archive. No national_id → empty page.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT accounts/{id}/remove-groups {groups: [...]|group_id}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

close zero-balance wallets.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 GET accounts/{id}/reset-pin — v3: null the pin so the next action re-sets it.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

ONE wallet's statement, v2's composite: {transactions: paginator, counts + totals}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT accounts/{id}/status {status}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the account's statement across ALL its wallets ("all" in the wallet picker), same composite as singleWalletTransactions.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the default agent pays out.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

revoke the session behind the bearer.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

masked contact for the OTP screen.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

same token, fresh code.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the session mint.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST auth/login/send-otp-via-email/{tempToken}

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST auth/login/send-otp-via-phone/{tempToken}

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

consume the token, set the password.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the FIRST password a staff member sets from their invite/reset link. v2 set the password and handed straight into the OTP step of login (temp_token + masked contact), so the user never types the new password again.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's password gate + OTP send.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's forgot-password entry. The answer is IDENTICAL whether or not the email exists (v2 leaked account existence here; the screen only ever shows this message). Delivery rides the SMS seam — terra has no email transport yet, so the link goes to the account phone (stated in §11.15).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

DELETE beneficiary-accounts/bank-info/{id}

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

same one-bank row, edited.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 deleted unconditionally; terra refuses while money remains (agents precedent).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's updateOrCreate.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

null the till PIN so the next action re-sets it.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Active ⇄ Inactive over wallet active/frozen.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the till's statement: v2's composite of the beneficiary row + a transactions paginator (ledger legs touching the beneficiary wallet).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

edit; answers the fresh v2 rule row the store splices in.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

edit; answers the fresh v2 rule row the store splices in.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the campaign list (new sends ∪ the archived v2 history).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's single-audience view answers ONLY the resolved account count.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the audience-builder vocabulary off typed tables.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the campaign list (new sends ∪ the archived v2 history).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the per-recipient drill-down. Live and archived campaigns both page `messages WHERE campaign_id = {list id}`: live sends stamp the v3 campaign uuid at send time, migrated rows get the v2 client_messages uuid stamped by etl pass 156.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

one campaign's tallies.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's bulk send. Own Africa's Talking channel → the provider bills the business; Terra's channel → the cost comes off the company balance up front.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

resolve pasted numbers to accounts.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the section's count cards.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's messaging stat cards ({sent, failed, all} × {count, difference, percentage_change, trend}), rebuilt over terra messages (channel=sms, states sent/delivered = success — v2 counted SUCCESS message_records the same way).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET client-communication/templates/variables

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 echoed companies.addons RAW: a JSON string of [{name, status}] the dashboard JSON.parses itself. Typed rows since 0063; the wire re-encodes them. NULL when never configured (v2 parity).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 stored the whole [{name, status}] body, then echoed it.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

which SMS/WhatsApp provider the business connected. Per-tenant provider credentials land with the dispatch runtime; until then NO provider is connected, honestly.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 answered ONE company wallet — {id, code, balance, credits, debits, currency} — and the sidebar's Business Credits tile reads data.balance off that object. Project the business's own money (the etl/096 migrated company wallets + the v3-native Platform Credits pot; everything tenant-held except the migration clearing counterparty) into that shape, with lifetime ledger sums as credits/debits.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

mark a single item read.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET company/mpesa-transactions + company/unreconciled-transactions — v2 answered these BARE ({transactions: paginator}, no envelope) and the recon screens read response.data.transactions directly, so the stub keeps that shape: an empty page, honestly labeled.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the whole tenant feed, paginated (newest first).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

an empty wallet snapshot until the clearing-wallet read is ported.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

mark the tenant's unread feed read.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

RAW {series, categories}, no envelope.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

lifetime funded (money in) vs charged (money spent).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the pre-v2-card flat counts.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the dashboard's stat-block cards.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

KYC-verified vs not. Keyed off the real identity pipeline (accounts.kyc_status), NOT account status: an active account is not a verified one, and v2's card counted KYC.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the unread slice, paginated.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET company/mpesa-transactions + company/unreconciled-transactions — v2 answered these BARE ({transactions: paginator}, no envelope) and the recon screens read response.data.transactions directly, so the stub keeps that shape: an empty page, honestly labeled.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET credit-score/credit-score-summary

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's paged gateway call log.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET currency — v2 paged the company's currencies; the reference table serves all.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST dependants/bank-info/{id}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST dependants/meta-data/{id}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's dependant edit (contacts park in metadata; v3 students carry none).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's dependant edit (contacts park in metadata; v3 students carry none).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the dependant's statement, v2Page rows.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the wallet carries the limits.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

yes, a GET; v2's grammar.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT dependants/{id}/status {status}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST devices — v2's device registration.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET a list the dashboard renders — empty until the feature is ported.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the tenant's assignable catalog (seeded lazily).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

replace a device's grants.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 fleets = the vehicles; v3 models them as bus zones.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

rename the vehicle.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT devices/{id}/assign-to-beneficiary {beneficiary_id = wallet uuid}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT devices/{id}/assign-to-fleet {fleet_id}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT devices/{id}/assign-to-user {user_id}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's enable/disable = unblock/block here.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 opened a wallet of that type for EVERY member, seeded with the initial balance. The wallets open through the owner; the seed posts through the ledger as cash received (never a raw balance write). The group↔type edge is a group_wallet_types row (0054, CC-6).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

detach the edge; member wallets stay (v2 kept them).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's word pair.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

new accounts/dependants/beneficiaries per bucket.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET identity — the Smile connect screen's current state.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST identity/basic-verification

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST identity/credit-score

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST identity/enhanced-verification

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET identity/kyc-logs

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET identity/kyc-logs-summary

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT identity/providers/smile-identity/configure

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET *-totals, *-balance — an empty summary; the cards render zeros, not an error.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the rail's transaction history; empty page until a driver lands.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

an empty v2 paginator (paginate()->toArray() shape the dashboard reads).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the wearer's embed carries it.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 answered the FULL list here; /types is the paged one.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET *-totals, *-balance — an empty summary; the cards render zeros, not an error.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the rail's transaction history; empty page until a driver lands.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

an empty v2 paginator (paginate()->toArray() shape the dashboard reads).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

delivered-vs-pending series per bucket.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET *-totals, *-balance — an empty summary; the cards render zeros, not an error.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's COMPANY-level overdraft defaults (not the type list).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 refused without an over_draft wallet type first.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET *-totals, *-balance — an empty summary; the cards render zeros, not an error.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET *-totals, *-balance — an empty summary; the cards render zeros, not an error.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the rail's transaction history; empty page until a driver lands.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

an empty v2 paginator (paginate()->toArray() shape the dashboard reads).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Every money WRITE the gateways expose (fund-agent-float, pay-account-via-agent, bulk-payout-*, withdraw-from-beneficiary, topup/payout, b2b, match-transactions, topUpFallBackProcessing). A 501 — a payout that did not run must never look done.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET permissions — the closed Capability enum as the nested module → category → group → [{id, name}] tree the v2 role editor walks.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 GET profile/company-billing-info — the billing screen's bundle: subscription standing (tenants.subscription_status), the paid-invoice history as "payments", and the unpaid tail (count + next due), all from the invoices the ETL carried (etl/130).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 PUT profile/update-my-profile — the operator edits their OWN row. v2 required all four fields and wrote them verbatim; here the phone normalizes through the one Phone seam and collisions answer in the v2 envelope instead of a unique-index 500.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 PUT profile/update-password — change your OWN password: the old one must check out (v2's exact 422 message), the new one meets the v3 password bar (min:10, the SetPasswordSchema discipline) and must be confirmed. The change lands in the audit trail; a NULL hash (a §12.5 must-set-password account) fails the old-password check exactly as v2 did — that account sets its password at login, not here.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 PUT profile/v2/update-company-profile — the company settings form. Named columns land on tenants (name) / settings.v2 (nick_name); the remaining profile fields merge into the settings.company_info document the profile screen echoes back whole.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the signed embed URL for a dashboard.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET roles — staff_kind pseudo-roles + the tenant's own capability bundles, one v2 paginator.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST roles — create a tenant capability bundle (v2 role editor).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

refused while users still carry the role (WebRoleController precedent).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

a pseudo-role by slug or a tenant role by uuid.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

rename / re-scope a tenant role; pseudo-roles are read-only.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the white-label menu relabels as a FLAT {canonicalLabel: override} map, exactly as v2's MenuPersonalizationController::index answered. The dashboard shell reads menu[label] directly (sidebar, breadcrumb, the customization form), so the wrapped {vocabulary, menu_hidden} shape silently disabled every relabel; menu_hidden rides the profile payload, not this endpoint.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

save the menu relabels. v2 read {translations: {label: value}} and upserted each; a value equal to the label (or blank) is not a relabel, so it clears any existing override. Echoes the fresh flat map.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET a list the dashboard renders — empty until the feature is ported.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET a list the dashboard renders — empty until the feature is ported.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET a list the dashboard renders — empty until the feature is ported.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

edit through the owner (it busts every wearer).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

edit through the owner (it busts every wearer).

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

one limit at a time.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 limits were rows with their own ids; terra's are three nullable columns, so the wire id is synthetic ("{profileId}:{key}", minted by profileRow/add-limit) and deleting one nulls its column.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

replace the entity's tag set.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

replace the entity's tag set.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

replace the entity's tag set.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

replace the entity's tag set.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

replace the entity's tag set.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

replace the entity's tag set.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

replace the entity's tag set.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

detach one edge.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

detach one edge.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

detach one edge.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

detach one edge.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

detach one edge.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

detach one edge.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

detach one edge.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

funded/charged amount series per bucket.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's wallet "properties" vocabulary.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT type/{id}/update-status {status}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the fixed 7-day tri-chart (USSD has no v3 source: zeros).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT ussd/save-translation {translations: [{label, value, is_visible}]}

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the archived v2 session log, paged (157, 148 pattern).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the fixed catalog with the tenant's overrides folded in.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET ussd/ussd-settings

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT ussd/ussd-settings-updated (and v2's dead PUT ussd-settings alias — the UI calls both).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT ussd/ussd-settings-updated (and v2's dead PUT ussd-settings alias — the UI calls both).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the screen's config + session tallies.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 voucher-products answered a top-level ResourceCollection ({data, meta, links}).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

flip the catalog entry.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2 vouchers answered VoucherResource::collection + additional: {data, links, meta, status, message}.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

amount/expiry/status edits on unredeemed vouchers.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

amount/expiry/status edits on unredeemed vouchers.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST wallet-transaction/manuallyCharge {wallet_id, amount, description?}.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST zone/add-zone-notification {channel, event, zone, is_active, short_code_id?}.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

channel-conditional rules (v2).

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

DELETE zone/delete-zone-notification-template/{id}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

DELETE zone/delete-zone-notification/{id}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the free-form custom-field blob.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT zone/update-zone-notification-status/{id} {status: Active|Inactive}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST zone/update-zone-notification-template {id, …}.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT zone/update-zone-notification-template-status/{id} {status}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the paginated list, each with its templates.

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT zone/{id}/add-charges {beneficiary_id, charge_check_in?, charge_check_out?, frequency?}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT zone/{id}/add-group {group_id, note?, cost_per_check_in?, cost_frequency?}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

the whitelist edge.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT zone/{id}/remove-charges.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT zone/{id}/remove-group {group_id}.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

revoke it.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

v2's LARGE view: the zone + its access-log page + tap stats.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

grant tap access.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

Path parameters

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.