Enums and String Values

AdvertisingNetworkType

Identifies the Advertising Network’s tenant relationship with WLW.

Enum Description
ACCEPTANCE_PARTER The merchant who sponsors the offer to be redeemed.
ISSUING_PARTNER The partner who sponsors the mobile wallet where an offer is proffered.
THIRD_PARTY An 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.

Enum Description
WITHDRAWAL Taking cash out of a registered banking account.
DEPOSIT Depositing cash or checks into a registered banking account.

Identifies the type of transaction the ticket represents.

Enum Description
WITHDRAWAL Removing funds from a bank account
DEPOSIT Adding funds into a regiatered bank account.

CheckoutTokenType

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

Enum Description
PURCHASE A standard payment or non-referenced refund.
REFUND A standard or non-paired refund.
OFFER A scannable offer.
CASH_ACCESS A banking transaction with an ATM.
FUEL A gas station transaction with a fuel pump.

DeviceType

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

Enum Description
iPhone A supported Apple mobile device.
Android A supported Android mobile device.

DiscoveryType

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

Enum Type of data the app is requesting
FUEL_CHECK_IN Fuel site data.
REMOTE_ORDER Buy on-line/pick up in-store (BOPUS) data.
PURCHASE In-store purchase data.
REFUND In-store refund data.
EXCHANGE In-store exchange data.
CASH_ACCESS ATM data.
CLOUD_DETERMINED Transaction data as determined by the platform.
PATT Dine-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.

Enum Offer calculation takes place at:
POS The acceptance location POS terminal.
PAYDIANT The WLW platform
POS_PAYDIANT Either the POS or the WLW platform
NONE Neither: The transaction does not support offers.

ExternalEventType

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

Enum Description
FUEL_PUMP_ACTIVATED The fuel pump is ready to dispense fuel.
FUEL_START The pump has begun dispensing fuel.
FUEL_END The pump has completed dispensing fuel.
FUEL_PUMP_DEACTIVATED The pump is been locked and is not available for fueling.
FUEL_SECONDARY_ID_RECEIVED The pre-authorization confirmation access code has been correctly entered into the pump.
FUEL_CANCELED The fuel transaction has been canceled.
FUEL_RECEIPT_RECEIVED The completed transaction details have been returned to the pump.
FUEL_PRE_AUTH_SUBMITTED The 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.

Enum Description
GALLON Fuel is dispensed and priced per gallon.
LITRE Fuel is dispensed and priced per litre.

LifeCycleEventType

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

Enum Description
MOBILE_SCAN The mobile wallet app has scanned the checkout token.
TRANSACTION_BLOCKED The transaction cannot continue.
MOBILE_TIMEOUT The time for the app to respond to the platform has expired.
MERCHANT_TIMEOUT The time for the POS to respond to the platform has expired.
TICKET_RECEIVED The transaction ticket has been submitted to the platform.
PAYMENT_FAILED Payment authorization from the processing network could not be obtained.
PAYMENT_RETRY The request for payment authorization has been resubmitted.
PAYMENT_SUCCESS Payment authorization from the processing network was obtained.
TRANSACTION_RECEIPT_RECEIVED The transaction receipt from the merchant was received by the platform.
TRANSACTION_COMPLETE The transaction state is closed.
MERCHANT_NOT_REACHABLE The platform could not establish contact with the acceptance terminal.
TRANSACTION_CLAIMED Unused at this time.
SECONDARY_IDENTIFIER_RECEIVED The user has entered the secondary ID for pre-auth into the fuel pump.
MONITOR_TRANSACTION Unused at this time.
PRE_TIMEOUT_NOTIFICATION Unused at this time.
LOYALTY_CARD_CREDENTIALS_AVAILABLE The user has submitted membership data for the loyalty program.
TIP_AMOUNT_RECEIVED The mobile user has added a tip to the transaction amount.
FULL_REVERSAL The 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_TRANSACTION The transaction has been terminated after the processor has returned payment authorization (but settlement has not occurred), so is voided.
CANCEL_TRANSACTION The transaction has been terminated prior to payment authorization request, so is canceled.
PAYMENT_RECEIVED The mobile user has submitted payment selection.
PAYMENT_CONFIRMATION The network processor has authorized the payment.
RELEASE_TO_CUSTOMER Unused at this time.
UNDO_VOID_TRANSACTION A transaction was voided in error so the void is backed out.
UNDO_FULL_REVERSAL A transaction was reversed in error, so the reversal is backed out.
VOID_PENDING The platform is waiting for a void response from the processor.
FULL_REVERSAL_PENDING The platform is waiting for a full-reversal response from the processor.
FULL_REVERSAL_FAILED The transaction was unable to be reversed.
VOID_FAILED The transaction was unable to be voided.
RECEIPT_FOR_REFUND_RECEIVED The user has submitted the original transaction receipt relevant to a refund.
MOBILE_SCAN_TIMEOUT The generated checkout token was not scanned in the allotted time.
PAYMENT_SELECTION_TIMEOUT The mobile user did not submit payment tender selection in time.
PAYMENT_PROCESSING_TIMEOUT The network processor did not return a payment authorization response in time.
RECEIPT_PROCESSING_TIMEOUT The transaction receipt was not submitted in time.
REFUND_RECEIPT_TIMEOUT The refund receipt was not submitted in time.
TICKET_RECEIVED_TIMEOUT The transaction ticket was not submitted in time.
OFFERS_PROCESSED The selected offers were applied to the transaction total.
TICKET_UPDATED The ticket was modified with new or changed data.
PAYMENT_PARTIAL A payment was processed for a portion of the total due.
DO_NOT_BLOCK The event does not need to wait for a response before continuing.
USER_SELECTED_OFFERS_SUBMITTED The mobile user selected eligible offers to redeem for the transaction.
USER_SELECTED_PAYMENT_TENDERS_SUBMITTED The mobile user selected one or more payment accounts to use as tender for the transaction.
USER_NOT_ELIGIBLE_FOR_OFFERS The user selected offers that are not valid for the transaction.
USER_DID_NOT_SELECT_OFFERS The user did not submit any eligible offers to redeem in the transaction.
USER_DID_NOT_SELECT_PAYMENT_TENDERS The user did not choose a supported account to pay for the transaction.
POS_SELECTED_PAYMENT_TENDERS_SUBMITTED The POS updated the transaction with a non-mobile payment, such as cash or a store credit.
POS_DID_NOT_SELECT_PAYMENT_TENDERS The POS did not submit an external payment tender for the transaction.
USER_CONFIRMED_PAYMENT The user submitted consent to the payment confirmation request.
USER_DECLINED_PAYMENT The user submitted refusal to the payment confirmation request.
ACCEPTANCE_POINT_AVAILABLE The registered acceptance terminal is ready for a transaction.
PRE_AUTH_SUCCESS The network processor approved the pre-auth funds hold.
PRE_AUTH_FAILED The network processor did not approve the pre-auth funds hold.
PRE_AUTH_REVERSAL The pre-auth request was terminated before a response was received from the network processor.
PRE_AUTH_REVERSAL_FAILED Attempt to back out of pre-auth reversal failed.
PRE_AUTH_CAPTURE_SUCCESS The final capture of the pre-auth transaction succeeded.
PRE_AUTH_CAPTURE_FAILED The final capture of the pre-auth transaction failed.
PRE_AUTH_SUBMITTED A pre-auth funds hold was requested to ensure funds availability at the completion of the transaction.
PRE_AUTH_REVERSAL_PENDING Waiting for response to request for back out of pre-auth reversal.
PRE_AUTH_RECEIVED The network processor responded to a pre-auth request (regardless of success or failure).
MOBILE_TENDER_REQUEST_RECEIVED_FROM_POS The acceptance terminal has requested that the mobile user submit a payment instrument.
USER_DID_NOT_SELECT_REQUESTED_TENDER The user did not select any tenders submitted by POS during discovery.
MOBILE_TENDER_FOR_PROCESSING_RECEIVED The platform has updated the transaction with the mobile user’s payment tender selection.
NON_REFERENCE_REFUND_SUCCESS The refund has no original transaction to reference, so a purchase with a negative amount due was processed.
NON_PAIRED_REFUND_SUCCESS The 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_SUCCESS The original purchase is selected by the mobile user in the wallet and the refund was processed as a standard mobile transaction.
USER_SELECTIONS_SUBMITTED The user’s selections for offers, loyalty, and/or tenders were received.
THIRD_PARTY_LOYALTY_INSTRUMENTS_SUBMITTED A 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_ACCEPTED The location or ATM does not support this mobile wallet issuer.
REMOTE_PAYMENT_NOTIFICATION_FAILED Notification of the payment outcome to the remote order platform failed.
REMOTE_PAYMENT_NOTIFICATION_SUCCESS Notification of the payment outcome to the remote order platform succeeded.
REMOTE_PAYMENT_NOTIFICATION_INITIATED Notification of the payment outcome to the remote order platform is in process.
DEPOSIT_NOT_SUPPORTED This ATM does not support deposit transactions.
TOKEN_RESOLUTION_FAILED The QR Code scanned could not be resolved to a valid checkout token.

LoyaltyAccrualActivityType

A qualifying action that affects the loyalty reward balance.

Enum Description
EXTERNAL_ACTIVITY An action outside the mobile wallet, such as social media activity.
ENROLLMENT Membership registration in the loyalty program.
PURCHASE A standard sales transaction.
REFUND A standard refund/credit transaction.
VOID_PURCHASE The reversal of a sale for which points were awarded.
VOID_REFUND The reversal of a refund for which points were subtracted.

MobileTransactionFlowRule

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

Enum Description
OBTAIN_PURCHASE_TOKEN Generate a checkout token for transaction type of PURCHASE in order to initiate a new transaction.
OBTAIN_REFUND_TOKEN Generate a checkout token for transaction type of REFUND in order to initiate a new transaction.
PROCESS_PAYMENT Submit the payment details to the network processor for payment authorization.
PROCESS_SPLIT_PAYMENT Submit the payment details to network processors for payment authorization using multiple payment sources.
RETRIEVE_TRANSACTION_METADATA_DISCOVERY Upon QR Code scan, request relevant merchant data, such as supported tender types.
RETRIEVE_TRANSACTION_METADATA_OTHER Request updated transaction data relevant to the executing flow rule.
RETRIEVE_TRANSACTION_METADATA_SUMMARY Request completed transaction details.
SUBMIT_CASH_ACCESS_TICKET Update transaction with details relevant to an ATM transaction.
SUBMIT_OFFERS Update transaction with user’s selected offers for redemption.
SUBMIT_PAYMENT_TENDERS Update transaction with user’s selected payment instruments.
SUBMIT_OFFERS_AND_PAYMENT_TENDERS Update transaction with user’s selected offers for redemption and payment instruments simultaneously.
SUBMIT_REFUNDABLE_RECEIPT Update transaction with the original receipt related to a refund.
SUBMIT_TENDER_FOR_FUEL Update transaction with selected payment for a fuel pump purchase.
SUBMIT_TENDER_FOR_FUEL_WITH_SECONDARY_ID Update transaction with selected payment for a fuel pump purchase and the generated secondary ID for pre-auth.
SUBMIT_TENDER_FOR_OPENTAB Update transaction with selected payment for dine-in bill.
SUBMIT_TENDER_FOR_PRE_AUTH_PURCHASE Update transaction with selected payment for a pre-auth funds hold.
SUBMIT_MOBILE_TENDER_FOR_PROCESSING Update transaction with user’s selected payment tender and route to the processor for authorization.
SUBMIT_TENDER_FOR_FUEL_WITH_FUEL_TICKET Update 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_TRANSACTION Send 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.

Enum Description
MOBILE Viewable on a mobile device.
WEB Viewable in an Internet browser page.
FACEBOOK Viewable on a Facebook site account.
EMAIL Viewable as the body of an email message.

OfferArtifactContentType

The format of the artifact file.

Enum The content is
TEXT A text file.
VIDEO A video file.
URL A link to a webpage.
XML An XML file.
TAGS A set of categorization or search optimization tags.

OfferArtifactViewType

The part of the offer beind defined.

Enum Description
REDEMPTION_SCHEDULE Specifies the dates and times when the offer is valid for use.
DETAILS The body of the offer that describes the details of its use.
CONFIRMATION The page displayed when the user opts to redeem the offer.
THUMBNAIL The image shown for the offer in the list of all offers.
IMAGE The image that is shown on the offer details page.
TERMS_AND_CONDITIONS The fine print of the offer. Specifics of the agreement and use of the offer.
OFFER_TITLE The title text shown for the offer in the list of all offers.
OFFER_DESCRIPTION The text shown at the top of the details page describing the offer.
ADDITIONAL_INFORMATION The other relevant information text shown on the details page for the offer.
SUMMARY The offer description shown in the list of all offers.

OfferCampaignRedemptionScheduleType

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

Enum Description
DAY_OF_WEEK The redemption schedule uses the days of the week to identify when the offer is valid.
DAY_OF_MONTH The 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.

Enum Description
POS The POS terminal calculated the offer that was applied it to the transaction.
PAYDIANT The WLW platform calculated the offer that was applied to the transaction.

OfferStatus

The state of an offer relative to its usability.

Enum Description
ACTIVE The offer is live and can be redeemed.
REDEEMED The offer has been redeemed.
REDEEM_PENDING The offer is in the process of being redeemed.
EXPIRED The offer has expired and is no longer valid.
CANCELLED The offer was rescinded.
REVERSAL_PENDING The offer was redeemed in a transaction that is being reversed.
REVERSAL_FAILED Reversal of the transaction in which the offer was redeemed failed.
VOID_PENDING The offer was redeemed in a transaction that is being voided.
REFUND_PENDING The offer was redeemed in a transaction that is being refunded.

OfferType

The type of compensation promoted by an offer.

Enum Description
VALUE_BASED_OFFER The 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.

Enum Description
START The enrollment was initiated, but no response has been issued yet.
MORE_INFO The enrollment is in progress, pending additional data requested by the processor.
EXPIRED The time allowed to completed the enrollment has expired and it needs to be restarted.
USER_CANCELLED The enrollment was canceled before completion and the payment account is not available as a tender.
END The 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.

Enum Description
LINK Indicates that the value sent in the CARD_NUMBER field is stored and managed (vaulted) in the WLW platform.
PROVISION Indicates 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.

Enum Transaction Type
PURCHASE A standard payment or non-referenced refund.
REFUND A standard or non-paired refund.
CASH_WITHDRAWAL An ATM withdrawal.
CASH_DEPOSIT An ATM deposit.
FUEL A gas station transaction with a fuel pump.

RewardType

The type of compensation promoted by an offer.

Enum Description
VALUE_BASED The offer is a dollar or percentage amount discount, such as $5 off or 10% off.
SKU_BASED The 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.

Enum Description
SUCCESS The request completed successfully.
PARTIAL_SUCCESS Some 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_COMPLETION The platform is waiting for confirmation from a 3rd party, often the POS.
FAILED The request was not completed.
INVALID_DATA The request contained invalid information.
FATAL_ERROR The gateway terminated the request.
TIMEOUT The amount of time allowed for a response elapsed.
INVALID_OPERATION The transaction is not supported.
REQUIRED_DATA_MISSING One or more required values was not included in the request.
NOT_FOUND An identified entity in the request could not be found in the platform.
ALREADY_EXISTS The request attempts to create a new record for an entity that already exists in the platform.
TRANSACTION_CANCELED The transaction identified in the request was canceled.
TRANSACTION_EXPIRED The transaction identified in the request timed out.
TRANSACTION_NOT_FOUND The transaction identified in the request does not exist in the platform.
INVALID_SECONDARY_ID The secondary authorization code for a pre-auth transaction did not match.
CUSTOMER_DEACTIVATED The referenced customer's wallet has been locked.
CUSTOMER_PASSWORD_EXPIRED The referenced customer's password has expired and must be reset.
CUSTOMER_EMAIL_NOT_VERIFIED The referenced customer's registration is pending email verification.
INVALID_ARGUMENTS The request contains one or more invalid property values.
VERIFICATION_SUCCESS A payment account deposit verification operation completed successfully.
VERIFICATION_INITIATED A 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.

Enum Description
SUCCESS The request completed successfully.
PARTIAL_SUCCESS Some portion of the request completed, but additional processing is pending. This status typically references a partial payment on which a balance is still owed.
FAILED The request could not be completed.

StatusType

The entity from which a Status instance originates.

Enum Description
PLATFORM The status information originated in the WLW platform.
EXTERNAL_PROCESSOR The 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.

Enum Ticket Type
PURCHASE A standard payment or non-referenced refund.
REFUND A standard or non-paired refund.
CASH_WITHDRAWAL An ATM withdrawal.
CASH_DEPOSIT An ATM deposit.
FUEL A 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:

Value Description
ACTIVE The transaction is ongoing, but has not been submitted for authorization.
BLOCKED The checkout token is in use by an open transaction.
CANCELED Terminated by request.
CLOSED Completed successfully.
EXPIRED The transaction timed out
FAILED
FULL_REVERSAL Reversed due to server unresponsiveness.
FULL_REVERSAL_PENDING The server is waiting for confirmation of full reversal completion.
OPEN The transaction is ongoing, but has not been submitted for authorization.
PARTIAL_PAYMENT A successful payment was made, but a balance is still owed.
PENDING The server is awaiting a response before continuing.
PENDING_REFUND_RECEIPT The refund completed and a receipt is being generated.
PROCESSING The transaction has been sent for authorization and is awaiting response from the processor.
RECEIPT_PENDING The receipt is being generated.
START A checkout token has been issued, but not scanned.
TIMEOUT Transaction timed out.
UNCLAIMED The checkout token timed out.
VOID_PENDING The server is waiting to complete a void.
VOID_TRANSACTION The transaction was voided by the POS.

TransactionSubType

Further describes the TransactionType.

Enum Description
PAYMENT A standard payment for a purchase.
REFUND A standard refund of a previous purchase.
CASH_BACK A payment over the amount due in which cash was returned.
RETURN A refund in which a previously purchased item was returned.
SALE A purchase of an item at a discounted price.
EXCHANGE A 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_ACCOUNT A payment toward an existing credit balance.
REWARD The payment is a loyalty reward redemption.
OTHER The transaction is of another type not represented in this enum.
NON_REFERENCE_REFUND A refund that is processed as a sale for a negative amount (credit) because the original transaction receipt is not available.
CREDIT A sale entered as a negative amount due.
FUEL A purchase of fuel from a gas station pump.
NON_PAIRED_REFUND A refund where the POS looks up the original transaction based on a paper receipt because the mobile wallet is not present.
PAIRED_REFUND A refund where the mobile user selects the original receipt within the mobile wallet.
CASH_DEPOSIT The deposited funds were made up of cash only.
CHECK_DEPOSIT The deposited funds were made up of checks only.
CASH_AND_CHECK_DEPOSIT The deposited funds were a combination of cash and checks.

TransactionType

The type of transaction.

Enum Description
PURCHASE A standard payment or non-referenced refund.
REFUND A standard or non-paired refund.
CASH_WITHDRAWAL A legacy ATM withdrawal.
ATM_CASH_ACCESS A flow rule ATM transaction, which might be a withdrawal or deposit.
FUEL A gas station transaction with a fuel pump.