Skip to content

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/authentication

Environments ​

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:

Environmentservices_urlPartner services URLImage URL
productionhttps://services.get.cbord.com/GETServices/serviceshttps://api.partnerpayments.cbord.comhttps://object-store.api.cbord.com/image/
demohttps://services.get.demo.cbord.com/GETServices/serviceshttps://api.payments.demo.cbord.comhttps://object-store.api.demo.cbord.com/image/
demoUKhttps://services.get.uk.demo.cbord.com/GETServices/serviceshttps://api.payments.uk.demo.cbord.comhttps://object-store.api.uk.demo.cbord.com/image/
feature1https://services.get.feature1.cbord.com/GETServices/services—https://3bulchr7pb.execute-api.us-east-1.amazonaws.com/dev/image/
develophttps://services.get.dev.cbord.com/GETServices/serviceshttps://api.partnerpayments.pat.cbord.comhttps://3bulchr7pb.execute-api.us-east-1.amazonaws.com/dev/image/
prodCanadahttps://services.get.ca.cbord.com/GETServices/serviceshttps://api.partnerpayments.ca.cbord.com—
prodUKhttps://services.get.uk.cbord.com/GETServices/serviceshttps://api.partnerpayments.uk.cbord.comhttps://object-store.api.uk.cbord.com/image/

There are also site URLs used for web flows:

Environmentsite_url
productionhttps://get.cbord.com
demohttps://get.demo.cbord.com
demoUKhttps://get.uk.demo.cbord.com
feature1https://get.feature1.cbord.com
develophttps://get.dev.cbord.com
prodCanadahttps://get.ca.cbord.com
prodUKhttps://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/json
json
{
    "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:

  1. If the request is flagged useInstitutionId, it adds params.institutionId using the cached institution id.
  2. If the request is flagged useSessionId and the params do not already contain a sessionId, it adds params.sessionId using the cached user session (get_sessionId).
  3. Only when no user session is cached does it mint a system session with authenticateSystem and 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, exception is null and response holds the payload.
  • On failure, exception is a string, usually "{code}|{detail}", and response may be null.
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:

CodeDefault message
9004There was an issue with the transaction, user phone number missing and required
9999Unable to parse response
4001Session not found
4002No user associated with this session
9801Invalid Service Argument Exception
6100There was an issue with your transaction. Contact your institution for more details.

6100 is special-cased per method:

MethodMessage
depositThere was an issue with the transaction
depositForUserFromAnyAccountThere was an issue with the transaction
saleYour billing information does not match your credit card.
getMobileLocationsUnable 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 pathPurpose
/json/authenticationsystem/user/PIN/session-token login, barcode payload, external tokens
/json/userprofile, settings, addresses, photos, notifications, card lost/found
/json/userNotificationin-app notification log
/json/commerceaccounts, deposits, transactions, donations
/json/institutioninstitution records, photos, buildings, lookup lists
/json/configurationinstitution settings
/json/contentlocalized strings
/json/merchantmerchant search, menus, favorites, delivery
/json/orderingorder validation, submission, check-in, schedules, history
/json/rewardsreward tracks, levels, store, claims, history
/json/notificationpassword-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 ​

  1. Optionally POST /json/authentication authenticateSystem — a system session for anonymous/institution-scoped calls (settings, content, institutions, menus). The app mints it lazily and keeps it in memory only.
  2. POST /json/authentication authenticateUser — exchanges username/password (or authenticateGuestUser) for a user session id. This does not require step 1. Institutions whose authenticationInfo.authenticationType is CAS, SSO_GENERIC or OKTA_EXT skip this call: the app runs the hosted browser login instead and lifts the session id out of the return URL.
  3. Send the user session id as params.sessionId on all patron calls; keep the system session for pre-login calls. Most methods are flagged useSessionId, so a general client can simply attach whichever session it holds.
  4. When logged in, getAuthenticationToken turns the current session into a session_token for 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