Enum Reference
Enums live in src/app/core/pyb/enums/ unless another path is given. Enums
imported from @payability/pyb-ng2-api are listed at the end.
Permissions
permissions.enum.ts — a numeric enum. See
Permissions System for the full list and the
conditions behind each member.
|
Values are positional. Always append; never reorder or insert. |
Onboarding
// onboarding-schema.enum.ts
export enum OnboardingSchemaEnum {
Base = '3.0',
WithPlaid = '3.0_plaid',
Expedited = 'exp_onb',
AmazonExpedited = 'amzn_exp_onb',
Next = 'NEXT',
}
// onboarding-template-code.enum.ts
export enum OnboardingTemplateCode {
FreeAccess = 'free_access_3.0',
}
Status
// access-status.enum.ts — compliance record status
export enum AccessStatusEnum {
Pending = 'pending', Incomplete = 'incomplete', Rejected = 'rejected',
Completed = 'completed', Verified = 'verified',
}
// api-status.enum.ts — marketplace API connection status
export enum ApiStatus {
Needed = 'needed', Required = 'required', Rejected = 'rejected',
Confirmed = 'confirmed', InComplete = 'incomplete', InReview = 'in-review', Pending = 'pending',
}
Only Required and Needed trigger a reconnect prompt — see
Marketplace API Connectors.
// core/auth/_models/status.model.ts
export enum SupplierDashboardStatusType {
Onboarding = 'onboarding', Welcome = 'welcome',
InactiveDashboard = 'inactive_dashboard', Active = 'active',
}
export enum CancelationStatus { Canceled = 'canceled', Pending = 'pending' }
Suspension
export enum SuspensionReason {
AccountAtRisk = 'sh.susp:acc_at_risk',
ApiNeeded = 'sh.susp:api_needed',
Cancellation = 'sh.susp:cancellation',
InvalidCreditCard = 'sh.susp:inv_credit_card',
MarketplaceAccessDiverted = 'sh.susp:access_diverted',
MarketplacePayeeDiverted = 'sh.susp:payee_diverted',
MarketplacePermissionsIncorrect = 'sh.susp:perm_inc',
SellingPrivilegesRemoved = 'sh.susp:sell_prv_rmv',
SuspendedByMarketplace = 'sh.susp:susp_by_mp',
FailedPayment = 'sh.susp:failed_payments',
}
The sh.susp: prefix is stripped when resolving translation keys. See
Suspension.
Marketplaces and compliance
marketplaces.enum.ts (MarketplaceEnum) and compliance.enum.ts hold fixed
UUIDs — see Marketplaces & Compliance for the
full tables.
compliance.enum.ts contains: PayabilityComplianceEnum,
DoctypeComplianceEnum, WalmartComplianceTypes, WalmartComplianceKeys,
PayoneerComplianceKeys, AmazonComplianceKeys, EbayComplianceKeys,
NeweggComplianceKeys, NeweggVendorsComplianceKeys,
NeweggComplianceActionKeys, AuthorizeComplianceKeys, ShopifyComplianceKeys,
EtsyComplianceKeys, PaymentGatewaysKeys and MpPermissionEnum.
export enum MpPermissionEnum {
APPROVED = 'approved', VERIFIED = 'verified',
PERM_APPROVED = 'perm-approved', PERM_PENDING = 'perm-pending', PERM_REJECTED = 'perm-rejected',
PENDING = 'pending', REJECTED = 'rejected', INCOMPLETE = 'incomplete', DISABLED = 'disabled',
SALES_RESOLUTION = 'sales resolution', PERM_SALES_RESOLUTION = 'perm-sales resolution',
}
Cards
// card-provider.enum.ts
export enum CardProvider { Marqeta = 'marqeta', Airwallex = 'airwallex' }
// card-form-factor.enum.ts
export enum CardFormFactor { Physical = 'PHYSICAL', Virtual = 'VIRTUAL' }
// airwallex-card-status.enum.ts
export enum AirwallexCardStatus { Active = 'ACTIVE', Inactive = 'INACTIVE', Closed = 'CLOSED', Pending = 'PENDING' }
// core/pyb/interfaces/unified-supplier-card.interface.ts
export enum UnifiedCardStatus { Active = 'ACTIVE', Blocked = 'BLOCKED', Pending = 'PENDING', Closed = 'CLOSED' }
PCardStatus and PCardTypeIndicator (Marqeta) live in
core/_base/interfaces/.
Network response codes
network-response-code.enum.ts maps card decline codes to named constants:
|
Refer to card issuer |
|
Pick up |
|
Do not honor |
|
Pick up card, special conditions |
|
Invalid transaction |
|
Invalid card number, no such number |
|
Expired card, pick up |
|
Lost card, pick up |
|
Stolen card, pick up |
|
Closed account — do not reattempt with the same PAN or token |
|
Insufficient funds |
|
No checking / no savings account |
|
Expired card |
|
Transaction not permitted to cardholder |
|
Suspected fraud |
|
Exceeds withdrawal amount limit |
|
Security violation (may also be a chargeback) |
|
Exceeds withdrawal frequency limit |
|
Hard capture, pick up |
|
Allowable number of PIN tries exceeded |
|
Customer not eligible for POS |
|
CVV verification failed |
|
Do not honor (ISO) |
|
Account blocked |
|
Transaction forbidden on this account |
|
Check deposit limit exceeded |
|
Expiration date mismatch |
|
Daily limit exceeded |
|
Mastercard Send — error due to expiration date |
|
Mastercard Send — decline, card was declined |
|
Mastercard Send — decline, unsupported card |
DocuSign
// core/pyb/models/docusign-parameters.model.ts
export enum DocusignEventEnum { SingingComplete = 'signing_complete', Cancel = 'cancel', Decline = 'decline' }
export enum DocusignFlowEnum {
AdvanceLineActive = 'advance-line-active', LongTermContract = 'long-term-contract',
AdvanceLinePending = 'advance-line-pending', InstantAdvanceActive = 'instant-advance-active',
ReAssignContract = 're-assign-contract', OnboardingActivation = 'onboarding-activation',
}
export enum DocusignModeEnum { Dashboard = 'dashboard', ProductOfferingsList = 'product-offerings-list' }
Long Term Contract
// core/pyb/constants/ltc-flow.constants.ts
export enum LtcContractActionType { New = 'new', Renew = 'renew', Change = 'change' }
Notifications and CTAs
features/dashboard-notifications/dashboard-notificatons.enums.ts holds
DashboardNotificationsActionTypes, DashboardNotificationAction and
DashboardNotificationType. See
Dashboard Notifications & CTAs.
// cta-action-types.enum.ts
export enum CtaActionTypesEnum { Accept = 'accept', Decline = 'decline', SaveForLater = 'save' }
Two-factor authentication
// features/two-factor-authentication/two-factor-authentication.enums.ts
export enum TwoFactorAuthenticationSteps {
RegisterPhoneNumber = 'register', SendSms = 'sendSms', VerifyCode = 'test',
}
Plus TwoFactorAuthenticationActionTypes.
Errors
// http-errors.enum.ts
export enum HttpErrorsEnum {
BAD_REQUEST = 400, UNAUTHORIZED = 401, FORBIDDEN = 403, INTERNAL_SERVER_ERROR = 500,
}
// auth-errors.enum.ts
export enum AuthErrorsEnum {
EmailNotFound = 'AUTH.VALIDATION.NOT_FOUND',
InvalidVerificationCode = 'AUTH.FORGOT.INVALID_RESET_PASSWORD_VERIFICATION_CODE',
Fail = 'AUTH.FORGOT.FAIL',
}
AuthErrorsEnum values are translation keys, not messages.
Presentation
// banner-types.enum.ts
export enum BannerTypes { INFO = 'info', WARNING = 'warning', DANGER = 'danger', SUCCESS = 'success', ANNOUNCEMENT = 'announcement' }
// date-formats.enum.ts
export enum DateFormatsEnum { Default = 'MM/dd/yyyy', ShortTime = 'shortTime', MonthDate = 'MMM d', LongDate = 'MMMM d, y' }
// breakpoints.enum.ts
export enum BreakpointsEnum {
XSmall = '(max-width: 360.99px)',
LSmall = '(min-width: 361px) and (max-width: 576.99px)',
Small = '(min-width: 577px) and (max-width: 768.99px)',
Medium = '(min-width: 769px) and (max-width: 1024.99px)',
Large = '(min-width: 1025px) and (max-width: 1399.99px)',
XLarge = '(min-width: 1400px)',
}
Forms and pages
// cancellation-survey-form-fields-types.enum.ts
export enum CancellationSurveyFormFieldsTypes { REASON = 'reasonCode', COMMENT = 'comment', RECOMMENDATION = 'rating' }
// views/pages/reports/reports.config.ts
export enum ReportsFilter { DateFormat = 'yyyy-MM-dd' }
export enum ReportsPageSizes { Desktop = 50, Mobile = 6, DailySummaryMobile = 4 }
// views/pages/reports/reports.enums.ts
export enum ReportActionEnum { ExportAll, ExportCSV }
// views/pages/partners/partners.enum.ts
export enum PartnerTypeEnum { All = 0, Marketplaces = 1, EcommerceTools = 2, Shipping = 3, SolutionProviders = 4 }
// views/pages/product-offerings/product-offering-mode.enum.ts
export enum ProductOfferingModeEnum { DEFAULT = 'DEFAULT', CAN_REFINANCE = 'CAN_REFINANCE', REFINANCING_PROCESSING = 'REFINANCING_PROCESSING' }
// views/pages/manage-account/cancellation-workflow/cancellation-workflow.enum.ts
export enum CancellationWorkflowOptionAvailableEnum { DEACTIVATE = 'DEACTIVATE', REACTIVATE = 'REACTIVATE', NONE = 'NONE' }
Flows
// core/_base/tasks-flow/tasks-flow.ts
export enum FlowTaskResultType { Done = 'done', Cancel = 'cancel', Terminated = 'terminated', Error = 'error' }
Plaid
// vendors/plaid/plaid.interface.ts
export enum PlaidProducts { Transactions = 'transactions', Auth = 'auth', Identity = 'identity', Assets = 'assets' }
export enum PlaidEnv { Production = 'production', Development = 'development', Sandbox = 'sandbox' }
export enum PlaidCountryCodes { Us = 'US' }
CloudWatch
// vendors/cloud-watch/cloud-watch-metric.interface.ts
export enum MonitoringNamespace { CriticalServiceMonitoring = 'critical_service_monitoring' }
export enum MetricName { DailySummaryLoadTime = 'load_time', DailySummaryLoadError = 'load_error' }
export enum MetricUnit { /* the full AWS unit vocabulary */ }
Analytics
event-types.enum.ts holds every Segment event constant — see
Event Catalog.
Imported from @payability/pyb-ng2-api
|
|
|
Server-side dashboard status (v2). |
|
Advance Line status. |
|
Underwriting status. |
|
|
|
Offer/fee structure. |
|
APR contract signature requirement. |
|
DocuSign events (mirrors the local |
|
|
|
Including |
|
Including |
|
Onboarding pre-activation steps. |