Data Objects

DOCS

Last updated: Aug 15th, 7:49am

The UserReceipt data object is designed to carry similar information as the Receipt data object but with a reduced payload and some other slight differences. See UserReceipt Data Objects for the data objects called by UserReceipt.

All other data objects called by the B2B Mobile Transaction API endpoints are defined here. See also Enums and string values.

AcceptanceLocation
AcceptancePartner
AccountBalance
AdditionalData
AdditionalProcessInfo
AdvertisingNetwork
B2bRequest
B2bResponse
Card
CashAccessDepositProperties
CashAccessDetail
CashDeposit
CheckDeposit
CheckoutToken
Customer
CustomerDevice
CustomerInformation
Device
DeviceInformation
EligibleOffers
EntityIdentifier
Error
ExternalEvent
FuelAccessDetail
FuelGrade
FuelPump
FuelReceiptProperties
FuelTicketDetail
GeoCoordinate
Item
KeyValue
LoyaltyAccrualActivity Deprecated
LoyaltyReceipt Deprecated
MessageHeader
MetaData
MobilePaymentCharge
MobileTransactionDetail
Offer
OfferArtifact
OfferCampaign
OfferCampaignRedemptionSchedule
OfferCampaignRedemptionSpecification
OfferCategory
OfferParameters
OfferReward
PaymentAccount
PaymentAccountEnrollmentAdditionalData
PaymentInstrument
PaymentResponse
PaymentResult
PaymentStatus
PaymentTender
POSRequestMobileTender
Receipt
ReceiptParameters
RefundableReceipts
RefundDetail
SecondaryIdentifier
SiteCheckinDetail
SiteLocation
SiteResource
SkuItem
Status
Status (v2)
StatusDetail
TenantIdentifier
TenderType
Ticket
TransactionAcceptanceLocation
TransactionAmountSummary
TransactionFlowRuleSpecification
TransactionMetaData
TransactionMetaData webhook

AcceptanceLocation

Uniquely identifies one physical retail location at which a merchant partner operates. A merchant partner might have one or many acceptance locations defined.

Attribute	Description
`acceptancePartner`	Required `AcceptancePartner` The WLW tenant that is registered to engage in mobile transaction processing for this acceptance location.
`storeCode`	Required String The acceptance partner’s unique identifier for the acceptance location. For example, this code could be a franchise number, store chain id, or ATM identifier. Maximum 50 char.
`uri`	Required String WLW’s unique system identifier for the acceptance location.
`name`	Required String WLW’s text name identifier for the acceptance location.
`address1`	Required String The number and street of the physical address of the acceptance location.
`address2`	Optional String Available for any secondary information about the position of the business address, such as a suite number.
`city`	Required String The name of the city in which the acceptance location exists. Maximum 100 char.
`state`	Required String The US state in the postal address of an entity. Maximum 100 char.
`zipCode`	Required String The postal zip code associated with the acceptance location. Maximum 100 char.
`country`	Required String The country of the acceptance location’s physical address. Maximum 100 char.
`currencyCode`	Optional String The ISO 4217 recognized code for the type of currency supported at the acceptance location. For example, `USD` = United States Dollar. Maximum 50 char.

AcceptancePartner

Uniquely identifies the merchant that is registered to process mobile wallet transactions with WLW. AcceptancePartner is also referred to as the merchant.

Attribute	Description
`uri`	Required String WLW's unique identifier for the acceptance partner.
`name`	Required NCName WLW's plain text name of the acceptance partner.
`partnerUri`	Required String WLW’s unique identifier for a business entity that has been configured to participate in mobile transactions on the WLW platform.
`modifiedTime`	Optional DateTime A timestamp that represents the last time any attribute of this record was updated.
`logoUrl`	Optional String The server path location for the logo image of the acceptance partner. Can be used on receipts.
`cardSurfaceDiscountLabel`	Optional String Indicates the acceptance partner’s preferred payment tender, which can be referenced as an incentive for using that tender in transactions.

AccountBalance

Details about the current value for the card/payment account.

Attribute	Description
`cardUri`	Optional String Unique identifier for a specific card.
`availableBalance`	Optional Double The amount in the account at the moment. 100 char
`availableCredit`	Optional Double The amount of credit the card has available if additional credit is used with the card. 100 char
`balanceAsOfDate`	Optional DateTime The date when this balance was returned.
`balanceErrorCode`	Optional Integer The code for any errors that were encountered when obtaining the balance.
`balanceErrorMessage`	Optional String The text of the error message from the error code.

AdditionalData

A set of key/value properties used send data not specifically defined in the code, typically metadata.

Attribute	Description
`key`	Required String The name of a custom property.
`value`	Required String A specific setting for a custom property.

AdditionalProcessInfo

Defines the properties that need to be provided for an additional transaction process.

Attribute	Description
partnerUri	Required String The WLW system identifier of the parent partner for the acceptance merchant.
acceptancePartnerUri	Required String The WLW system identifier for the merchant that accepts the mobile payment.
additionalInformation	Optional `KeyValue` An unlimited set of properties that are relevant to the additional process.

AdvertisingNetwork

Defines the details of the offer sponsor, as registered and defined by WLW. An Advertising Network (AdNetwork) aggregates advertisement space supply available from publishers and matches it with advertiser demand. In the WLW platform, the AdNetwork groups similar offer objectives together.

Attribute	Description
`advertisingNetworkDisplayName`	Optional String The name used to identify the Advertising Network associated with the offer.
`advertisingNetworkLogoUri`	Optional String A unique identifier for the logo image associated with this Advertising Network.
`advertisingNetworkType`	Optional `advertisingNetworkType` Enum Identifies the Advertising Network’s tenant relationship with WLW. Valid values are: `ACCEPTANCE_PARTER` `ISSUING_PARTNER` `THIRD_PARTY`
`partnerUri`	Optional String Unique identifier for the parent partner under which the advertising network is registered. The parent partner is a tenant relationship and can be an issuing partner, acceptance partner, or third-party entity that has been configured to process mobile payments on the WLW platform.
`partnerNetworkUri`	Optional String Unique identifier for the tenant under which this network is registered.

B2bRequest

The parent class that is extended by request instances calling the B2B Gateway.

Attribute	Description
`messageHeader`	Required `MessageHeader` Header data that identifies the B2B call.

B2bResponse

The parent class that is extended by response instances returned by the B2B Gateway. See B2B Response and Request Structure for more information.

Attribute	Description
`messageHeader`	Required `MessageHeader` Header data that identifies the B2B call.
`configurationDetails`	Optional `ConfigurationDetails` KeyValue Communicates additional information relevant to the outcome of the call as a set of KeyValue pairs.
`status`	Required `Status` Conveys the results of a request, including any relevant errors.

Card

Details required to describe the card/payment account.

Attribute	Description
`accountUri`	Required String Unique identifier for the card (payment account).
`paymentNetworkTypeUri`	Required String Unique identifier for the payment network for the card/payment account.
`paymentAccountTypeUri`	Required String Unique identifier for the type of payment account for the card (payment account).
`verificationStatus`	Required Enum Indicates where in the verification cycle this payment account is. Value values are: `VERIFIED` `DELETED` `PENDING_VERIFICATION` `VERIFICATION_INITIATED`
`balanceUpdates`	Required Boolean Indicates if the balance is updated.
`displayWarning`	Required Boolean Indicates if a warning is displayed.
`paymentAccountState`	Required Enum Indicates the current state of the card (payment account). Valid values include: `ACTIVE` `ABOUT_TO_EXPIRE` `EXPIRED`
`additionalData`	Optional `AdditionalData` Entered in key/value pairs.
`accountBalance`	Required `AccountBalance` Current value in the account.
`createDate`	Required DateTime Date the account was created.
`modifiedDate`	Required DateTime Most recent date when the card/payment account was modified.
`paymentNetworkTypeUri`	Required String Unique identifier for the payment network for the card/payment account.

CashAccessDepositProperties

The properties associated with an ATM deposit transaction of cash and/or checks.

Attribute	Description
`availableBalance`	Required Double The balance of the account into which the deposit was made. Includes the deposit amount.
`availableNow`	Required Double The balance of the account into which the deposit was made that is available for withdrawal at this time.
`cashDeposits`	Optional `CashDeposit` Identifies the denomination of each set of bills included in the deposit.
`checkDeposits`	Optional `CheckDeposit` Identifies the value and URL for an image of each check included in the deposit.
`noOfChecksDeposited`	Optional Integer The number of checks included in the deposit. This number matches the set of instances in the `checkDeposit` property.
`postDate`	Required DateTime The time at which the deposit posted to the account in the format `yyyy-MM-dd’T’HH:mm:ss’Z’`.
`transactionSubType`	Required `TransactionSubType` Enum String that further distinguishes the transaction type.

CashAccessDetail

A container for properties that are applicable only in ATM withdrawal transactions.

Attribute	Description
`cashAccessType`	Required `CashAccessType` Enum Indicates the kind of ATM transaction. Valid values are: `WITHDRAWAL` `DEPOSIT`
`cashAmount`	Optional Double The amount of the withdrawal that is dispensed to the customer. Does not include any surcharge applied to the total debited amount.

CashAccessTicket

The breakdown of the amounts that calculate the total of an ATM transaction.

Attribute	Description
`paymentInstrument`	Required `PaymentInstrument` The registered payment account selected as tender for the ATM transaction.
`amount`	Required Double The total amount of the transaction. Includes the application of any surcharge.
`surcharge`	Optional Double The amount charged by the ATM as a service fee for the transaction.
`subTotal`	Required Double The amount of the transaction prior to the application of any fees.
`cashAccessType`	Required `CashAccessType` Identifies the type of transaction the ticket represents. Valid values are: `WITHDRAWAL` `DEPOSIT`

CashDeposit

Identifies each set of bills included in the ATM deposit based on the denonmination. A single cash deposit transaction can include multiple instances of this object to represent each different bill denomination in the deposit.

Attribute	Description
`billDenomination`	Required Integer The number of dollars or other currency unit for each distinct denomination in this deposit.
`noOfBills`	Required Integer The number of bills of the specified denomination included in this deposit element.

CheckDeposit

Defines the relevant elements of a single check included in an ATM deposit. A single deposit transaction includes an instance of this object for each check in the deposit.

Attribute	Description
`checkValue`	Required Double The dollar or other currency unit of the check. Maximum 100 char.
`url`	Optional String The ATM’s unique identification or image reference of the check.

CheckoutToken

Uniquely identifies the checkout token generated to initiate a transaction.

Attribute	Description
`checkoutTokenValue`	Required String The value represented by the token.
`checkoutTokenType`	Optional `checkoutTokenType` Enum Identifies the type of transaction of the requested token. Valid values are: `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.

ConfigurationDetails

Attribute	Description
`key`	Required String The item being defined.
`value`	Required String The value of the item being defined.

Customer

Identifies a mobile wallet user.

Attribute	Description
`EntityIdentifier`	Required `EntityIdentifier` The base identifier object that this object extends to define a wallet user.
`externalId`	Optional String A unique identifier of the mobile wallet user within the system of the calling service.
`customerInformation`	Optional `CustomerInformation` The object instance that defines the profile data for the mobile wallet user.

CustomerDevice

A device profile that is returned in response to a query for devices associated with a particular customer wallet.

Attribute	Description
`deviceTypesInfo`	Required `DeviceTypesInfo` An object that identfies the `deviceTypeUri`, `displayName`, and `uniqueName` for the type of mobile device, such as iPhone, iPad or Android Galaxy.
`id`	Required Long An alternative identifier for the device.
`active`	Optional Boolean Indicates the status of the device in relation to its associated mobile wallet. `TRUE` means the device is active and capable of engaging in mobile transactions. `FALSE` value means the device has been suspended in some way, possibly locked due to successive login failures or not yet active pending email verification.
`createDate`	Required DateTime The UNIX timestamp value that indicates the date when the mobile wallet was associated with this device.
`customerDeviceUri`	Required String WLW’s unique identifier for this device.
`customerUri`	Required String WLW’s unique identifier for the customer profile to which this device is linked. Maximum 25 char.
`deleted`	Required Boolean Indicates whether this device has been unlinked from the mobile wallet (`TRUE`) or is still linked (`FALSE`).
`deviceDescription`	Required String An informal name set by the customer to distinguish the device from other devices linked to the same wallet.
`deviceUniqueId`	Required String The device manufacturer’s unique identifier for the device, which is collected during linking of the device with the wallet registration.
`partnerUri`	Required String WLW’s unique identifier for a business entity that has been configured to participate in mobile transactions on the WLW platform.
`issuingPartnerUri`	Required String WLW’s unique identifier of a partner that is configured to issue a mobile wallet.
`lastModifiedDate`	Optional DateTime The most recent date in timestamp format on which changes were made to the profile for this device.
`lastLoginDate`	Optional DateTime The most recent date in timestamp format on which the wallet was accessed using this device.

CustomerInformation

Contains the profile data for a mobile wallet user.

Attribute	Description
`email`	Optional String The wallet user’s email address.
`firstName`	Optional String The wallet user’s first name.
`lastName`	Optional String The wallet user’s last name.
`address1`	Optional String The first line of the customer’s street address.
`address2`	Optional String An optional second line to identify the customer’s apartment or other address information.
`city`	Optional String The city of the customer’s address.
`state`	Optional String The postal state code for the state for the customer’s address. Maximum 2 char.
`country`	Optional String The country of the customer’s address.
`zipCode`	Optional String The postal zip code for the customer.
`phone`	Optional String The customer’s primary contact phone number.
`alternateId`	Optional String WLW’s unique identifier for the wallet user that can be used instead of `customerUri` for systems that do not support the length of `customerUri`.
`additionalInformation`	Optional `KeyValue` Key and Value pairs that define custom properties for the customer profile that are not otherwise captured, such as `gender` or `marital status` or `age`. An instance of this object can include any number of these data pairs.

Device

Identifies the device on which a mobile wallet app is installed or registered.

Attribute	Description
`entityIdentifier`	Required `EntityIdentifier` The base identifier object that this object extends to define a mobile device.
`deviceType`	Required `DeviceType` Enum Identifies the specific brand of the mobile device. Valid values are: `iPhone` `Android`
`deviceUniqueId`	Required String The device manufacturer’s unique identifier for the device. This ID is collected during linking of the device with the wallet registration.
`deviceInformation`	Optional `DeviceInformation` The object instance that contains identifying attributes for the mobile device.

DeviceInformation

Stores the profile data for a device linked to a mobile wallet.

Attribute	Description
`customerUri`	Optional String WLW’s unique identifier for the user of the mobile wallet associated with the device.
`createDate`	Optional DateTime The UNIX timestamp that indicates when the device was associated with the mobile wallet.
`deviceDescription`	Optional String A descriptor used to distinguish the device from other devices that might be associated with the same mobile wallet. For example, "Mom’s iPhone" or "Alex’s iPad".
`active`	Optional Boolean Indicates the status of the device in relation to its associated mobile wallet. `TRUE` means the device is active and capable of engaging in mobile transactions. `FALSE` value means the device has been suspended in some way, possibly locked due to successive login failures or not yet active pending email verification.
`advertizingId`	Optional String A WLW value that indicates the device is registered to accept offers from the WLW platform.
`advertizingIdType`	Optional String The type of offers for which the device is registered.
`pushNotificationId`	Optional String A WLW value that indicates the device is registered to receive push notifications from the WLW platform.
`additionalInformation`	Optional String Key and Value pairs that define custom properties of the `device` which are not otherwise captured, such as `color` or `carrier`. An instance of this object can include any number of these data pairs.

DeviceTypesInfo

Defines a specific kind of mobile device.

Attribute	Description
`deviceTypeUri`	Required String WLW’s unique identifier for a supported device platform.
`displayName`	Required String The text name of the device, such as `iPhone`.
`uniqueName`	Required String A unique designation for a supported device, such as `iphone6x-32g`.

EligibleOffers

Defines a set of offers that could be redeemed for the current transaction.

Attribute	Description
`offers`	Optional `Offer` The set of `Offer` instances that are eligible for redemption in the transaction.
`startDate`	Optional DateTime UNIX timestamp for the earliest creation date the offer can have (based on the expiration date of the offer) in order to be eligible for redemption.
`endDate`	Optional DateTime UNIX timestamp for the latest creation date the offer can have (based on the expiration date of the offer) in order to eligible for redemption.
`maxNumberofRows`	Optional Integer Limits the number of returned offers matching the criteria to this number of rows. Maximum 100 char.
`startIndex`	Optional Integer Limits the returned records to offers that match the criteria and appear after this record number. Maximum 100 char.
`endIndex`	Optional Integer Limits the returned records to offers that match the criteria and appear before this record number. Maximum 100 char.

EntityIdentifier

Parent object used to identify any WLW platform entity.

Attribute	Description
`partnerUri`	Required String WLW’s unique identifier for a business partner who is configured to participate in mobile transactions on the WLW platform.
`tenantUri`	Required String The unique ID generated in the WLW system that identifies an acceptance partner, issuer, or third-party processor for a partner that is configured to participate in mobile transactions on the WLW platform.
`uri`	Conditional String The unique identifier of the entity generated by the WLW system. If the entity is a customer, this is the `customerUri` value. If the entity is a merchant, this is the `AcceptancePartnerUri` or other tenant Uri value. In the final, successful step of a multi-step enrollment, `uri` can identify the `paymentAccountUri`. However, the `paymentAccountUri` is null when there are subsequent steps to be processed. When the `uri` identifies a device, it is required.

Error

Provides details on problems that occurred during processing.

Attribute	Description
`errorCode`	Required Enum An enum value that conveys the cause of failure for an API request. Valid values are: `ERR101`- Syntax error `ERR102`- Illegal operation `ERR103`- Service not available. `ERR104`- Partner not found `ERR105`- Already exists `ERR106`- Invalid Credentials `ERR107`- Missing Required Data
`errorMessage`	Required String A plain text message that explains the error code.

ExternalEvent

An action outside the wallet that triggers a reaction in the wallet app.

Attribute	Description
`additionalData`	Optional `KeyValue` A set of any number of key/value properties used to define the external event.
`externalEventType`	Required `ExternalEventType` Enum Identifies the type of change that triggers the mobile wallet response. Valid values are: `FUEL_PUMP_ACTIVATED` `FUEL_START` `FUEL_END` `FUEL_PUMP_DEACTIVATED` `FUEL_SECONDARY_ID_RECEIVED` `FUEL_CANCELED` `FUEL_RECEIPT_RECEIVED` `FUEL_PRE_AUTH_SUBMITTED`

FuelAccessDetail

Defines the properties of a transaction at a fuel station.

Attribute	Description
`additionalData`	Optional `KeyValue` A set of any number of key-value properties used to extend the transaction data.
`fixedAmount`	Required Double The maximum dollar amount of fuel that can be dispensed.
`printReceipt`	Required Boolean Specifies if the customer wants a printed receipt for the transaction.
`pumpNumber`	Required String The fuel site’s identifier of the pump engaged in the transaction. Maximum 10 char.
`acceptanceLocationExternalId`	Optional String The ID generated by the acceptance partner to identify the location engaged in the transaction.
`acceptanceLocatonUri`	Optional String The unique identifier generated by the WLW system to identify the location engaged in the transaction.
`acceptancePartnerUri`	Optional String The unique identifier generated by WLW to identify the acceptance partner of the fuel site.
`partnerUri`	Optional String The unqiue identifier generated in the WLW system to identify the parent partner of the acceptance partner.
`selectedSiteResources`	Optional `SiteResource` The set of user-selected fuel site services for the transaction.

FuelGrade

The fuel variety offered at a specific pump.

Attribute	Description
`available`	Required Boolean Specifies if the fuel grade identified by this object is currently available at the given pump.
`description`	Required String The merchant’s system description for the fuel grade, such as "unleaded regular 87 octane".
`id`	Required String The merchant’s unique identifier for the fuel grade.
`price`	Required Double The cost per unit for this fuel variety. Maximum 10 char.

FuelPump

A fuel pump within a fuel site that acts as a POS terminal for a mobile transaction.

Attribute	Description
`available`	Required Boolean Indicates if the pump is open for use or is currently engaged in another transaction.
`additionalData`	Optional `KeyValue` A set of any number of key-value properties used to extend the transaction data. For example, `key` = `Full Service` `value` = `True`
`fuelGrades`	Optional `FuelGrade` The set of instances that define each fuel grade available at this pump, for example: `regular`, `premium`, `diesel`.
`fuelType`	Required String Merchant-defined depiction of the fuel type dispensed from the pump, such as `Unleaded` vs. `Diesel`.
`pumpNumber`	Required String Identifies the pump as it is labeled within its fuel site location. Maximum 10 char.

FuelReceiptProperties

Extends a receipt with data applicable only to fuel transactions.

Attribute	Description
`additionalData`	Optional `KeyValue` A set of any number of key-value properties used to extend the receipt data.
`fuelUnitsPumped`	Required Double The amount of fuel that was dispensed for the transaction.
`fuelUnitType`	Required `FuelUnitType` Specifies the unit of volume used to measure the fuel. Valid values are: `GALLON` `LITRE`

FuelTicketDetail

Defines purchase specifics applicable only to fuel transactions.

Attribute	Description
`additionalData`	Optional `KeyValue` A set of any number of key-value properties used to extend the transaction data.
`fixedAmount`	Required Double The maximum dollar amount of fuel that can be dispensed.
`printReceipt`	Required Boolean Specifies if the customer wants a printed receipt for the transaction.
`pumpNumber`	Required String The fuel site’s identifier of the pump engaged in the transaction. Maximum 10 char.

GeoCoordinate

The GPS position of an acceptance location.

Attribute	Description
`latitude`	Optional Double The latitudinal value of a mapped point that pinpoints a location on a GPS navigation locating app. Maximum 100 char.
`longitude`	Optional Double The longitudinal value of a mapped point that pinpoints a location on a GPS navigation locating app. Maximum 100 char.

Item

Uniquely identifies a single product within a transaction.

Attribute	Description
`amount`	Optional Double The total cost of the purchase for the specific line item. Maximum 100 char.
`categoryCode`	Optional String The unique identifier of the category into which the item is grouped by the merchant.
`categoryDisplayName`	Required String The text descriptor of the item category as it would appear on a receipt, for example, `Women’s Gloves`.
`categoryName`	Optional String The unique descriptive name of the category as it is represented in the system, for example, `APPAREL_OUTERWEAR_GLOVES_WOMEN`.
`description`	Optional String The description of the specific item, for example, `Ladies’ Leather Gloves, Black Size 7`.
`itemCount`	Optional String The number of units included in the line item. For example, if the unit for grapes is pounds and the total pounds purchased is 3, this value is `3`. Maximum 100 char.
`unitPrice`	Required Double The cost for a single unit of the item. For example, for a 3 pound bunch of grapes, the `unitPrice` might be `1.99` per pound. Maximum 100 char.
`otherTransactionTypeDescription`	Optional String When the `TransactionSubType` value is `other`, this text value describes the nature of the transaction, such as `donation`.
`transactionSubType`	Optional `TransactionSubType` Enum Further categorizes a transaction beyond that of `purchase` or `refund`. Can be used to trigger specific processes.
`itemCode`	Optional String The unique identifier of the item in the POS, such as its SKU or UPC.
`itemDiscountAmount`	Optional Double The dollar amount by which the item’s purchase price is reduced in this transaction. Maximum 100 char.
`itemTaxAmount`	Optional Double The dollar amount of the applied tax for this item.
`unitType`	Optional String The unit of measure used for the item, such as `gallon`, `each`, `package`, as defined by the merchant.

KeyValue

A custom property that applies to the parent class in which it is defined, but which is not captured by default. Defined in terms of pairs of key and value attributes.

Attribute	Description
`key`	Required String The name of a custom property.
`value`	Required String A specific setting for a custom property.

LoyaltyAccrualActivity

Deprecated: This object is deprecated and is no longer available.

Defines the points activity applied based on a qualified loyalty event.

Attribute	Description
`accrualActivityUri`	Required String WLW’s unique identifier of the qualified activity.
`loyaltyAccrualActivityType`	Required `LoyaltyAccrualActivityType` Enum Identifies the loyalty activity category. Valid values are: `EXTERNAL_ACTIVITY` `ENROLLMENT` `PURCHASE` `REFUND` `VOID_PURCHASE` `VOID_REFUND`
`loyaltyProgramUri`	Required String WLW’s unique identifier of the loyalty program for which the activity is eligible.
`paydiantReferenceId`	Required String WLW’s identifier of the transaction associated with the loyalty activity.
`points`	Required Integer The number of points awarded for this accrual instance. Maximum 100 char.
`transactionAmount`	Required Double The dollar amount of the transaction related to the loyalty activity. Maximum 100 char.
`transactionTime`	Optional DateTime The UNIX timestamp that marks completion of the transaction related to the loyalty activity.
`transactionWeight`	Required Integer The number of points earned per dollar spent. Used to calculate the total award. For example, if this value is `2` and the qualifying transaction is `$50`, this accrual would be `100` points. Maximum 100 char.

LoyaltyReceipt

Deprecated: This object is deprecated and is no longer available.

Defines properties related to the conclusion of a transaction in which loyalty points were earned or spent.

Attribute	Description
`accrualActivityUri`	Required String WLW’s unique identifier of the qualified activity.
`loyaltyAccrualActivityType`	Required `LoyaltyAccrualActivityType`Enum Identifies the loyalty activity category. Valid values are: `EXTERNAL_ACTIVITY` `ENROLLMENT` `PURCHASE` `REFUND` `VOID_PURCHASE` `VOID_REFUND`
`loyaltyProgramUri`	Required String WLW’s unique identifier of the loyalty program for which the activity is eligible.
`points`	Required Integer The number of points awarded or redeemed for this transaction. Maximum 100 char.

MessageHeader

An element of the B2bRequest and B2bResponse parent classes that identifies the authorization credentials of the entity calling the WLW B2B Gateway.

Attribute	Description
`partnerId`	Required String A unique value assigned by WLW to identify the partner in order to authenticate the call.
`messageId`	Optional String A reference value that can be used to identify the call for troubleshooting.
`versionId`	Optional String A reference value used to identify the version of the software on which the calling server is running.
`environmentId`	Optional String A reference value used to identify the platform on which the call service is running.

Metadata

Defines the details about a transaction for the retrieveMobileTransactionMetadata webhook.

Attribute	Description
`customerUri`	Optional String WLW’s unique identifier for this customer.
`deviceUri`	Required String An identifier provided by the Merchant for this device.
`deviceUniqueId`	Required String The device manufacturer’s unique identifier for the device, which is collected during linking of the device with the wallet registration.
`externalStoreId`	Required String The acceptance partner’s identifier of the location engaged in the transaction.
`externalCustomerId`	Optional String A unique identifier of the customer from the acceptance partner's external system. Not currently used.

MobilePaymentCharge

Defines a single payment instance, which may or may not complete a transaction.

Attribute	Description
`paymentInstrument`	Required `PaymnetInstrument` An account registered in the mobile wallet that has been selected as the tender for the transaction.
`amount`	Required Double The total dollar amount charged against the account.
`currencyCode`	Required String The ISO 4217 recognized code for the type of currency associated with the amount, for example, `USD` = `United States Dollar`. Maximum 10 char.

MobileTransactionDetail

Provides a snapshot of all calculations in the transaction that make up the final amount due.

Attribute	Description
`transactionAmountSummary`	Optional `TransactionAmountSummary` An itemization of each amount used in the total amount calculation, such as `tax`, `tip`, `discounts`, etc.
`ticket`	Optional `Ticket` A container for all information pertaining to the merchant’s final request for payment.
`redeemedOffers`	Optional `Offer` The set offer instances that were redeemed for the transaction.
`cashAccessDepositProperties`	Optional `CashAccessDepositProperties` Details relevant only when the transaction is an ATM deposit.
`loyaltyAccrualActivites`	Deprecated `LoyaltyAccrualActivity` Optional set of events in the transaction that were eligible for loyalty accrual.
`posRequestedPayments`	Optional `MobilePaymentCharge` The set of individual requests for payment submitted by the POS to the payment processor for this transaction.
`posUtilizedOffers`	Optional `Offer` The set of offers that were processed at the point of sale, rather than redeemed from the wallet.
`currentPaymentResult`	Optional `PaymentResult` Defines the outcome of the most recent payment instance for the transaction.
`previousPaymentResults`	Optional `PaymentResult` The set of objects that define each outcome for all previous payment attempts related to this transaction which can include failures and/or successful partial payments.
`posRequestMobileTender`	Optional `posRequestMobileTender` Defines the payment account that will be used when the POS requests payment authorization for a specific amount to that payment account. This amount may not represent payment in full for the transaction.
`processedPreAuthPaymentResults`	Optional `PaymentResult` The set of instances that define each outcome for any pre-authorization charges applied to the transaction.

Offer

Defines the properties that make up an individual instance of an offer campaign that has been delivered to a mobile wallet, where it can then be activated and redeemed in qualifying transactions.

Attribute	Description
`offerCampaign`	Optional `OfferCampaign` The parent campaign for this offer instance.
`discountAmount`	Optional Double The dollar or percentage amount by which the total purchase is to be reduced when this offer is redeemed. Maximum 100 char.
`expiryDate`	Optional DateTime The UNIX timestamp that indicates when the offer is no longer valid for redemption.
`isRefundable`	Required Boolean Indicates if the offer can be reactivated in the wallet if the transaction in which it was originally redeemed is refunded.
`offerCombinable`	Required Boolean Indicates if the offer can be combined with other qualifying offers within the same purchase.
`offerUri`	Required String WLW’s unique identifier of the offer instance.
`offerStatus`	Optional `OfferStatus` Enum Indicates the current state of the offer in the wallet.

OfferArtifact

Defines each visual part of an offer. The OfferArtifactViewType indicates which part this object defines. The artifact parts are:

Details
Confirmation
Thumbnail
Image
Terms and Conditions
Offer Title
Offer Description
Additional Information
Summary
Redemption Schedule

Attribute	Description
`content`	Required String Depending on the `offerArtifactContentType`, the content can be actual text used or a URL for the content to use when this offer is displayed, or other kind of content.
`offerArtifactChannelType`	Required `OfferArtifactChannelType` Enum Indicates the channel destination where this artifact is intended for display. Valid values are: `MOBILE` `WEB` `FACEBOOK` `EMAIL`
`offerArtifactContentType`	Required `OfferArtifactContentType` Enum Indicates the type of file for the artifact's content. Valid values are: `TEXT` `VIDEO` `URL` `XML` `TAGS`
`offerArtifactViewType`	Required `OfferArtifactViewType` Enum Identifies the part of the offer represented by this artifact.

OfferCampaign

The details of a mobile offer promotional campaign that is delivered to subscribed mobile wallets. Users can then be activated and redeemed as part of a qualifying transaction.

Attribute	Description
`acceptanceLocations`	Optional `AcceptanceLocation` The set of acceptance location instances that identify where this offer campaign is supported for redemption.
`offerArtifacts`	Optional `Offer` The set of objects that define each visual component of this offer.
`advertisingNetwork`	Optional `AdvertisingNetwork` The advertising collection that is sponsoring the promotion of the campaign.
`offerCategories`	Optional `OfferCategory` The set of classifications used to group this offer with similar offers.
`offerCampaignRedemptionSpecification`	Optional `offercampaignredemptionspecification` Defines the criteria that must be met by a mobile transaction in order to redeem this offer. For example, the dates when the offer is valid and any minimum spend amount.
`offerReward`	Optional `OfferReward` Defines the parameters of the specific compensation associated with an offer. For each `RewardType`, the `offerReward` defines the percentage to discount, the total value to discount, or whether this reward is SKU-based.
`checkoutTokenValue`	Optional String A unique identifier code that generates a QR code that can be scanned by a user's phone to redeem this offer.
`startDate`	Optional DateTime UNIX timestamp for the date and time when the offer becomes available.
`endDate`	Optional DateTime UNIX timestamp for the date and time when the offer becomes invalid.
`offerCampaignExternalId`	Optional String An identifier that associates the offer to a relevant merchant value, such as the offer code on the POS system. If this value is not defined, a random value is automatically generated.
`offerCampaignUri`	Optional String WLW’s unique identifier for the campaign.
`offerType`	Optional `OfferType` Enum Identifies the type of offer. Currently only one valid value: `VALUE_BASED_OFFER`. To define a SKU-based reward or to set the percentage discount for the value-based reward, see `RewardType`.
`offerProcessingPoint`	Required `OfferProcessingPoint` Enum Indicates if the offer is calculated by the merchant's POS and only the total sent to WLW or if the entire discount is calculated by the WLW Cloud. Valid values are: `POS` `PAYDIANT`
`skuItems`	Optional `SkuItem` The set of SKU identifiers for any items that can be used for redemption of this offer. For example, if an offer is "buy one cookie, get a free cookie" this value will list the SKU identifiers for all cookies that are eligible as the reward.

OfferCampaignRedemptionSchedule

Defines a specific period of time during which the offer is valid for redemption, such as Friday between 5:00 pm and 7:00 pm.

Attribute	Description
`redemptionStartTime`	Required String The time of day that begins the period during which the offer can be redeemed. 24-hour format: `HH:MM:SS`
`redemptionEndTime`	Required String The time of day that ends the period during which the offer can be redeemed. 24-hour format: `HH:MM:SS`
`offerCampaignRedemptionScheduleType`	Required `OfferCampaignRedemptionScheduleType` Enum Indicates if the redemption schedule period is monthly or weekly. Valid values are: `DAY_OF_WEEK` `DAY_OF_MONTH`
`scheduleValue`	Required String Depending on how the `OfferCampaignRedemptionScheduleType` defines the redemption period, this value is either a day of the week or a day of the month. For example, `"scheduleType":"DAY_OF_WEEK",` `"scheduleValue":"MONDAY"` or `"scheduleType":"DAY_OF_MONTH",` `"scheduleValue":"24"`

OfferCampaignRedemptionSpecification

Combines all the transaction criteria that must be met in order to redeem the offer, such as OfferCampaignRedemptionSchedule, OfferType and the minimum spend value.

Attribute	Description
`offerCampaignRedmptionSchedules`	Optional `OfferCampaignRedemptionSchedule` The set of time period instances that define when the offer can be redeemed.
`minimumSpendValue`	Required Double The minimum amount of money that must be spent in the transaction for it to qualify for the offer. Maximum 100 char.
`offerType`	Optional `OfferType` Enum Indicates if the incentive presented by the offer is monetary or product based. Currently only one valid value: `VALUE_BASED_OFFER`. To define a SKU-based reward or to set the percentage discount for the value-based reward, see `RewardType`.

OfferCategory

Note: Offer categories are planned for future development and are not currently available for use.

Classifications used to group this offer with similar offers.

Attribute	Description
`description`	Required String A brief summary that describes the offer in the category, such as holiday-themed offers throughout the year.
`name`	Required String The name of the category, such as `holidays 2016`.
`offerCategoryUri`	Required String The unique identifier of the offer category within the WLW platform.

OfferParameters

Defines how to restrict the offers returned by retrievals such as by retrieveMobileTransactionMetadata.

Attribute	Description
`startDate`	Required DateTime UNIX timestamp that identifies the earliest creation date that an offer can have in order to be included in this retrieval.
`endDate`	Required DateTime UNIX timestamp for the latest creation date an offer can have in order to be included in this retrieval.
`offerArtifactChannelType`	Required `OfferArtifactChannelType` Enum Indicates the channel destination where this artifact is intended for display. Valid values are: `MOBILE` `WEB` `FACEBOOK` `EMAIL`
`maxNumberofRows`	Optional Integer Limits the number of returned offers matching the criteria to this value. Maximum 100 char.
`startIndex`	Optional Integer Limits the returned records to those that match the criteria and appear after this record number. Maximum 100 char.

OfferReward

Defines the details of the specific compensation associated with an offer. The compensation can be in the form of a percentage of the total to discount or as a total value to remove from the transaction total. The OfferReward can also be defined as a series of SKUs for products offered as the reward.

Attribute	Description
`discountPercentage`	Required Double The percentage used calculate how much the offer will discount the total transaction amount. Maximum 100 char.
`discountValue`	Required Double The dollar amount that the offer will remove from the transaction. Maximum 100 char.
`rewardType`	`RewardType` Enum An enum that specifies if the offer affords a monetary (`VALUE_BASED`) or product (`SKU_BASED`)
incentive.

PaymentAccount

Uniquely identifies a payment account (card) that is registered as a valid tender in the mobile wallet.

Attribute	Description
`entityIdentifier`	Required `EntityIdentifier` The base identifier object that this object extends to define a payment account.
`tenderType`	Required `TenderType` Identifies the tender available to a wallet by identifying the type (credit, debit, etc.) plus the network processor (Visa, NYCE, etc.).
`alternateId`	Optional String An identifier for the payment account that can be used instead of `paymentAccountUri` on systems that do not support the character length of `paymentAccountUri`.
`additionalInformation`	Optional `KeyValue` Defines custom properties of the payment account that are not otherwise captured, such as `nickname`. An instance of this object can include any number of these data pairs.

Note: Emoji characters are prohibited in the nickname value, as they can cause payments to fail.

PaymentAccountEnrollmentAdditionalData

Used to identify custom properties required for base64Binary encryption.

Attribute	Description
`payload`	Optional `base64Binary` The encryption designation.
`attributes`	Optional `KeyValue` The set of property definitions to be encrypted prior to transmission.

PaymentAccountEnrollmentInformation

Defines the basic identifiers for an ongoing enrollment operation.

Attribute	Description
`enrollmentState`	Optional `PaymentAccountEnrollmentState` Enum An enum value that indicates the current status of the enrollment.
`paydiantCorrelationId`	Required String WLW’s unique identifier for an initiated enrollment.
`externalCorrelationId`	Optional String The identifier of the enrollment in a participating external system, such as the payment processor.
`additionalEnrollmentData`	Optional `PaymentAccountEnrollmentAdditionalData` Key-value pairs that define custom properties for the enrollment that are not otherwise captured, such as `Last 4 SSN`. An instance of this object can include any number of these data pairs.

PaymentInstrument

Uniquely identifies a payment account that is registered as a valid tender in the mobile wallet and can require extended data when used in a transaction, such as PayPal.

Attribute	Description
`paymentAccountUri`	Required String Uniquely identifies the payment account in the WLW system.
`tenderType`	Required `TenderType` Identifies the tender available to a wallet by identifying the type (credit, debit, etc.) plus the network processor (Visa, NYCE, etc.).
`additionalData`	Optional `KeyValue` Defines custom properties for the payment instrument that are not otherwise captured, such as `nickname`. An instance of this object can include any number number of these data pairs.
`extendedPaymentTenderData`	Optional `KeyValue` Defines additional data required by a payment processor to obtain payment authorization, such as an auth token or other credentials.

PaymentResult

Defines the response data from all involved parties for the outcome of a payment request.

Attribute	Description
`paymentInstrument`	Required `PaymentInstrument` Defines the PAN data associated with the payment tender.
`currencyCode`	Required String The ISO 4217 recognized code for the type of currency associated with the amount, for example, `USD` = United States Dollar. Maximum 10 char.
`paidOrRefundAmount`	Required Double The dollar amount of the payment instance. This amount may or may not be the full transaction amount.
`paidOrRefundTime`	Optional DateTime The UNIX timestamp for the date When the processor submitted the payment response.
`paydiantReferenceId`	Required String WLW’s unique identifier for the transaction.
`paymentStatus`	Required String WLW’s text description for the current state of the payment authorization.
`paymentStatusCode`	Required Integer WLW’s numeric identifier for the current state of the payment authorization. Maximum 100 char.
`externalPaymentStatusCode`	Optional String The third-party processor’s system identifier for the outcome of the payment authorization.
`externalPaymentStatusDescription`	Optional The third-party processor’s descriptor for the outcome of the payment authorization.
`paymentTransactionUri`	Optional String The third-party processor’s unique identifier for the specific payment authorization instance.
`additionalData`	Optional `KeyValue` Defines custom properties of the payment result that are not otherwise captured, such as `comment`. An instance of this object can include any number of these data pairs.
`mobileReceivedPaymentProcessedMetadata`	Optional `KeyValue` Defines custom properties that are included in the payment authorization and should be available in the receipt, for example, externally-applied loyalty activity.

PaymentTender

Identifies a specific payment instrument configured for use by an issuing or acceptance partner.

Attribute	Description
`tenderType`	Required `TenderType` Identifies the tender available to a wallet by identifying the type (credit, debit, etc.) plus the network processor (Visa, NYCE, etc.).
`splitPaymentEnabled`	Optional Boolean Indicates if the tender can be used in conjunction with another tender to complete a payment.

POSRequestMobileTender

Defines a request from the POS to solicit the user to designate a payment tender.

Attribute	Description
`amount`	Require Double The dollar amount to be charged for this tender. Maximum 100 char.
`currencyCode`	Required String The ISO 4217 recognized code for the type of currency associated with the amount, for example, `USD` = United States Dollar. Maximum 10 char.
`accountTypeUri`	Optional String WLW’s unique identifier for the type of payment configured on the platform for a specific partner or tenant.
`networkTypeUri`	Optional String WLW’s unique identifier for the type of network configured on the platform for a specific partner or tenant.

PaymentResponse

Includes the status of the payment in the standard B2B Response:
B2bResponse + PaymentStatus

PaymentStatus

String that conveys the results of the payment transaction.

Attribute	Description
`code`	Required String The code that describes the current state of payment transaction.
`description`	Required String Plain text description of the payment status.

Receipt

Defines the details of a completed transaction.

Attribute	Description
`acceptanceLocation`	Optional `AcceptanceLocation` The specific location where the transaction was processed.
`items`	Optional `Item` The set of individual products rung in for the transaction.
`loyaltyReceipts`	Deprecated `LoyaltyReceipt` Optional set of loyalty activity instances applied to the transaction.
`offers`	Optional `Offer`The set of offers that were redeemed or refunded for the transaction.
`paymentResults`	Optional `PaymentResult` The set of outcomes for each payment authorization attempt for the transaction.
`receiptType`	Required `ReceiptType` Enum Identifies the type of transaction for this receipt.
`cashierId`	Required String The identifier of the employee logged into the POS who rang in the transaction.
`createDate`	Required DateTime UNIX timestamp when the receipt was generated.
`merchantTranasctionReferenceId`	Required String The merchant (AcceptancePartner)’s unique identifier of the transaction.
`originalReceiptId`	Required String A unique identifier of the receipt for the transaction that precipitated this transaction, such as a purchase for which this is a refund.
`paydiantReferenceId`	Required String WLW’s unique identifier of the transaction.
`receiptId`	Required String WLW’s identifier of the generated receipt instance.
`savings`	Required Double The dollar amount by which the total is reduced by coupons or other promotions. Maximum 100 char.
`subTotal`	Required Double The dollar amount due before applied tax, tip, and discounts. Maximum 100 char.
`tax`	Required Double The dollar amount added to the ticket for tax. Maximum 100 char.
`tipAmount`	Required Double The dollar amount appended to the total as tip.
`totalAmount`	Required Double The total dollar amount paid for the transaction. Maximum 100 char.
`terminalId`	Required String WLW’s identifier of the registered POS terminal that processed the transaction.
`transactionSubType`	Optional `TransactionSubType` Enum Further categorizes a transaction beyond that of `purchase` or `refund`.
`otherTransactionTypeDescription`	Optional String When the `TransactionSubType` value is `other`, this text value describes the nature of the transaction, such as `donation`.
`externalReceiptUrl`	Optional String Used to store a merchant-provided URL through which the user can view the receipt in a secure portal.
`offerDiscount`	Required Double The total amount due after an offer discount has been applied. Maximum 100 char.
`receiptText`	Optional String A text message that can be added to the receipt by the merchant.
`fuelReceiptProperties`	Optional `FuelReceiptProperties` A set of properties that describe the fuel activity instances for this transaction.
`cashAccessDepositProperties`	Optional `CashAccessDepositProperties` Specifies the details for an ATM deposit transaction. Required when the `TransactionType` is `ATM_CASH_ACCESS`.
`surcharge`	Optional Double The dollar amount added to a cash withdrawal as a transaction fee. Maximum 100 char.
`includedGratuity`	Optional Double The dollar amount added as an automatically applied tip, for example for large dining parties. Maxcimum 100 char.
`totalAmountPoints`	Deprecated Double Optional total of points added or subtracted for the transaction based on all loyalty activity processed. Maximum 100 char.

ReceiptParameters

Defines how to restrict receipts returned by methods such as retrieveMobileTransactionMetadata.

Attribute	Description
`startDate`	Optional DateTime UNIX timestamp for the earliest date on which receipts must fall in order to be included in this retrieval.
`endDate`	Optional DateTime UNIX timestamp for the latest date on which receipts must fall in order to be included in this retrieval.
`retrieveRefundableReceipts`	Required Boolean Used to restrict the retrieval to receipts that are configured as refundable.
`maxNumberofRows`	Optional Integer Limits the number of returned receipts matching the criteria to this amount. Maximum 100 char.
`startIndex`	Optional Integer Limits the returned receipts to those that match the criteria and appear after this record number. Maximum 100 char.

RefundableReceipts

The set of receipts that are identified as refundable and the filtering criteria used to include them in a retrieval.

Attribute	Description
`receipts`	Optional `Receipt` The set of refundable receipt instances that match all the specified filtering criteria.
`startDate`	Optional DateTime UNIX timestamp for the earliest date on which receipts that meet the refund criteria must fall in order to be included in this retrieval.
`endDate`	Optional DateTime UNIX timestamp for the last date on which receipts that meet the refund criteria must fall in order to be included in this retrieval.
`startIndex`	Optional Integer Limits the returned receipts to those that match the criteria and appear after this record number. Maximum 100 char.
`endIndex`	Optional Integer Limits the returned records to offers that match the criteria and appear before this record number. Maximum 100 char.
`maxNumberofRows`	Optional Integer Limits the number of returned receipts matching the criteria to this amount. Maximum 100 char.

RefundDetail

Defines transaction properties that are applicable only in refund transactions.

Attribute	Description
`merchantTransactionRefId`	Optional String The unique identifier generated in the merchant's system to identify the transaction.
`acceptancePartnerUri`	Optional String The unique identifier generated in the WLW system to identify the acceptance partner of the transaction.
`paydiantReferenceId`	Required String WLW’s unique identifier of the current transaction.
`receiptId`	Required String The unique identifier generated in the WLW system for the original transaction receipt to which this refund applies. Maximum 10 char.

SecondaryIdentifier

A code used for multi-factor consent in transactions requiring charge pre-authorization.

Attribute	Description
`secondaryId`	Required String A code generated to confirm a user’s consent to a pre-authorization charge against a payment account.

SiteCheckInDetail

Transaction properties that are applicable only in fuel transactions that support geo-location check-in.

Attribute	Description
`acceptanceLocationExternalId`	Optional String The unique identifier of the acceptance location within the system that coordinates the site check-in.
`geoCoordinate`	Optional `GeoCoordinate`The longitude and latitude positions that identify the geo location of the site.
`additionalData`	Optional `KeyValue` Extends the check-in parameters as required by the site coordinator or location. There can be as many instances of this object as needed.

SiteLocation

An in-range fuel site to which the app can declare itself in order to retrieve information about available pumps or services.

Attribute	Description
`fuelPumps`	Optional `FuelPump` The set of instances that define each fuel pump terminal at the fuel site location.
`siteResources`	Optional `SiteResource` The set of objects that define other facilities at the site location with which the app can interact, such as a car wash or service center.
`siteCheckInDetail`	Required `SiteCheckInDetail` Defines a fuel site’s geo-location check-in parameters so the app can retrieve resource availability details.
`additionalData`	Optional `KeyValue` Defines custom properties that extend the site location definition with data that is otherwise not captured. There can be as many instances of this object as needed. For example, `key` = `Wait_Time`; `value` = `10-min`.

SiteResource

A fuel site entity other than a fuel pump with which the mobile payments app can interact to initiate a transaction, such as a car wash or vacuum.

Attribute	Description
`available`	Required Boolean Indicates if the resource is open for use or is currently engaged in another transaction.
`description`	Required String The merchant’s description of the resource, such as `Deluxe Car Wash`.
`id`	Required String The unique system identifier generated in the merchant's system for the resource.
`name`	Required String The merchant’s display name for the resource, such as `DCW01`.
`additionalData`	Optional `KeyValue` Defines custom properties that extend the site resource definition with data that is otherwise not captured. There can be as many instances of this object as needed. For example, `key` = `Wait_Time`; `value` = `10 min`.

SkuItem

A specific product available for purchase at an acceptance location that can be part of a mobile transaction offer promotion.

Attribute	Description
`itemCode`	Required String The unique product code that identifies the product within the merchant POS system.

Status

A legacy (B2B v1) object that concatenates individual responses from platform components and external parties and maps them to a set of WLW error codes. This object is seldom returned in B2B Mobile Transaction API (v2) responses.

Attribute	Description
`statusCode`	Required `StatusCode` Enum Describes the outcome of a call to the B2B Customer Care API, which treats responses slightly differently because the calls are typically not routed to an external entity, such as a payment processor.
`statusDescription`	Required String A plain text message that further describes the nature of the status code to which it is associated.
`error`	Required `Error` Array The set of errors related to the outcome of the call.

Status (v2)

An improved status that includes the raw individual responses from platform components and external parties involved in the transaction.

Attribute	Description
`statusCode`	Required `StatusCode` Enum Identifies the outcome of the call to the B2B Gateway.
`statusDescription`	Optional String Message associated with the status code that explains the nature of the result.
`statusDetails`	Optional `StatusDetail` Array A set of instances that represent the unchanged responses from internal platform components and/or 3rd parties involved in the transaction, for a deeper explanation of the call outcome.

StatusDetail

Data that provide more information about a particular status code.

Attribute	Description
`statusCode`	Required String Identifies the basis for the overall call status. This can be an error code or a confirmation code from an external processor or some other relevant reference.
`statusDescription`	Optional String Message associated with the status code that explains its meaning.
`statusType`	Optional `StatusType` Enum Indicates the entity from which this status information originated. Valid values are: `PLATFORM` `EXTERNAL_PROCESSOR`

TenantIdentifier

Identifies the details of a WLW partner authorized to submit calls to the B2B gateway. A tenant can be an acceptance partner, an Issuer, or a third-party processor.

Attribute	Description
`partnerUri`	Required String The unqiue identifier generated in the WLW system to identify the parent partner of the acceptance partner.
`tenantUri`	Required String The unique ID generated in the WLW system that identifies an acceptance partner, issuer, or third-party processor for a partner that is configured to participate in mobile transactions on the WLW platform.

TenderType

Identifies the tender available to a wallet by identifying the type (credit, debit, etc.) plus the network processor (Visa, NYCE, etc.) the tender uses.

Attribute	Description
`accountTypeName`	Optional String Text name for the type of payment for this tender, such as `Credit`, `Debit`, or `Gift`.
`accountTypeUri`	Required String WLW’s unique identifier for the type of payment configured on the platform for a specific partner or tenant.
`networkTypeName`	Optional String Text name of the network processor for this tender, such as `Visa`, `NYCE`, `ValueTek`, etc.
`networkTypeUri`	Required String WLW’s unique identifier for the type of network configured on the platform for a specific partner or tenant.

Ticket

Defines the properties associated with each component that is calculated to result in the total amount due for a mobile transaction.

Attribute	Description
`lineItems`	Optional `Item` Instances that define each individual product code included in a transaction.
`ticketType`	Required `TicketType` Enum Identifies the type of transaction associated with this ticket, which can impact the expected data to be included.
`cashierId`	Required String The identifier of the employee logged into the POS who rang in the transaction.
`cashierName`	Optional String Used to store the employee name associated with the cashierId value.
`checkNumber`	Optional String The POS identifier of the individual order.
`tableNumber`	Optional String The POS identifier of the station location within a restaurant.
`discountAmount`	Required Double The dollar amount by which the total is reduced due to coupons or other promotions. Maximum 100 char.
`discountedAmount`	Required Double The total amount due after the discount has been applied.
`merchantTransactionRefId`	Required String The merchant’s unique identifier of the transaction.
`taxAmount`	Required Double The dollar amount added to the ticket for tax. 100 maximum char.
`originalAmountLessTaxes`	Optional Double The dollar amount of the transaction before tax was applied. Maximum 100 char.
`amount`	Required Double The total dollar amount due. Maximum 100 char.
`subTotal`	Required Double The dollar amount due before applied tax, tip, and discounts. Maximum 100 char.
`terminalId`	Required String WLW’s identifier of the registered POS terminal the processed the transaction.
`totalTicketTipAmount`	Optional Double The dollar amount appended to the total as tip. Maximum 100 char.
`transactionSubType`	Optional `TransactionSubType` Enum Further categorizes a transaction beyond that of `purchase` or `refund`.
`otherTransactionTypeDescription`	Optional String When the `TransactionSubType` value is `Other`, this text describes the nature of the transaction, such as `Donation`.
`fuelTicketDetail`	Optional `FuelTicketDetail` A collection of ticket properties applicable only to fuel transactions.
`surcharge`	Optional Double The dollar amount added to the purchase or withdrawal amount as a service fee.
`checkRevision`	Optional String If the original check was changed, this is the check number for the revised ticket.
`amountPoints`	Deprecated Double Optional number of loyalty points awarded for this transaction. Maximum 100 char.
`calculateTipAmount`	Optional Double The portion of the total check that subject to a tip. For example, in a check where a souvenir T-shirt was also purchased, only the food and beverage cost can be applicable to an automatically applied gratuity.
`includedGratuity`	Optional Double The dollar amount added as an automatically applied tip, typically used for large dining parties.

TransactionAcceptanceLocation

An extended instance of AcceptanceLocation that specifies transaction-related settings.

Attribute	Description
`tippingEnable`	Optional Boolean Indicates if transactions at the location support adding a tip to the amount due (`TRUE`) or if tipping is not allowed at this location (`FALSE`).

TransactionAmountSummary

Defines the calculation of values that make up a transaction charge.

Attribute	Description
`totalTaxAmount`	Required Double The dollar amount added to the purchase for tax.
`transactionAmount`	Required Double The dollar amount of the entire transaction cost. Maximum 100 char.
`totalAmountDue`	Required Double The dollar amount of the current balance owed. Maximum 100 char.
`totalAmountPaid`	Required Double The portion of the total transaction amount that is already paid. Maximum 100 char.
`totalTipAmount`	Required Double The dollar amount added to the total as a tip. Maximum 100 char.
`transactionPointsAmount`	Deprecated Double Required number of loyalty points associated with the transaction. Maximum 100 char.
`totalPointsDue`	Deprecated Double Required number of loyalty points owed. Maximum 100 char.
`totalPointsPaid`	Deprecated Double Required number of loyalty points redeemed to pay for the transaction.
`totalOfferDiscountAmount`	Required Double The dollar amount by which the total is reduced by coupons or other promotions. Maximum 100 char.

TransactionFlowRuleSpecification

Defines the manner in which a particular flow rule is handled for the transaction, including what data is expected, whether the transaction needs to wait for certain events before continuing, and other processing decisions. This information is typically returned by the platform in a method response so that the developer can respond with relevant information or input fields.

Attribute	Description
`transactionFlowRule`	Required `MobileTransactionFlowRule` Enum Identifies the applicable flow rule for this specification.
`expectsCheckoutToken`	Required Boolean Indicates if `checkoutToken` can be null (`FALSE`) for calls specifying this flow rule or if the `checkoutToken` must be present (`TRUE`).
`expectsPaydiantReferenceId`	Required Boolean Indicates whether the [`paydiantReferenceId`] must be populated (`TRUE`) or can be null (`FALSE`) for the related flow rule.
`stepNumber`	Required Integer Identifies this rule’s position in the transaction sequence. Maximum 100 char.
`stepOptional`	Required Boolean Indicates if this rule can be omitted from the transaction flow (`TRUE`) or if it is required (`FALSE`).
`transactionType`	Required `TransactionType` Enum Indicates the type of transaction this specification.
`additionalRuleProcessingMetaData`	Optional `KeyValue` Defines custom properties to provide any other data pertinent to this flow rule in this type of transaction.
`blockUntilEvents`	Optional `LifeCycleEventType` Enum Indicates the events that must occur before this flow rule can execute in this transaction type.
`expectsOffers`	Required Boolean Indicates if this flow rule requires offers to be submitted in order to complete (`TRUE`) or if the flow rule does not wait for an offer (`FALSE`).
`eligibleOfferType`	Optional `EligibleOfferType` Enum Indicates the kind of offers that are supported for the transaction. Offers are categorized based on whether the offer is being calculated by the WLW service or input directly into the POS, or if the location permits both kinds or neither. Valid values are: `POS` `PAYDIANT` `POS_PAYDIANT` `NONE`
`executeRuleAfterTimeoutForPreExecutionEvent`	Optional Boolean When the rule is contingent on a pre-execution event, this setting specifies whether the rule should still fire if the pre-execution event times out (`TRUE`) or if the rule should stop processing if the pre-execution rule times out (`FALSE`).
`executeRuleAndPollForResult`	Required Boolean Indicates if the service should begin listening for a response to the event simultaneously with its execution (`TRUE`) or if the rule should execute without listening for a response.
`expectsPaymentTendersSpecifies`	Required Boolean Indicates if payment account selection must be populated in calls that specify this flow rule for this `TransactionType` (`TRUE`) or if the payment account selection does not need to be populated in calls that specify this `transactionType` (`FALSE`).
`expectsTransactionData`	Required Boolen Indicates if additional metadata must be populated for calls that specify this flow rule for this `TransactionType` (`TRUE`) or if this `transactionType` and flow rule do not require any additional data (`FALSE`).
`numberOfTimesToRetryRequest`	Required Integer The number of times to automatically repeat attempts to execute this rule before the event is considered to have failed. Maximum 10 char.
`pollUntilTransactionErrorStatuses`	Optional `TransactionStatus` Enum A set of values that the server expects in a failure response for this event. The service continues listening until at least one of the acceptable errors is returned or the event times out.
`pollUntilTransactionSuccessStatuses`	Optional `TransactionStatus` Enum A set of values that the server expects in a success response for this event. The service continues listening until at least one of the acceptable success messages are returned or the event times out.
`preExecutionEventWaitTime`	Optional Integer The number of seconds to delay before executing this event. Maximum 10 char.
`requestProcessingTimeInSeconds`	Required Integer The number of seconds it takes for this event to complete. Maximum 100 char.
`returnEligibleOffers`	Required Boolean Indicates if this rule passes the set of eligible offers in a response (`TRUE`) or if `eligibleOffers` are not returned as part of this rule (`FALSE`).
`returnNextProcessingRule`	Required Boolean Indicates if this rule response identifies the flow rule that will execute next (`TRUE`) or if the response does not include the next rule (`FALSE`).
`returnTransactionDetails`	Required Boolean Indicates if this rule response passes requested transaction details (`TRUE`) or does not include any `MobileTransactionDetails` (`FALSE`).
`returnTransactionStatus`	Required Boolean Indicates if this rule response passes requested `TransactionStatus`.
`transactionStatusesAfterRuleExecution`	Optional `TransactionStatus` Enum The set of transaction status values, at least one of which is expected following completion of the rule.
`transactionStatusesBeforeRuleExecution`	Optional `TransactionStatus` Enum The set of values, at least one of which must occur in order for this rule to execute.
`waitForPreExecutionEvent`	Optional `LifeCycleEventType` Enum If populated, the flow rule cannot complete until the event specified by this value has fired.
`waitTime`	Required Integer The number of milliseconds to delay execution of this rule once the specified pre-execution event has fired. Maximum 100 char.
`returnTransactionMetaData`	Required Boolean Indicates if this rule response contains additional meaningful metadata not otherwise collected for the transaction (`TRUE`).
`returnRefundableReceipts`	Required Boolean Indicates if this rule response contains the list of receipts that are valid for a refund transaction at the current location (`TRUE`).

TransactionMetaData

Basic merchant information passed to the app during discovery in order to initialize a transaction.

Attribute	Description
`acceptanceLocation`	Required `TransactionAcceptanceLocation` The acceptance location data transmitted by the merchant during transaction initiation.
`supportedPaymentTenders`	Optional `PaymentTender` The set of acceptable forms of payment configured for the acceptance location.
`siteLocation`	Optional `SiteLocation` Information sent about the location that is applicable when the location is a fuel site.

TransactionMetaData webhook