Appearance
Payments
GET Mobile supports three ways to pay:
- Campus accounts — meal plans, charge accounts, declining balance. These are internal to CBORD and use the normal commerce methods.
- Stored credit cards (USAePay) — added through a hosted web form, then stored as accounts.
- Apple Pay — for iOS only, using a hosted web flow or the native bridge.
Bill-me tenders (charge accounts that are paid later) are a variation of (1) plus a mapping between funding and destination tenders.
Payment systems
| Enum | Value | Class | Notes |
|---|---|---|---|
OPCS | 1 | Campus card | Internal CBORD cashless |
CSGOLD | 2 | Campus card | Legacy CS Gold |
MONETRA | 3 | Credit card | Native/embedded card entry |
USAEPAY | 4 | Credit card | Hosted card entry (GET Mobile default) |
The app treats MONETRA and USAEPAY as credit systems and OPCS / CSGOLD as campus systems:
js
const isCredit = ({ paymentSystemType }) =>
paymentSystemType === 3 || paymentSystemType === 4;
const isCampus = ({ paymentSystemType }) =>
paymentSystemType === 1 || paymentSystemType === 2;Which one is active is the institution setting get.credit.payment_system_type.
NOTE
GET Mobile filters credit accounts down to USAePay only for deposits and orders (filterAccountsByPaymentSystem keeps paymentSystemType == 4). MONETRA accounts are created through the native add-card screen instead.
Adding a credit card (USAePay)
Card data never touches the JSON API. The app opens a hosted page in an in-app browser:
plaintext
GET {sites_url}/{institution_shortName}/full/add_card_mobile.php?session_token={token}| Piece | Source |
|---|---|
sites_url | Environment site URL, e.g. https://get.cbord.com |
institution_shortName | institution.shortName |
session_token | response of getAuthenticationToken |
The in-app browser is configured with:
json
{
"usewkwebview": "yes",
"toolbarposition": "top",
"closebuttoncaption": "Back",
"location": "no",
"hidenavigationbuttons": "yes",
"toolbarcolor": "#ffffff"
}Success / failure detection
The app watches loadstart events and inspects the URL:
| URL contains | Meaning |
|---|---|
action_complete=1 and card_no | Success; card_no is the new card's last four digits |
error= | Failure; the error query value is shown as a toast |
action_complete but neither | Treated as no result |
After success the app calls retrieveAccounts and selects the account whose lastFour matches card_no.
MONETRA cards
If get.credit.payment_system_type == 3 (MONETRA) the app instead navigates to its own native add-card screen. That flow posts createAccount with the full card object — card data is sent directly to CBORD rather than through a hosted page.
Sandbox helper
In non-production environments the app can auto-fill the USAePay form. The injected script uses the test card 4000100211112222 with name John Doe, street 1234 Main St, zip Anyzip, CVV 999, and an expiration month of 09 plus the current two-digit year. This never runs in production.
Apple Pay
Apple Pay is gated by get.feature.enable_apple_pay. The app models it as an account with accountType = 4 (APPLEPAY) and accountDisplayName = "Apple Pay".
There are two implementations in the 5.1.20 bundle.
A. Hosted web flow (used by the Angular web bundle)
The app opens a hosted Apple Pay page in an in-app browser and waits for an ApplePayEvent:
plaintext
GET {sites_url}/{institution_shortName}/full/applepay.php?{params}Query parameters differ by purpose.
Deposits
| Parameter | Value |
|---|---|
amount | Deposit amount |
select_account | Destination account id |
session_token | getAuthenticationToken response |
plaintext
.../full/applepay.php?amount=25&select_account={ACCOUNT_ID}&session_token={TOKEN}Orders
| Parameter | Value |
|---|---|
order_total | order.total |
sub_total | order.subTotal |
fee | order.useFee |
tax | order.tax (default 0.00) |
discount | order.discount (default 0.00) |
pickup_fee | order.pickupFee |
delivery_fee | order.deliveryFee |
tip | order.tip |
merchantId | Merchant id |
session_token | getAuthenticationToken response |
plaintext
.../full/applepay.php?order_total=13.13&session_token={TOKEN}&sub_total=12.50&fee=0&tax=0.63&discount=0.00&pickup_fee=0&delivery_fee=0&tip=0&merchantId={MERCHANT_ID}Apple Pay result
The native shell emits an ApplePayEvent whose url is parsed:
| URL condition | Result |
|---|---|
contains applepay and status=success | { success: true, amount, accountId, accountName, sourceAcc: { accountTender: "Apple Pay" } } |
| anything else | { success: false, errorMessage: "The request failed." } |
The accountId returned for an order is used as the accountId in submitOrder. For deposits the app shows the success modal and then refreshes accounts.
B. Native bridge (iOS shell)
The native shell exposes these methods through window.NativeInterface:
| Method | Payload | Result |
|---|---|---|
ordersApplePay | The order object | { success, accountId, amount, ... } |
depositsApplePay | { accountId, depositAmount } | { success, accountId, amount, ... } |
The web wrapper payWithApplePay(method, payload) resolves to:
json
{
"success": true,
"accountId": "{ACCOUNT_ID}",
"amount": "25",
"selectedAccount": { "accountDisplayName": "Apple Pay" },
"sourceAcc": { "accountTender": "Apple Pay" }
}On non-iOS platforms it resolves immediately with:
json
{ "success": false, "errorMessage": "Apple Pay does not work on Android.", "accountId": null }NOTE
The iOS binary only implements ApplePayEvent / notifyApplePayResponse: and PKAddPaymentPassViewController glue; the actual payment sheet is driven by the hosted page or the native GETPartnerServices layer. Do not assume ordersApplePay exists on Android — it does not.
Deposits
Standard deposit
- Get accounts with
retrieveAccounts. - Pick a funding account (
USAEPAYcredit card or Apple Pay) and a destination account. - Optionally call
calculateDepositFee. - Show a confirmation with the fee.
- Call
depositwithfromAccountId,toAccountId,fromAccountCvv,amount,cashlessTerminalLocation: null.
TIP
Apple Pay deposits skip calculateDepositFee and deposit. The Apple Pay sheet itself performs the transaction and the app then refreshes accounts. The destination account is passed as select_account.
Bill-me deposits
A "bill me" account is a charge tender that is paid later. The mapping between funding and destination tenders is the JSON setting get.deposit.billme_mapping:
json
[
{ "source": "Meal Plan", "destination": "Charge Account" }
]The app derives:
- destination accounts — accounts with
depositAcceptedwhoseaccountTenderappears as adestinationin the mapping, and whosesourcetender also exists. - source accounts — the accounts whose
accountTendermatches a mappingsource.
get.deposit.billme_amounts, billme_minimum, and billme_maximum control the amounts. get.deposit.billme_mapping is required for bill-me to appear at all.
Deposit for another user (guest deposits)
The guest deposit flow:
retrieveUserIdByCashlessFieldsresolves the recipient from the lookup fields returned byretrieveAnonymousDepositFields.retrieveDepositAccountsByUserlists the recipient's deposit-eligible accounts.depositForUserFromAnyAccountmoves the money from the caller's funding account.
json
{
"method": "depositForUserFromAnyAccount",
"params": {
"userId": "{RECIPIENT_USER_ID}",
"fromAccountId": "{CALLER_CARD_ID}",
"fromAccountCvv": null,
"toAccountId": "{RECIPIENT_ACCOUNT_ID}",
"amount": 25,
"cashlessTerminalLocation": null,
"sessionId": "{SESSION_ID}"
}
}IMPORTANT
This call sets useInstitutionId = false; do not send institutionId.
Deposits limits
| Setting | Meaning |
|---|---|
get.deposit.onetime_minimum / onetime_maximum | Credit-card deposit bounds |
get.deposit.onetime_amounts | Preset amounts |
get.deposit.allow_freeform_onetime_amounts | Free-form amounts allowed |
get.deposit.guest_minimum / guest_maximum | Guest deposit bounds |
get.deposit.guest_amounts | Preset guest amounts |
get.deposit.allow_freeform_guest_amounts | Free-form guest amounts |
get.deposit.billme_minimum / billme_maximum | Bill-me bounds |
get.deposit.billme_amounts | Preset bill-me amounts |
Orders
- Call
getMerchantPaymentAccountsWithFilterto list accounts accepted by the merchant. - Guests only see
USAEPAYaccounts (client-side filter). - If the account is Apple Pay (
accountType == 4), obtain anaccountIdfrom the Apple Pay flow first, then submit with it. - Call
submitOrderwithaccountIdand, for credit cards,cvv.
NOTE
A merchant reports accepted processors in merchant.payment.supported_types, a JSON string such as [{"payment_system_type":4}]. The app checks it before offering Apple Pay.
Rollup accounts
A rollup account means "no specific account" — typically a meal-swipe rollup. The app rewrites orderPayment to [] and accountId to null before every ordering call. Never send the literal string rollup.
Card validation
The app validates card-entry input client-side with these rules before handing it to the payment system:
| Field | Rule |
|---|---|
| Card number | 13–19 digits; Visa/Mastercard prefix regex; Luhn |
| Expiration | MM/YY or MMYYYY, month 1–12 |
| CVV | 3–4 digits |
| Postal code | 5 digits (US) |
| Name | Non-empty |
Card brand enum: AmericanExpress = 0, Discover = 1, MasterCard = 2, Visa = 3, Diners = 4, Dindes = 5 (typo in the app).
Payment errors
| Exception | Message |
|---|---|
InsufficientFundsException | There are insufficient funds in the selected account |
PaymentSystemGatewayException | An error occurred while communicating with the card office or credit card processor. |
PaymentSystemBusinessLogicException | Transaction rejected. Details: ${raw_error_message} |
InvalidCardTypeException | [card_name] is not accepted. Try adding a different card. |
MediaAddressException | Invalid address specified for this card. |
MediaDeniedException | Transaction denied for specified card. |
MediaExpiredException | The specified card has expired. |
MediaLostException | The specified card has been reported lost. |
MediaValidationException | Invalid card number. |
MediaVerificationCodeException | Your information could not be verified. |
TransactionCountExceededException | You have exceeded the system configured maximum transaction count for the day. |
card_verification_exception | Your card failed verification, please ensure your card information was entered correctly. |
For ordering-specific codes (6112, 6113, 6001, 9009, …) see Ordering error codes.