Skip to content

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: retrieveSetting
json
{
    "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: retrieveSettingList
json
{
    "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
FieldTypeRequiredDescription
clientTypestringYESPlatform: ios or android.
clientVersionstringYESNative build number.
sessionIdstringInjectedSystem session.
institutionIdstringInjectedInstitution.
json
{
    "method": "nativeStartup",
    "params": {
        "clientType": "ios",
        "clientVersion": "5120"
    }
}

Response fields the app reads:

FieldMeaning
enableOfflineBarcodeGenerationOverrides get.feature.enable_offline_barcode_generation for this run.
action"block" blocks navigation (e.g. forced update).
minSupportedVersionFailure1 = this build is below the minimum; shows Update/Not now.
showMessage1 = a message should be shown.
showOnce1 = only show if the digest differs from the stored one.
messageDigestStored locally (get_nativeStartupMessageDigest) to dedupe one-time messages.
messageTitle, messageText 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:

GroupPurpose
get.featureFeature flags
get.depositDeposit limits, amounts, tenders
get.meal_planMeal-plan change/purchase
get.photo_uploadPhoto upload rules
get.mobile_credentialsWallet / mobile credential config

Feature flags ​

SettingTypeEffect
get.feature.enable_mobile_pin_entryboolShow PIN login
get.login.pin_max_failedintFailed PIN attempts before lockout
get.feature.enable_offline_barcode_generationboolGenerate barcode on-device
get.feature.enable_get_my_cardboolShow "my card" screen
get.feature.enable_open_my_doorboolMobile access / door unlock
get.feature.enable_rewardsboolRewards tab
get.feature.enable_foodboolOrdering
get.feature.enable_merchantsboolExplore / places
get.feature.notificationbell_enabledboolNotification bell
get.feature.enable_auto_depositsboolAutomatic deposits
get.feature.enable_low_balance_auto_depositboolLow-balance top-up
get.feature.enable_apple_payboolApple Pay (iOS only)
get.feature.enable_apple_walletboolAdd to Apple Wallet (iOS only)
get.feature.enable_push_notificationboolPush notifications
get.feature.enable_photo_uploadboolID photo upload
get.feature.government_photo_id_requiredboolRequire govt ID with photo
get.feature.enable_lost_cardboolReport card lost
get.feature.enable_found_cardboolReport card found
get.feature.enable_android_mobile_credentialsboolAndroid wallet credentials
get.feature.enable_account_deletionboolSelf-service account deletion
get.feature.enable_credit_card_paymentsboolCredit-card deposits
get.feature.display_credit_cardsboolShow saved cards
get.feature.enable_change_meal_planboolChange meal plan
get.feature.enable_purchase_meal_planboolBuy meal plan
get.feature.meal_donations_enabledboolMeal donation
get.ordering.disable_orderingboolKill switch for ordering
get.feature.institution_address_restrictionstringAddress restriction mode
get.feature.mobile_patron_cashless_display_media_typestringNon-empty = show the ID: label on the barcode screen; selects which display value is returned
get.feature.guest_loginboolAllow guest login
get.feature.standard_registration_linkstringExternal registration URL

Deposit settings ​

SettingMeaning
get.deposit.enable_onetime_depositsOne-time deposits
get.deposit.enable_guest_depositsGuest deposits
get.deposit.allow_freeform_onetime_amountsAllow arbitrary one-time amounts
get.deposit.onetime_amountsPreset credit-card amounts
get.deposit.onetime_minimum / onetime_maximumCredit-card bounds
get.deposit.billme_amountsPreset bill-me amounts
get.deposit.billme_minimum / billme_maximumBill-me bounds
get.deposit.billme_mappingBill-me tender mapping
get.deposit.payment_typesAllowed payment types
get.deposit.auto_deposit_payment_typesPayment types for auto-deposit
get.feature.auto_deposit_tendersTenders eligible for auto-deposit
get.feature.deposit_tenders / display_tendersVisible tenders
get.deposit.allow_freeform_low_balance_amountsFree-form low-balance amounts
get.deposit.low_balance_amountsPreset low-balance amounts
get.deposit.guest_amountsPreset guest amounts
get.deposit.guest_minimum / guest_maximumGuest bounds
get.deposit.allow_freeform_guest_amountsFree-form guest amounts

Other settings ​

SettingMeaning
soa.general.keySOA barcode encoding key (see Barcode)
soa.general.hide_timezoneHide timezone in dates
soa.email.get_feedback_emailFeedback address
soa.email.get_support_emailSupport address
get.style.custom_site_colorsBrand colors
get.credit.payment_system_typeCredit processor (MONETRA/USAEPAY)
get.user.show_classificationShow user classification
get.meal_donation.tendersTenders accepted for meal donation
get.meal_donation.allow_freeformFree-form meal donation
get.meal_donation.fixed_meal_amountsPreset meal counts
get.meal_donation.fixed_dollar_amountsPreset dollar amounts
get.photo_upload.max_upload_sizeMax photo bytes
get.feature.disable_grayedout_message_user_photoHide upload disabled message
get.mobile_credentials.enable_unlinkAllow credential unlink
get.mobile_credentials.unlink_keyX-API-Key for unlink calls
merchant.payment.removeTaxCheckoutHide tax at checkout
merchant.order.delivery_address_restrictionDelivery address restriction
merchant.order.pickup_locations_enabledPickup locations
merchant.order.order_ahead_enabledScheduled orders
merchant.order.disable_item_notesDisable item notes
merchant.order.disable_order_notesDisable order notes
merchant.order.enableAutoASAPSelectionAuto-select ASAP
merchant.tip.enable_tipTips
merchant.menu.menu_barcode_enabledScan barcode to add items
merchant.menu.menu_add_barcodea_enabledManual barcode entry
merchant.menu.menu_add_items_enabledAdd-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
FieldTypeRequiredDescription
domainstringNOContent domain, e.g. patron-ui.
categorystringYESCategory, e.g. core-ui, error_message.
namestringYESString key.
localenullNOAlways null in the app; server uses the institution locale.
sessionIdstringYESInjected.
institutionIdstringYESInjected.
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: retrieveStringList

Same 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 ​

DomainCategories
patron-uicore-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.