Appearance
GET Mobile API Overview
This section documents the raw CBORD GETServices API that the GET Mobile app talks to. It is different from the API Wrapper: the wrapper exposes friendly /api/v2/* endpoints with snake_case parameters, while GET Mobile speaks a single RPC envelope against /GETServices/services/json/* with camelCase parameters.
WARNING
Everything here was reverse engineered from GET Mobile 5.1.20 (com.cbord.getmobile, build 5.1.20). CBORD can change any of it at any time. Treat the app's behavior as the source of truth, not this document.
Base URL
Every request is sent to the environment's services_url plus a service path:
plaintext
POST {services_url}/json/{service}services_url already includes /GETServices/services:
plaintext
https://services.get.cbord.com/GETServices/services/json/authenticationEnvironments
The app ships several environments and picks one at runtime from the hostname it was launched from. The full list of hard-coded environments is:
| Environment | services_url | Partner services URL | Image URL |
|---|---|---|---|
production | https://services.get.cbord.com/GETServices/services | https://api.partnerpayments.cbord.com | https://object-store.api.cbord.com/image/ |
demo | https://services.get.demo.cbord.com/GETServices/services | https://api.payments.demo.cbord.com | https://object-store.api.demo.cbord.com/image/ |
demoUK | https://services.get.uk.demo.cbord.com/GETServices/services | https://api.payments.uk.demo.cbord.com | https://object-store.api.uk.demo.cbord.com/image/ |
feature1 | https://services.get.feature1.cbord.com/GETServices/services | — | https://3bulchr7pb.execute-api.us-east-1.amazonaws.com/dev/image/ |
develop | https://services.get.dev.cbord.com/GETServices/services | https://api.partnerpayments.pat.cbord.com | https://3bulchr7pb.execute-api.us-east-1.amazonaws.com/dev/image/ |
prodCanada | https://services.get.ca.cbord.com/GETServices/services | https://api.partnerpayments.ca.cbord.com | — |
prodUK | https://services.get.uk.cbord.com/GETServices/services | https://api.partnerpayments.uk.cbord.com | https://object-store.api.uk.cbord.com/image/ |
There are also site URLs used for web flows:
| Environment | site_url |
|---|---|
production | https://get.cbord.com |
demo | https://get.demo.cbord.com |
demoUK | https://get.uk.demo.cbord.com |
feature1 | https://get.feature1.cbord.com |
develop | https://get.dev.cbord.com |
prodCanada | https://get.ca.cbord.com |
prodUK | https://get.uk.cbord.com |
The internal environment enum is develop = 0, feature1 = 1, demo = 4, production = 5. Canada/UK are selected by hostname string rather than enum value.
NOTE
services.get.<env>.cbord.com also exposes GETServices/metrics/ping (the app derives it by replacing the trailing /services with /metrics/ping). This is the cheapest way to check whether a region is up.
Request Envelope
Every call is a POST with a JSON body:
http
POST /GETServices/services/json/{service} HTTP/1.1
Host: services.get.cbord.com
Accept: application/json
Content-Type: application/jsonjson
{
"method": "retrieve",
"params": {
"sessionId": "{SESSION_ID}",
"institutionId": "{INSTITUTION_ID}"
}
}Only two top-level keys are sent. The app has a small RpcRequest object internally with method, params, useSessionId, useInstitutionId, and timeOut; the last three are transport hints and are not serialized.
Automatic sessionId / institutionId injection
The HTTP interceptor post-processes the body before sending:
- If the request is flagged
useInstitutionId, it addsparams.institutionIdusing the cached institution id. - If the request is flagged
useSessionIdand the params do not already contain asessionId, it addsparams.sessionIdusing the cached user session (get_sessionId). - Only when no user session is cached does it mint a system session with
authenticateSystemand use that.
This means you can call most methods with only their business parameters and let the client fill in ids — but if you are writing your own client you must inject them yourself. See Two Session Types for the difference between the system session, the user session, and the hosted-page token.
Timeouts
Default request timeout is 30000 ms. The partner-services HTTP client uses 45000 ms.
Response Envelope
All JSON services return the same wrapper:
json
{
"response": { },
"exception": null
}- On success,
exceptionisnullandresponseholds the payload. - On failure,
exceptionis a string, usually"{code}|{detail}", andresponsemay benull.
json
{
"response": null,
"exception": "NoSuchSessionException|Invalid session"
}The app parses the exception string before the | as the code and after it as detail, then maps the code to a friendly message. See Error Codes.
Error codes
The app only has hard-coded English overrides for a subset. These are the exact mappings in main-IYCQJYRJ.js:
| Code | Default message |
|---|---|
9004 | There was an issue with the transaction, user phone number missing and required |
9999 | Unable to parse response |
4001 | Session not found |
4002 | No user associated with this session |
9801 | Invalid Service Argument Exception |
6100 | There was an issue with your transaction. Contact your institution for more details. |
6100 is special-cased per method:
| Method | Message |
|---|---|
deposit | There was an issue with the transaction |
depositForUserFromAnyAccount | There was an issue with the transaction |
sale | Your billing information does not match your credit card. |
getMobileLocations | Unable to retrieve mobile locations. |
Any code of the form NNNN|text that is not recognized still keeps NNNN as the code; the raw text is surfaced as the error message. See the Error Reference for the full list of exceptions the app maps.
The Service Map
Services are dispatched by URL path under /json/:
| Service path | Purpose |
|---|---|
/json/authentication | system/user/PIN/session-token login, barcode payload, external tokens |
/json/user | profile, settings, addresses, photos, notifications, card lost/found |
/json/userNotification | in-app notification log |
/json/commerce | accounts, deposits, transactions, donations |
/json/institution | institution records, photos, buildings, lookup lists |
/json/configuration | institution settings |
/json/content | localized strings |
/json/merchant | merchant search, menus, favorites, delivery |
/json/ordering | order validation, submission, check-in, schedules, history |
/json/rewards | reward tracks, levels, store, claims, history |
/json/notification | password-reset email |
The rewards path is only used when the institution enables GET Rewards. Rewards are documented in Rewards. Mobile Access lives on /json/commerce; see Mobile Access.
Authentication Flow
- Optionally
POST /json/authenticationauthenticateSystem— a system session for anonymous/institution-scoped calls (settings, content, institutions, menus). The app mints it lazily and keeps it in memory only. POST /json/authenticationauthenticateUser— exchanges username/password (orauthenticateGuestUser) for a user session id. This does not require step 1. Institutions whoseauthenticationInfo.authenticationTypeisCAS,SSO_GENERICorOKTA_EXTskip this call: the app runs the hosted browser login instead and lifts the session id out of the return URL.- Send the user session id as
params.sessionIdon all patron calls; keep the system session for pre-login calls. Most methods are flaggeduseSessionId, so a general client can simply attach whichever session it holds. - When logged in,
getAuthenticationTokenturns the current session into asession_tokenfor CBORD-hosted web pages.
See Authentication for full request/response examples and the session resolution order.
Method Index
Every RPC method string found in the bundle, grouped by service:
Authentication
authenticateSystem, authenticateUser, authenticateGuestUser, authenticatePIN, authenticateSessionToken, getAuthenticationToken, retrievePatronBarcodePayload, retrieveExternalAuthenticationToken, retrieveAuthorizationBlob
User
retrieve, update, createPIN, changePassword, updateUserStatus, reportCardLost, reportCardFound, addUserPhoto, retrieveUserPhoto, retrieveUserPhotoList, retrieveFullUserPhotoList, retrievePendingOrRejectedUserPhoto, updateUserPhotoStatus, retrieveUserAddressList, updateUserAddress, deleteUserAddress, addressToGeocode, retrieveSetting, saveSetting, deleteSetting, requestDeposit, retrieveUserIdByCashlessFields, saveNotification, logoutAndRemoveUserNotification, retrieveAllUserNotifications, retrieveAutoDepositSettings, updateAutoDepositSettings, retrieveRegistrationFields, register
Commerce
retrieveAccounts, deactivateAccount, retrieveCashlessPatronMobileDisplayMediaValue, retrieveTransactionHistory, retrieveTransactionHistoryWithinDateRange, calculateDepositFee, deposit, donate, createAccount, retrieveAccountsByUser, retrieveDepositAccountsByUser, depositForUserFromAnyAccount, retrieveCreditPaymentMethodsByPaymentSystem, retrieveAutoDepositAccountList, getMobileLocations, activateMobileLocation
Institution
retrieve, retrieveByShortName, retrieveInstitutionPhoto, retrieveLookupList, retrieveAnonymousDepositFields, retrieveBuildings
Configuration / Content
retrieveSetting, retrieveSettingList, nativeStartup, retrieveString, retrieveStringList
Merchant
getMerchants, getMenuMerchants, getFavoriteMerchants, addFavoriteMerchant, removeFavoriteMerchant, getMerchantSettings, retrievePickupAddressesInRange, isOutsideMerchantDeliveryArea, getMerchantPaymentAccountsWithFilter, getDisplayMenu, getDisplayMenus
Ordering
retrieveSuccessfulOrdersList, retrieveOrderList, getMerchantOrderSchedule, validateOrder, validateOrderItems, validateOrderAddOns, addItemsToOrder, cancelOrder, submitOrder, checkInOrder
Rewards
retrieveUserRewardTrackInfo, retrieveUserRewardHistory, optUserIntoRewardTrack, claimRewardV2
Password reset
resetPasswordNotification (on /json/notification)
Notifications
createUserNotificationLog, retrieveAll, retrive, markUserNotificationLogAsViewed, markUserNotificationLogAsDismissed, updatePinnedOnUserNotificationLog, getNotificationLogCount, markAllUserNotificationLogAsViewed
NOTE
retrive (missing an e) is the literal method name the app sends. Do not "fix" it.
Quick Start
bash
BASE="https://services.get.cbord.com/GETServices/services"
# 1. get a system session
curl -s "$BASE/json/authentication" \
-H 'Content-Type: application/json' \
-d '{"method":"authenticateSystem","params":{"systemCredentials":{"domain":"","userName":"get_mobile","password":"NOTUSED"}}}'
# 2. log in
curl -s "$BASE/json/authentication" \
-H 'Content-Type: application/json' \
-d '{"method":"authenticateUser","params":{"systemCredentials":{"domain":"","userName":"get_mobile","password":"NOTUSED"},"userCredentials":{"userName":"USER","password":"PASS","domain":"","institutionId":"INSTITUTION_UUID"}}}'
# 3. use the returned session id
curl -s "$BASE/json/commerce" \
-H 'Content-Type: application/json' \
-d '{"method":"retrieveAccounts","params":{"sessionId":"SESSION","institutionId":"INSTITUTION_UUID"}}'Next: Authentication · User · Commerce · Rewards · Mobile Access · Reference · Security Notes