Enums and String Values

Last updated: Aug 15th, 7:28am

AdvertisingNetworkType

Identifies the Advertising Network’s tenant relationship with WLW.

EnumDescription
ACCEPTANCE_PARTERThe merchant who sponsors the offer to be redeemed.
ISSUING_PARTNERThe partner who sponsors the mobile wallet where an offer is proffered.
THIRD_PARTYAn entity that is external to the WLW platform that can sponsor an offer or wallet, such as a bank or coupon club.

CashAccessType

Valid values for a transaction conducted with an ATM.

EnumDescription
WITHDRAWALTaking cash out of a registered banking account.
DEPOSITDepositing cash or checks into a registered banking account.

Identifies the type of transaction the ticket represents.

EnumDescription
WITHDRAWALRemoving funds from a bank account
DEPOSITAdding funds into a regiatered bank account.

CheckoutTokenType

The type of transaction for which a checkout token is generated.

EnumDescription
PURCHASEA standard payment or non-referenced refund.
REFUNDA standard or non-paired refund.
OFFERA scannable offer.
CASH_ACCESSA banking transaction with an ATM.
FUELA gas station transaction with a fuel pump.

DeviceType

The manufacturer of a mobile device linked to a mobile wallet.

EnumDescription
iPhoneA supported Apple mobile device.
AndroidA supported Android mobile device.

DiscoveryType

The type of transaction for which the app is requesting merchant data.

EnumType of data the app is requesting
FUEL_CHECK_INFuel site data.
REMOTE_ORDERBuy on-line/pick up in-store (BOPUS) data.
PURCHASEIn-store purchase data.
REFUNDIn-store refund data.
EXCHANGEIn-store exchange data.
CASH_ACCESSATM data.
CLOUD_DETERMINEDTransaction data as determined by the platform.
PATTDine-in, pay-at-the-table data.

EligibleOfferType

Indicates the kind of offers that are supported for the transaction and are eligible to be redeemed. Offers are categorized based on whether the offer is calculated by the WLW service, or input directly into the POS, or if the location permits both kinds of calculations or neither.

EnumOffer calculation takes place at:
POSThe acceptance location POS terminal.
PAYDIANTThe WLW platform
POS_PAYDIANTEither the POS or the WLW platform
NONENeither: The transaction does not support offers.

ExternalEventType

Pump actions during a fuel transaction that trigger a change in the state of the transaction.

EnumDescription
FUEL_PUMP_ACTIVATEDThe fuel pump is ready to dispense fuel.
FUEL_STARTThe pump has begun dispensing fuel.
FUEL_ENDThe pump has completed dispensing fuel.
FUEL_PUMP_DEACTIVATEDThe pump is been locked and is not available for fueling.
FUEL_SECONDARY_ID_RECEIVEDThe pre-authorization confirmation access code has been correctly entered into the pump.
FUEL_CANCELEDThe fuel transaction has been canceled.
FUEL_RECEIPT_RECEIVEDThe completed transaction details have been returned to the pump.
FUEL_PRE_AUTH_SUBMITTEDThe pump has requested a pre-authorization charge from the processor and is awaiting approval before dispersing fuel.

FuelUnitType

The unit of fuel volume specified for the fuel site.

EnumDescription
GALLONFuel is dispensed and priced per gallon.
LITREFuel is dispensed and priced per litre.

LifeCycleEventType

A specific action in a transaction that can trigger subsequent behavior.

EnumDescription
MOBILE_SCANThe mobile wallet app has scanned the checkout token.
TRANSACTION_BLOCKEDThe transaction cannot continue.
MOBILE_TIMEOUTThe time for the app to respond to the platform has expired.
MERCHANT_TIMEOUTThe time for the POS to respond to the platform has expired.
TICKET_RECEIVEDThe transaction ticket has been submitted to the platform.
PAYMENT_FAILEDPayment authorization from the processing network could not be obtained.
PAYMENT_RETRYThe request for payment authorization has been resubmitted.
PAYMENT_SUCCESSPayment authorization from the processing network was obtained.
TRANSACTION_RECEIPT_RECEIVEDThe transaction receipt from the merchant was received by the platform.
TRANSACTION_COMPLETEThe transaction state is closed.
MERCHANT_NOT_REACHABLEThe platform could not establish contact with the acceptance terminal.
TRANSACTION_CLAIMEDUnused at this time.
SECONDARY_IDENTIFIER_RECEIVEDThe user has entered the secondary ID for pre-auth into the fuel pump.
MONITOR_TRANSACTIONUnused at this time.
PRE_TIMEOUT_NOTIFICATIONUnused at this time.
LOYALTY_CARD_CREDENTIALS_AVAILABLEDeprecated The user has submitted membership data for the loyalty program.
TIP_AMOUNT_RECEIVEDThe mobile user has added a tip to the transaction amount.
FULL_REVERSALThe transaction has been terminated after the request for payment has been submitted to the processor (but approval has not been returned), so a full reversal is in effect.
VOID_TRANSACTIONThe transaction has been terminated after the processor has returned payment authorization (but settlement has not occurred), so is voided.
CANCEL_TRANSACTIONThe transaction has been terminated prior to payment authorization request, so is canceled.
PAYMENT_RECEIVEDThe mobile user has submitted payment selection.
PAYMENT_CONFIRMATIONThe network processor has authorized the payment.
RELEASE_TO_CUSTOMERUnused at this time.
UNDO_VOID_TRANSACTIONA transaction was voided in error so the void is backed out.
UNDO_FULL_REVERSALA transaction was reversed in error, so the reversal is backed out.
VOID_PENDINGThe platform is waiting for a void response from the processor.
FULL_REVERSAL_PENDINGThe platform is waiting for a full-reversal response from the processor.
FULL_REVERSAL_FAILEDThe transaction was unable to be reversed.
VOID_FAILEDThe transaction was unable to be voided.
RECEIPT_FOR_REFUND_RECEIVEDThe user has submitted the original transaction receipt relevant to a refund.
MOBILE_SCAN_TIMEOUTThe generated checkout token was not scanned in the allotted time.
PAYMENT_SELECTION_TIMEOUTThe mobile user did not submit payment tender selection in time.
PAYMENT_PROCESSING_TIMEOUTThe network processor did not return a payment authorization response in time.
RECEIPT_PROCESSING_TIMEOUTThe transaction receipt was not submitted in time.
REFUND_RECEIPT_TIMEOUTThe refund receipt was not submitted in time.
TICKET_RECEIVED_TIMEOUTThe transaction ticket was not submitted in time.
OFFERS_PROCESSEDThe selected offers were applied to the transaction total.
TICKET_UPDATEDThe ticket was modified with new or changed data.
PAYMENT_PARTIALA payment was processed for a portion of the total due.
DO_NOT_BLOCKThe event does not need to wait for a response before continuing.
USER_SELECTED_OFFERS_SUBMITTEDThe mobile user selected eligible offers to redeem for the transaction.
USER_SELECTED_PAYMENT_TENDERS_SUBMITTEDThe mobile user selected one or more payment accounts to use as tender for the transaction.
USER_NOT_ELIGIBLE_FOR_OFFERSThe user selected offers that are not valid for the transaction.
USER_DID_NOT_SELECT_OFFERSThe user did not submit any eligible offers to redeem in the transaction.
USER_DID_NOT_SELECT_PAYMENT_TENDERSThe user did not choose a supported account to pay for the transaction.
POS_SELECTED_PAYMENT_TENDERS_SUBMITTEDThe POS updated the transaction with a non-mobile payment, such as cash or a store credit.
POS_DID_NOT_SELECT_PAYMENT_TENDERSThe POS did not submit an external payment tender for the transaction.
USER_CONFIRMED_PAYMENTThe user submitted consent to the payment confirmation request.
USER_DECLINED_PAYMENTThe user submitted refusal to the payment confirmation request.
ACCEPTANCE_POINT_AVAILABLEThe registered acceptance terminal is ready for a transaction.
PRE_AUTH_SUCCESSThe network processor approved the pre-auth funds hold.
PRE_AUTH_FAILEDThe network processor did not approve the pre-auth funds hold.
PRE_AUTH_REVERSALThe pre-auth request was terminated before a response was received from the network processor.
PRE_AUTH_REVERSAL_FAILEDAttempt to back out of pre-auth reversal failed.
PRE_AUTH_CAPTURE_SUCCESSThe final capture of the pre-auth transaction succeeded.
PRE_AUTH_CAPTURE_FAILEDThe final capture of the pre-auth transaction failed.
PRE_AUTH_SUBMITTEDA pre-auth funds hold was requested to ensure funds availability at the completion of the transaction.
PRE_AUTH_REVERSAL_PENDINGWaiting for response to request for back out of pre-auth reversal.
PRE_AUTH_RECEIVEDThe network processor responded to a pre-auth request (regardless of success or failure).
MOBILE_TENDER_REQUEST_RECEIVED_FROM_POSThe acceptance terminal has requested that the mobile user submit a payment instrument.
USER_DID_NOT_SELECT_REQUESTED_TENDERThe user did not select any tenders submitted by POS during discovery.
MOBILE_TENDER_FOR_PROCESSING_RECEIVEDThe platform has updated the transaction with the mobile user’s payment tender selection.
NON_REFERENCE_REFUND_SUCCESSThe refund has no original transaction to reference, so a purchase with a negative amount due was processed.
NON_PAIRED_REFUND_SUCCESSThe original purchase was processed through the mobile wallet, but the mobile app is not present at the time of the refund, so the POS uses an alternative reference from the paper receipt.
PAIRED_REFUND_SUCCESSThe original purchase is selected by the mobile user in the wallet and the refund was processed as a standard mobile transaction.
USER_SELECTIONS_SUBMITTEDThe user’s selections for tenders were received.
THIRD_PARTY_LOYALTY_INSTRUMENTS_SUBMITTEDA rewards program not managed by WLW was submitted as tender for the transaction.
THIRD_PARTY_LOYALTY_INSTRUMENTS
_NOT_AVAILABLE
No loyalty selections are submitted because the user is not enrolled in the loyalty program.
WALLET_NOT_ACCEPTEDThe location or ATM does not support this mobile wallet issuer.
REMOTE_PAYMENT_NOTIFICATION_FAILEDNotification of the payment outcome to the remote order platform failed.
REMOTE_PAYMENT_NOTIFICATION_SUCCESSNotification of the payment outcome to the remote order platform succeeded.
REMOTE_PAYMENT_NOTIFICATION_INITIATEDNotification of the payment outcome to the remote order platform is in process.
DEPOSIT_NOT_SUPPORTEDThis ATM does not support deposit transactions.
TOKEN_RESOLUTION_FAILEDThe QR Code scanned could not be resolved to a valid checkout token.

LoyaltyAccrualActivityType

A qualifying action that affects the loyalty reward balance.

EnumDescription
EXTERNAL_ACTIVITYAn action outside the mobile wallet, such as social media activity.
ENROLLMENTMembership registration in the loyalty program.
PURCHASEA standard sales transaction.
REFUNDA standard refund/credit transaction.
VOID_PURCHASEThe reversal of a sale for which points were awarded.
VOID_REFUNDThe reversal of a refund for which points were subtracted.

MobileTransactionFlowRule

Identifies a specific event or step within the greater life cycle of a transaction.

EnumDescription
OBTAIN_PURCHASE_TOKENGenerate a checkout token for transaction type of PURCHASE in order to initiate a new transaction.
OBTAIN_REFUND_TOKENGenerate a checkout token for transaction type of REFUND in order to initiate a new transaction.
PROCESS_PAYMENTSubmit the payment details to the network processor for payment authorization.
PROCESS_SPLIT_PAYMENTSubmit the payment details to network processors for payment authorization using multiple payment sources.
RETRIEVE_TRANSACTION_METADATA_DISCOVERYUpon QR Code scan, request relevant merchant data, such as supported tender types.
RETRIEVE_TRANSACTION_METADATA_OTHERRequest updated transaction data relevant to the executing flow rule.
RETRIEVE_TRANSACTION_METADATA_SUMMARYRequest completed transaction details.
SUBMIT_CASH_ACCESS_TICKETUpdate transaction with details relevant to an ATM transaction.
SUBMIT_OFFERSUpdate transaction with user’s selected offers for redemption.
SUBMIT_PAYMENT_TENDERSUpdate transaction with user’s selected payment instruments.
SUBMIT_OFFERS_AND_PAYMENT_TENDERSUpdate transaction with user’s selected offers for redemption and payment instruments simultaneously.
SUBMIT_REFUNDABLE_RECEIPTUpdate transaction with the original receipt related to a refund.
SUBMIT_TENDER_FOR_FUELUpdate transaction with selected payment for a fuel pump purchase.
SUBMIT_TENDER_FOR_FUEL_WITH_SECONDARY_IDUpdate transaction with selected payment for a fuel pump purchase and the generated secondary ID for pre-auth.
SUBMIT_TENDER_FOR_OPENTABUpdate transaction with selected payment for dine-in bill.
SUBMIT_TENDER_FOR_PRE_AUTH_PURCHASEUpdate transaction with selected payment for a pre-auth funds hold.
SUBMIT_MOBILE_TENDER_FOR_PROCESSINGUpdate transaction with user’s selected payment tender and route to the processor for authorization.
SUBMIT_TENDER_FOR_FUEL_WITH_FUEL_TICKETUpdate transaction with changes to the fuel ticket and the user’s selected payment for the fuel purchase.
SUBMIT_TENDER_FOR_FUEL_WITH_FUEL_TICKET
_AND_SECONDARY_ID
Update transaction with all referenced items in one submission.
SUBMIT_TENDER_FOR_FUEL_WITH_FUEL_TICKET
_AND_OFFERS
Update transaction with all referenced items in one submission.
SUBMIT_TENDER_FOR_FUEL_WITH_FUEL_TICKET
_AND_SECONDARY_ID_AND_OFFERS
Update transaction with all referenced items in one submission.
CANCEL_TRANSACTIONSend a request from the mobile to cancel a fuel transaction before any fuel has been dispensed.

OfferArtifactChannelType

The medium through which the offer artifact is meant to be published.

EnumDescription
MOBILEViewable on a mobile device.
WEBViewable in an Internet browser page.
FACEBOOKViewable on a Facebook site account.
EMAILViewable as the body of an email message.

OfferArtifactContentType

The format of the artifact file.

EnumThe content is
TEXTA text file.
VIDEOA video file.
URLA link to a webpage.
XMLAn XML file.
TAGSA set of categorization or search optimization tags.

OfferArtifactViewType

The part of the offer beind defined.

EnumDescription
REDEMPTION_SCHEDULESpecifies the dates and times when the offer is valid for use.
DETAILSThe body of the offer that describes the details of its use.
CONFIRMATIONThe page displayed when the user opts to redeem the offer.
THUMBNAILThe image shown for the offer in the list of all offers.
IMAGEThe image that is shown on the offer details page.
TERMS_AND_CONDITIONSThe fine print of the offer. Specifics of the agreement and use of the offer.
OFFER_TITLEThe title text shown for the offer in the list of all offers.
OFFER_DESCRIPTIONThe text shown at the top of the details page describing the offer.
ADDITIONAL_INFORMATIONThe other relevant information text shown on the details page for the offer.
SUMMARYThe offer description shown in the list of all offers.

OfferCampaignRedemptionScheduleType

The unit of time related to the date(s) of validity of an offer.

EnumDescription
DAY_OF_WEEKThe redemption schedule uses the days of the week to identify when the offer is valid.
DAY_OF_MONTHThe redemption schedule uses the days of the month to identify when the offer is valid.

OfferProcessingPoint

The entity that calculated the offer to apply the transaction for redemption.

EnumDescription
POSThe POS terminal calculated the offer that was applied it to the transaction.
PAYDIANTThe WLW platform calculated the offer that was applied to the transaction.

OfferStatus

The state of an offer relative to its usability.

EnumDescription
ACTIVEThe offer is live and can be redeemed.
REDEEMEDThe offer has been redeemed.
REDEEM_PENDINGThe offer is in the process of being redeemed.
EXPIREDThe offer has expired and is no longer valid.
CANCELLEDThe offer was rescinded.
REVERSAL_PENDINGThe offer was redeemed in a transaction that is being reversed.
REVERSAL_FAILEDReversal of the transaction in which the offer was redeemed failed.
VOID_PENDINGThe offer was redeemed in a transaction that is being voided.
REFUND_PENDINGThe offer was redeemed in a transaction that is being refunded.

OfferType

The type of compensation promoted by an offer.

EnumDescription
VALUE_BASED_OFFERThe offer is a dollar or percentage amount discount, such as $5 off or 10% off.

PaymentAccountEnrollmentState

The status of the enrollment at the current step in the operation.

EnumDescription
STARTThe enrollment was initiated, but no response has been issued yet.
MORE_INFOThe enrollment is in progress, pending additional data requested by the processor.
EXPIREDThe time allowed to completed the enrollment has expired and it needs to be restarted.
USER_CANCELLEDThe enrollment was canceled before completion and the payment account is not available as a tender.
ENDThe enrollment was processed to completion, which can mean that it was successfully added as a tender in the wallet, or declined by the processor.

PaymentAccountEnrollmentType

The way in which the payment credential is vaulted for future payments, as defined by the card authorizing party.

EnumDescription
LINKIndicates that the value sent in the CARD_NUMBER field is stored and managed (vaulted) in the WLW platform.
PROVISIONIndicates that the value sent in the CARD_NUMBER field is stored (vaulted) by the authorizing party and a tokenized replacement is stored in WLW’s system.

ReceiptType

The type of transaction for which a receipt is generated.

EnumTransaction Type
PURCHASEA standard payment or non-referenced refund.
REFUNDA standard or non-paired refund.
CASH_WITHDRAWALAn ATM withdrawal.
CASH_DEPOSITAn ATM deposit.
FUELA gas station transaction with a fuel pump.

RewardType

The type of compensation promoted by an offer.

EnumDescription
VALUE_BASEDThe offer is a dollar or percentage amount discount, such as $5 off or 10% off.
SKU_BASEDThe offer gives a product reward, such as a free cookie or car wash.

StatusCode

The outcome of B2B API call that does not involve external processor responses.

EnumDescription
SUCCESSThe request completed successfully.
PARTIAL_SUCCESSSome portion of the request completed, but additional processing is pending. This status typically references a partial payment on which a balance is still owed.
PENDING_COMPLETIONThe platform is waiting for confirmation from a 3rd party, often the POS.
FAILEDThe request was not completed.
INVALID_DATAThe request contained invalid information.
FATAL_ERRORThe gateway terminated the request.
TIMEOUTThe amount of time allowed for a response elapsed.
INVALID_OPERATIONThe transaction is not supported.
REQUIRED_DATA_MISSINGOne or more required values was not included in the request.
NOT_FOUNDAn identified entity in the request could not be found in the platform.
ALREADY_EXISTSThe request attempts to create a new record for an entity that already exists in the platform.
TRANSACTION_CANCELEDThe transaction identified in the request was canceled.
TRANSACTION_EXPIREDThe transaction identified in the request timed out.
TRANSACTION_NOT_FOUNDThe transaction identified in the request does not exist in the platform.
INVALID_SECONDARY_IDThe secondary authorization code for a pre-auth transaction did not match.
CUSTOMER_DEACTIVATEDThe referenced customer's wallet has been locked.
CUSTOMER_PASSWORD_EXPIREDThe referenced customer's password has expired and must be reset.
CUSTOMER_EMAIL_NOT_VERIFIEDThe referenced customer's registration is pending email verification.
INVALID_ARGUMENTSThe request contains one or more invalid property values.
VERIFICATION_SUCCESSA payment account deposit verification operation completed successfully.
VERIFICATION_INITIATEDA payment account deposit verification is pending completion.

StatusCode (v2)

The outcome of a B2B API call that delineates individual responses from platform components and external parties involved in the transaction.

EnumDescription
SUCCESSThe request completed successfully.
PARTIAL_SUCCESSSome portion of the request completed, but additional processing is pending. This status typically references a partial payment on which a balance is still owed.
FAILEDThe request could not be completed.

StatusType

The entity from which a Status instance originates.

EnumDescription
PLATFORMThe status information originated in the WLW platform.
EXTERNAL_PROCESSORThe status information originated in an external system and was passed to the WLW platform in relation to the transaction.

TicketType

The type of transaction for which a ticket is generated.

EnumTicket Type
PURCHASEA standard payment or non-referenced refund.
REFUNDA standard or non-paired refund.
CASH_WITHDRAWALAn ATM withdrawal.
CASH_DEPOSITAn ATM deposit.
FUELA gas station transaction with a fuel pump.

TransactionStatus

A string value that identifies the current state of the transaction. These are the valid values for transactionStatus:

ValueDescription
ACTIVEThe transaction is ongoing, but has not been submitted for authorization.
BLOCKEDThe checkout token is in use by an open transaction.
CANCELEDTerminated by request.
CLOSEDCompleted successfully.
EXPIREDThe transaction timed out
FAILED
FULL_REVERSALReversed due to server unresponsiveness.
FULL_REVERSAL_PENDINGThe server is waiting for confirmation of full reversal completion.
OPENThe transaction is ongoing, but has not been submitted for authorization.
PARTIAL_PAYMENTA successful payment was made, but a balance is still owed.
PENDINGThe server is awaiting a response before continuing.
PENDING_REFUND_RECEIPTThe refund completed and a receipt is being generated.
PROCESSINGThe transaction has been sent for authorization and is awaiting response from the processor.
RECEIPT_PENDINGThe receipt is being generated.
STARTA checkout token has been issued, but not scanned.
TIMEOUTTransaction timed out.
UNCLAIMEDThe checkout token timed out.
VOID_PENDINGThe server is waiting to complete a void.
VOID_TRANSACTIONThe transaction was voided by the POS.

TransactionSubType

Further describes the TransactionType.

EnumDescription
PAYMENTA standard payment for a purchase.
REFUNDA standard refund of a previous purchase.
CASH_BACKA payment over the amount due in which cash was returned.
RETURNA refund in which a previously purchased item was returned.
SALEA purchase of an item at a discounted price.
EXCHANGEA refund in which a previously purchased item was exchanged for a different item, possibly of different value, which might result in additional payment, credit, or cash back.
PAYMENT_ON_ACCOUNTA payment toward an existing credit balance.
REWARDThe payment is a reward redemption.
OTHERThe transaction is of another type not represented in this enum.
NON_REFERENCE_REFUNDA refund that is processed as a sale for a negative amount (credit) because the original transaction receipt is not available.
CREDITA sale entered as a negative amount due.
FUELA purchase of fuel from a gas station pump.
NON_PAIRED_REFUNDA refund where the POS looks up the original transaction based on a paper receipt because the mobile wallet is not present.
PAIRED_REFUNDA refund where the mobile user selects the original receipt within the mobile wallet.
CASH_DEPOSITThe deposited funds were made up of cash only.
CHECK_DEPOSITThe deposited funds were made up of checks only.
CASH_AND_CHECK_DEPOSITThe deposited funds were a combination of cash and checks.

TransactionType

The type of transaction.

EnumDescription
PURCHASEA standard payment or non-referenced refund.
REFUNDA standard or non-paired refund.
CASH_WITHDRAWALA legacy ATM withdrawal.
ATM_CASH_ACCESSA flow rule ATM transaction, which might be a withdrawal or deposit.
FUELA gas station transaction with a fuel pump.