Appearance
Configuration & Content
Two closely related services control what the app shows:
/json/configuration— institution settings (feature flags, amounts, colors)./json/content— localized strings (labels, error text, menus).
Both are institution-scoped and use the system or user session as available.
Settings
Setting names are dot-paths
A setting name is a three-part dot path:
plaintext
{domain}.{category}.{name}For example get.feature.enable_rewards is domain get, category feature, name enable_rewards. The app splits the string and sends the parts separately:
json
{
"method": "retrieveSetting",
"params": {
"domain": "get",
"category": "feature",
"name": "enable_rewards",
"sessionId": "{SESSION_ID}",
"institutionId": "{INSTITUTION_UUID}"
}
}Two-part names (for example get.feature) omit name and are used with retrieveSettingList to fetch a whole category.
Get one setting
plaintext
POST /json/configuration
method: retrieveSettingjson
{
"method": "retrieveSetting",
"params": {
"domain": "get",
"category": "feature",
"name": "enable_food",
"sessionId": "{SESSION_ID}",
"institutionId": "{INSTITUTION_UUID}"
}
}Response:
json
{
"response": {
"id": "{SETTING_ID}",
"name": "enable_food",
"domain": "get",
"category": "feature",
"contentMediaType": 1,
"value": "1",
"description": "..."
},
"exception": null
}Get a whole category
plaintext
POST /json/configuration
method: retrieveSettingListjson
{
"method": "retrieveSettingList",
"params": {
"domain": "get",
"category": "feature",
"sessionId": "{SESSION_ID}",
"institutionId": "{INSTITUTION_UUID}"
}
}Response is a list of setting objects.
TIP
Fetching the whole get.feature category once is far cheaper than one call per flag. The app does this at startup.
Native Startup Check
Called once at startup by the native shell (never on web). Lets CBORD force an update, block navigation, show a one-time message, and remotely override the offline barcode flag.
plaintext
POST /json/configuration
method: nativeStartup| Field | Type | Required | Description |
|---|---|---|---|
clientType | string | YES | Platform: ios or android. |
clientVersion | string | YES | Native build number. |
sessionId | string | Injected | System session. |
institutionId | string | Injected | Institution. |
json
{
"method": "nativeStartup",
"params": {
"clientType": "ios",
"clientVersion": "5120"
}
}Response fields the app reads:
| Field | Meaning |
|---|---|
enableOfflineBarcodeGeneration | Overrides get.feature.enable_offline_barcode_generation for this run. |
action | "block" blocks navigation (e.g. forced update). |
minSupportedVersionFailure | 1 = this build is below the minimum; shows Update/Not now. |
showMessage | 1 = a message should be shown. |
showOnce | 1 = only show if the digest differs from the stored one. |
messageDigest | Stored locally (get_nativeStartupMessageDigest) to dedupe one-time messages. |
messageTitle, message | Text shown in the startup popover. |
The app persists enableOfflineBarcodeGeneration into its local settings, so it should be treated as authoritative over the institution setting when present.
Setting groups
The app defines these top-level groups:
| Group | Purpose |
|---|---|
get.feature | Feature flags |
get.deposit | Deposit limits, amounts, tenders |
get.meal_plan | Meal-plan change/purchase |
get.photo_upload | Photo upload rules |
get.mobile_credentials | Wallet / mobile credential config |
Feature flags
| Setting | Type | Effect |
|---|---|---|
get.feature.enable_mobile_pin_entry | bool | Show PIN login |
get.login.pin_max_failed | int | Failed PIN attempts before lockout |
get.feature.enable_offline_barcode_generation | bool | Generate barcode on-device |
get.feature.enable_get_my_card | bool | Show "my card" screen |
get.feature.enable_open_my_door | bool | Mobile access / door unlock |
get.feature.enable_rewards | bool | Rewards tab |
get.feature.enable_food | bool | Ordering |
get.feature.enable_merchants | bool | Explore / places |
get.feature.notificationbell_enabled | bool | Notification bell |
get.feature.enable_auto_deposits | bool | Automatic deposits |
get.feature.enable_low_balance_auto_deposit | bool | Low-balance top-up |
get.feature.enable_apple_pay | bool | Apple Pay (iOS only) |
get.feature.enable_apple_wallet | bool | Add to Apple Wallet (iOS only) |
get.feature.enable_push_notification | bool | Push notifications |
get.feature.enable_photo_upload | bool | ID photo upload |
get.feature.government_photo_id_required | bool | Require govt ID with photo |
get.feature.enable_lost_card | bool | Report card lost |
get.feature.enable_found_card | bool | Report card found |
get.feature.enable_android_mobile_credentials | bool | Android wallet credentials |
get.feature.enable_account_deletion | bool | Self-service account deletion |
get.feature.enable_credit_card_payments | bool | Credit-card deposits |
get.feature.display_credit_cards | bool | Show saved cards |
get.feature.enable_change_meal_plan | bool | Change meal plan |
get.feature.enable_purchase_meal_plan | bool | Buy meal plan |
get.feature.meal_donations_enabled | bool | Meal donation |
get.ordering.disable_ordering | bool | Kill switch for ordering |
get.feature.institution_address_restriction | string | Address restriction mode |
get.feature.mobile_patron_cashless_display_media_type | string | Non-empty = show the ID: label on the barcode screen; selects which display value is returned |
get.feature.guest_login | bool | Allow guest login |
get.feature.standard_registration_link | string | External registration URL |
Deposit settings
| Setting | Meaning |
|---|---|
get.deposit.enable_onetime_deposits | One-time deposits |
get.deposit.enable_guest_deposits | Guest deposits |
get.deposit.allow_freeform_onetime_amounts | Allow arbitrary one-time amounts |
get.deposit.onetime_amounts | Preset credit-card amounts |
get.deposit.onetime_minimum / onetime_maximum | Credit-card bounds |
get.deposit.billme_amounts | Preset bill-me amounts |
get.deposit.billme_minimum / billme_maximum | Bill-me bounds |
get.deposit.billme_mapping | Bill-me tender mapping |
get.deposit.payment_types | Allowed payment types |
get.deposit.auto_deposit_payment_types | Payment types for auto-deposit |
get.feature.auto_deposit_tenders | Tenders eligible for auto-deposit |
get.feature.deposit_tenders / display_tenders | Visible tenders |
get.deposit.allow_freeform_low_balance_amounts | Free-form low-balance amounts |
get.deposit.low_balance_amounts | Preset low-balance amounts |
get.deposit.guest_amounts | Preset guest amounts |
get.deposit.guest_minimum / guest_maximum | Guest bounds |
get.deposit.allow_freeform_guest_amounts | Free-form guest amounts |
Other settings
| Setting | Meaning |
|---|---|
soa.general.key | SOA barcode encoding key (see Barcode) |
soa.general.hide_timezone | Hide timezone in dates |
soa.email.get_feedback_email | Feedback address |
soa.email.get_support_email | Support address |
get.style.custom_site_colors | Brand colors |
get.credit.payment_system_type | Credit processor (MONETRA/USAEPAY) |
get.user.show_classification | Show user classification |
get.meal_donation.tenders | Tenders accepted for meal donation |
get.meal_donation.allow_freeform | Free-form meal donation |
get.meal_donation.fixed_meal_amounts | Preset meal counts |
get.meal_donation.fixed_dollar_amounts | Preset dollar amounts |
get.photo_upload.max_upload_size | Max photo bytes |
get.feature.disable_grayedout_message_user_photo | Hide upload disabled message |
get.mobile_credentials.enable_unlink | Allow credential unlink |
get.mobile_credentials.unlink_key | X-API-Key for unlink calls |
merchant.payment.removeTaxCheckout | Hide tax at checkout |
merchant.order.delivery_address_restriction | Delivery address restriction |
merchant.order.pickup_locations_enabled | Pickup locations |
merchant.order.order_ahead_enabled | Scheduled orders |
merchant.order.disable_item_notes | Disable item notes |
merchant.order.disable_order_notes | Disable order notes |
merchant.order.enableAutoASAPSelection | Auto-select ASAP |
merchant.tip.enable_tip | Tips |
merchant.menu.menu_barcode_enabled | Scan barcode to add items |
merchant.menu.menu_add_barcodea_enabled | Manual barcode entry |
merchant.menu.menu_add_items_enabled | Add-to-cart |
NOTE
Settings are strings. Booleans are "0" / "1"; always coerce with Number(value).
Content Strings
Get one string
plaintext
POST /json/content
method: retrieveString| Field | Type | Required | Description |
|---|---|---|---|
domain | string | NO | Content domain, e.g. patron-ui. |
category | string | YES | Category, e.g. core-ui, error_message. |
name | string | YES | String key. |
locale | null | NO | Always null in the app; server uses the institution locale. |
sessionId | string | YES | Injected. |
institutionId | string | YES | Injected. |
json
{
"method": "retrieveString",
"params": {
"domain": "patron-ui",
"category": "core-ui",
"name": "button_cancel",
"locale": null,
"sessionId": "{SESSION_ID}",
"institutionId": "{INSTITUTION_UUID}"
}
}Response is a string object with name, value, domain, category.
Get many strings
plaintext
POST /json/content
method: retrieveStringListSame parameters; used with a category to fetch all strings at once. Response:
json
{
"response": {
"list": [
{ "name": "button_cancel", "value": "Cancel" },
{ "name": "button_ok", "value": "OK" }
]
},
"exception": null
}The app treats an empty list as [] and tolerates response.empty.
Known content domains
| Domain | Categories |
|---|---|
patron-ui | core-ui, mobile-access, rewards, accounts, transactions, location_disclosure_screen, meal_donation, ordering, login_screen, registration, mobile-credential, deposit, photo_upload, notifications, error_message |
| (root) | month_abbreviated, day-of-week_abbreviated, us_states, us-state_full, error_message, ordering, menu |
TIP
Error text such as NoSuchSessionException lives under patron-ui.error_message.* and is the same set the app maps after receiving exception strings. See the Error Reference.