B2B Customer Care - Data Objects

DOCS

Last updated: Aug 15th, 7:50am

AccountBalance
AdditionalCustomerInformation
AdditionalData
AdditionalDataValidation
AdditionalHeaderValues
AuditInfo
B2bRequest
B2bResponse
Card
CardDetails
ConfigurationDetails
CustomerCardInfo
CustomerDevice
CustomerEmailInfo
CustomerLookupInfo
CustomerOfferInfo
CustomerTransactionInfo
Device
DeviceTypesInfo
DoubleDeposit
Error
EventAttributes
LineItem
LoyaltyAccuralActivity Deprecated
LoyaltyAccrualActivityResult Deprecated
LoyaltyExternalActivity Deprecated
MessageHeader
PaymentInfo
PaymentResponse
PaymentStatus
QueryRequest
QuestionAnswer
QuestionDetail
Receipt
SKUItems
Status
StoreInfo
TenderType
TenderTypeMetaData
TransactionProcessingEvent

Data Objects

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 this 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 that was encountered.

AdditionalCustomerInformation

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

AdditionalData

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

AdditionalDataValidation

Attribute	Description
`maxLength`	Optional Integer The maximum field length for this value.
`minLength`	Optional Integer The minimum field length for this value as appropriate for the payment type and property as well as whether the property is required.
`regex`	Optional String Sequence of characters that define the format of this additional metadata.

AdditionalHeaderValues

Additional metadata data needed to identify this event.

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

AuditInfo

String fields available to track various information.

Attribute	Description
`source`	Required String Indicates where the audit info comes from.
`reasonCode`	Required String A merchant-specific code used to identify the audito info type.
`message`	Optional String Text for the audit info.
`correlationId`	Optional String Merchant-supplied code to align this audit info internally.

B2bRequest

Identifies a request to the B2B gateway.

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

B2bResponse

Standard details about the response from the B2B Gateway.

Attribute	Description
`messageHeader`	Required `MessageHeader` Header data that identifies the B2B call.
`configurationDetails`	Optional `ConfigurationDetails` Enum 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 this card/payment account.

Attribute	Description
`accountUri`	Required String Unique identifier for this card (payment account).
`paymentNetworkTypeUri`	Required String Unique identifier for the payment network for this card/payment account.
`paymentAccountTypeUri`	Required String Unique identifier for the type of payment account for this 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 this card/payment account.

CardDetails

A custom property value used to pass data about the card in key/value pairs.

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

ConfigurationDetails

Key value pairs available to store configuration details. Not evaluated or used.

Attribute	Description
`key`	Required String Identifies the WLW platform on which the calling service is running, for example, `Test`, `Production`, or `Staging`.
`value`	Required String Identifies the WLW platform on which the calling service is running, for example, `Test`, `Production`, or `Staging`.

CustomerCardInfo

Details about the customer's card (payment account).

Attribute	Description
`nickName`	Required String The personal nickname given to the payment account by the user.
`cardUri`	Required String The unique identifier for this card.
`paymentNetworkTypeUri`	Required String Unique identifier that identifies the type of payment network for this device.
`paymentAccountTypeUri`	Required String Unique identifier that identifies the type of payment account for this device.
`verificationStatus`	Required String Status of whether the card has been verified. Valid valuesare: `VERIFIED` `DELETED` `PENDING_VERIFICATION` `VERIFICATION_INITIATED`
`maskedCardNumber`	Required String The last four digits of the card used as an identifier.
`createDate`	Required dateTime A `UNIX Timestamp` value representing the date on which the mobile wallet was registered.

CustomerDevice

Details that identify the customer's device.

Attribute	Description
`deviceTypesInfo`	Required Object Instances of the `DeviceTypesInfo` object that defines the devices for this customer.
`id`	Required Long An ID for the device.
`active`	Required Boolean Indicates whether the mobile wallet is functional or in a suspended state. Valid values are: `TRUE` - Active `FALSE` - Deactivated
`createDate`	Required dateTime A UNIX timestamp value representing the date on which the mobile wallet was registered.
`customerDeviceUri`	Required String The unique identifier for this customer’s device.
`customerUri`	Required String The unique identifier of a registered mobile wallet user.
`deleted`	Required Boolean Indicates if this device has been deleted from this customer.
`deviceDescription`	Required String An informal name set by the customer to identify the device.
`deviceUniqueId`	Required String An alternative to uniquely identify the device for legacy systems that cannot support longer data values.
`issuingPartnerUri`	Required String The unique identifier of the WLW partner that issued the mobile payments app for which the wallet is registered.
`lastModifiedDate`	Required dateTime The most recent date on which the wallet was changed by this device.
`lastLoginDate`	Required dateTime The most recent date on which the wallet was accessed by this device.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.

CustomerEmailInfo

Details about the customer's email.

Attribute	Description
`activeBoolean`	Required Boolean Whether the mobile wallet is functional or in a suspended state. See `retrieveCustomerLookupInfo` - locked for more information. Valid values are: `TRUE` - Active `FALSE` - Deactivated
`email`	Required String The email address (username) under which the wallet is registered.
`customerUri`	Required String The unique identifier of a registered mobile wallet user.

CustomerLookupInfo

Details about the customer.

Attribute	Description
`devices`	Required `Device` Instances of one or more mobile associated with the mobile wallet.
`deviceUri`	Required String The unique identifier of the device.
`deviceUniqueId`	Required String An alternative to uniquely identify the device for legacy systems that cannot support longer data values.
`deviceDescription`	Required String An informal name set by the customer to identify the device.
`active`	Required Boolean Indicates if the mobile wallet is functional or in a suspended state. Valid values are: `TRUE` - Active `FALSE` - Deactivated
`locked`	Required Boolean Indicates if the device is locked. A locked device or security profile means the customer used invalid credentials too many times. Note that this is different from the active attribute that means the account or device was explicitly deactivated via the B2B. Profiles or devices can be `Active` + `Locked`, `Active` + `Unlocked`, `Inactive` + `Locked`, but they cannot be `Inactive`+ `Unlocked` because when an account or device is explicitly deactivated that action also locks the security profile. Valid values are: `TRUE` - Locked `FALSE` - Unlocked
`lastLoginDate`	Required dateTime The most recent date on which the wallet was accessed by this device.
`additionalCustomerInformation`	Optional `AdditionalCustomerInformation` Used to retrieve a variety of customer metadata via the B2B gateway in a KeyValue pair.
`customerUri`	Required String The unique identifier of a registered mobile wallet user.
`issuingPartnerUri`	Required String The unique identifier of the WLW partner that issued the mobile payments app for which the wallet is registered.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.
`createDate`	Required dateTime A `UNIX Timestamp` value representing the date on which the mobile wallet was registered.
`issuingPartnerShortName`	Required String The common name for the issuing partner.
`active`	Required Boolean Indicates if the mobile wallet is functional or in a suspended state. See "locked" below for more information. Valid values: `TRUE` - Active `FALSE` - Deactivated
`locked`	Required Boolean A locked device or security profile means the customer used invalid credentials too many times. Note that this is different from the `active` attribute that means the account or device was explicitly deactivated via the B2B API. Profiles or devices can be `Active` + `Locked`, `Active` + `Unlocked`, `Inactive` + `Locked`, but they cannot be `Inactive` + `Unlocked` because when an account or device is explicitly deactivated that action also locks the security profile. Valid values are: `TRUE` - Locked `FALSE` - Unlocked
`email`	Required String The email address (username) under which the wallet is registered.
`emailPending`	Optional String A new email address that was sent as a replacement but has not yet been verified.
`customerId`	OptionalString A unique identifier for the customer assigned by WLW.
`username`	Required String The email for this wallet user.
`firstName`	Required String The wallet owner’s first name. This parameter must be used in conjunction with at least one other parameter.
`lastName`	Required String The wallet owner’s last name.
`address1`	Required String The first line of the wallet owner’s street address.
`address2`	Optional String An optional second line to describe the address of the wallet owner.
`city`	Required String The city of the wallet owner’s address.
`country`	Required String The country of the wallet owner’s address.
`state`	Required String The postal state code for the state for the wallet user’s address. 2 char
`zip`	Required String The postal zip code for the wallet user.
`phone`	Required String The phone number used to contact the wallet owner.
`passwordChangedDate`	Optional dateTime The date in `UNIX Timestamp` on which the wallet password was last updated. For a new customer, this is the date the customer was added.
`passcodeChangedDate`	Optional dateTime The date in UNIX timestamp on which the wallet passcode was last updated. For a new customer, this is the date the customer was added.
`securityQuestionsChangedDate`	Optional dateTime The date in UNIX timestamp on which the wallet security questions were last updated. For a new customer, this is the date the customer was added.
`LastLoginDate`	Optional dateTime The most recent date when the wallet owner logged in.
`emailVerified`	Required Boolean Indicates if the email for this wallet user has been verified via a sent link. Valid values are true or false.
`emailVerifiedDate`	Optional dateTime The date on which the email of the wallet owner was verified via the sent link.

CustomerOfferInfo

Attribute	Description
`offerUri`	Required String The unique identifier for an offer.
`offerId`	Optional String An additional identifier for an offer.
`offerCreatorName`	Optional String The name of the entity that created this offer.
`expirationDate`	Optional dateTime The date on which this offer is no longer redeemable.
`offerProcessingPoint`	Optional Enum Indicates if the offer is processed at the POS or in the WLW cloud. Valid values are: `POS` `PAYDIANT`
`skuItems`	Optional Object Complex object used to add the numbers of the SKU for items that are part of a reward offer for this campaign.
`itemCode`	Required String Code to identify the item.
`offerCampaignExternalId`	Optional String Used to associate this offer to any identification that may be relevant for the merchant, such as the offer code on the POS system. If this value is not entered, a random value is automatically generated.
`rewardType`	Optional Enum Enum value for the kind of reward. Currently only one valid value: `VALUE_BASED_REWARD`
`offerDiscountAmount`	Optional Double The amount by which the cost of an item is reduced when the associated offer is redeemed. This value represents a dollar amount. 100 char
`offerDiscountPercentage`	Optional Double The amount by which the cost of an item is reduced when the associated offer is redeemed. This value represents a percentage amount. 100 char
`offerCombinable`	OptionalBoolean Indicates if this offer can be combined with another offer in the wallet.
`offerRefundable`	Optional Boolean Indicates if their offer can be refunded if the customer cannot redeem it for some reason.
`status`	Optional Enum Indicates the current status of the offer. Valid values are: `ACTIVE` `REDEEMED` `REDEEM_PENDING` `EXPIRED` `CANCELLED` `REVERSAL_PENDING` `REVERSAL_FAILED` `VOID_PENDING` `REFUND_PENDING`

CustomerTransactionInfo

Details about the transaction.

Attribute	Description
`merchantTransactionReferenceId`	Optional String Unique identifier that assigned by the merchant that distinguishes the service instance of this transaction.
`terminalId`	Required String Unique identifier of the specific POS terminal within a particular acceptance location.
`location`	Required Object Identifies the `StoreInfo` where the transaction took place.
`transactionType`	Required String Identifies the type of transaction for the flow rule specified. Valid values are: `PURCHASE` `REFUND` `CASH_WITHDRAWAL`
`otherTransactionTypeDescription`	Required String When a `transactionSubType` of `OTHER` is specified, this attribute enables you to include additional information that may be relevant to the transaction, for example, donation or pre-order deposit. Used by the POS APIs, not the B2B Customer Care APIs.
`offers`	Optional Object The set of `CustomerOfferInfo` objects representing any price reductions that were redeemed for the transaction.
`payments`	Optional Object The set of `PaymentInfo` objects representing each individual payment authorization request made to complete the transaction. This set may include multiple paymentInfo instances for split or multi tender transactions.
`instanceUri`	Required String Unique identifier for this instance.
`paydiantTransactionRefId`	Contextual String A unique transaction identifier generated by the WLW service. 36 char
`receiptId`	Required String A unique identifier assigned by the WLW host to associate receipt data with a specific transaction. 100 char
`transactionStatus`	Required String The `TransactionStatus` for the current transaction.
`receipt`	Contextual Object An instance of the `Receipt` object that informs the platform of the details required to generate a receipt for the transaction.
`loyaltyAccrualActivity`	Deprecated `LoyaltyAccrualActivity` Optional set of instances that define the coordinated adjustments that were made to a wallet user’s linked loyalty subscription in connection with the associated transaction.
`totalAmount`	Required Double The total amount due for the transaction at the time of submission, after all adjustments have been applied. 100 char
`discountAmount`	Required Double The amount of discount being applied in this transaction. 100 char
`discountedAmount`	Required Double The newly calculated amount due after the `discountAmount` has been subtracted. 100 char
`subtotal`	Required Double The amount of the purchase after discounts or tip adjustments have been applied, but before applicable tax has been added. 100 char
`tipAmount`	Required Double The dollar amount added to the amount due based on the wallet user’s allocation of a gratuity. 100 char
`tax`	Required Double The dollar amount added to the amount due based on required sales or meals tax calculations. 100 char

Device

Details that describe the device associated with a mobile wallet.

Attribute	Description
`customerUri`	Required String The unique identifier of a registered mobile wallet user.
`issuingPartnerUri`	Required String The unique identifier of the WLW partner that issued the mobile payments app for which the wallet is registered.
`partnerUri`	Required String The unique identifier of the WLW partner under which the issuer is registered.
`createDate`	Required dateTime A UNIX timestamp value representing the date on which the mobile wallet was registered.
`deviceType`	Required Enum Indicates the type of device. Valid responses are: `iPhone` - Phones made by Apple `Android` - Phones made by Google.

DeviceTypesInfo

Details that describe the device.

Attribute	Description
`deviceTypeUri`	Required String Unique identifier for a specific device.
`displayName`	Required String Name for the device to display when listing the device.
`uniqueName`	Required String Name for the device that is distinct from other devices that may be listed for this customer.

DoubleDeposit

Defines 2 values used to verify ownership of deposit accounts.

Attribute	Description
`firstAmount`	Required Double Value for the first amount being deposited for verification.
`secondAmount`	Required Double Value for the second amount being deposited for verification.

Error

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.

EventAttributes

Payload details about the event.

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

LineItem

The information that uniquely identifies a a specific product that is included in a purchase or refund transaction.

Attribute	Description
`categoryCode`	Required String Unique identifier provided by the POS represents the group of products to which the line item belongs. 100 char
`categoryDisplayName`	Required String he name of the product group as it appears on the receipt, for example `GRCY` might represent products in the grocery category. 100 char
`categoryName`	Required String The descriptive name of the product group, such as grocery or clothing. 100 char
`description`	Required String The POS-generated description of the product represented in the line item, for example, red seedless grapes.
`itemCount`	Required String The number of instances of this item represented in the line item total. 10 char
`otherTransactionTypeDescription`	Required String In the event that a `transactionSubType` of `OTHER` is specified, this attribute provides a means to include additional information that may be relevant to the nature of the transaction, for example, donation or pre-order deposit.
`unitPrice`	Required Double The purchase price associated with each individual instance of the line item. 100 char
`amount`	Required Double The total cost of all instances of the product represented in the line item. 100 char

LoyaltyAccuralActivity

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

Attribute	Description
`accrualActivityUri`	Required String Uniquely identifies an activity, as defined by the merchant, that qualifies the loyalty subscriber to earn points toward a reward program, such as a minimum purchase. 100 char
`customerUri`	Required String The unique identifier of a mobile wallet user in the WLW platform. 100 char
`loyaltyAccrualActivityType`	Required Enum An enum value that identifies the category of action that was completed to earn loyalty points. Valid values are: `EXTERNAL_ACTIVITY` - Activity conducted outside of the mobile wallet, such as a social networking share. `ENROLLMENT` - Initial subscription to the loyalty program. `PURCHASE` - A qualified purchase. `REFUND` - A refund of a purchase for which points were awarded. This type results in subtraction of points. `VOID_PURCHASE` - A reversal of a completed, but not settled, purchase. This type results in subtraction of points. `VOID_REFUND` - A reversal of a completed, but not settled, refund. If the refund subtracted previously awarded points, those points would be re-added.
`loyaltyProgramUri`	Required String Uniquely identifies the loyalty program for which the activity is applicable. 100 char
`paydiantReferenceId`	Required String WLW’s unique identifier for the transaction. 10 char
`points`	Required Integer The number of points involved in the loyalty activity instance. 100 char
`refundPaydiantRefId`	Optional String WLW’s unique identifier for a refund transaction. 100 char
`transactionAmount`	Required Double The dollar amount of the transaction that is associated with the loyalty activity.
`transactionTime`	Optional Date The timestamp issued at the time the transaction completed.
`transactionWeight`	Required Integer A multiplier used to calculate the value of the loyalty activity and the corresponding points. For example, if a loyalty program awards 2 points for every dollar spent, this value would equal 2. 100 char

LoyaltyAccrualActivityResult

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

Defines the result of an external loyalty program's activity.

Attribute	Description
`loyaltyProgramUri`	Required String Uniquely identifies the loyalty program for which the activity is applicable. 100 char
`pointsPostStatus`	Required Enum The current state of a point addition or subtraction. Valid values are: `POSTED` `PENDING` `FAILED` `CANCELLED`
`pointsEarned`	Required Integer The number of loyalty points added or subtracted based on the completion of the transaction. 100 char
`pointsBalance`	Required Integer The total number of points accrued at the time of the transaction. 100 char
`rewardBalance`	Required Double The value of the awards you have earned. For example, if you earn $5 for every 1000 points and you have 2500 points, this value equals 10.00.
`pointsToRewardBalance`	Required Integer The number of points still needed to meet the minimum amount required to redeem a reward. For example, if the minimum reward is 200 points, and the current balance is 75, this value is 25. 100 char
`loyaltyAccrualActivityType`	Required Enum An enum value that identifies the category of action that was completed to earn loyalty points. Valid values are: `EXTERNAL_ACTIVITY` - Activity conducted outside of the mobile wallet, such as a social networking share. `ENROLLMENT` - Initial subscription to the loyalty program. `PURCHASE` - A qualified purchase. `REFUND` - A refund of a purchase for which points were awarded. This type results in subtraction of points. `VOID_PURCHASE` - A reversal of a completed, but not settled, purchase. This type results in subtraction of points. `VOID_REFUND` - A reversal of a completed, but not settled, refund. If the refund subtracted previously awarded points, those points would be re-added.
`paydiantReferenceId`	Required String WLW’s unique identifier for the transaction. 10 char.
`refundPaydiantRefId`	Optional String WLW’s unique identifier for a refund transaction. 100 char.
`transactionTime`	Optional Date The timestamp issued at the time the transaction completed.
`transactionWeight`	Required Integer A multiplier used to calculate the value of the loyalty activity and the corresponding points. For example, if a loyalty program awards 2 points for every dollar spent, this value would equal 2. 100 char.

LoyaltyExternalActivity

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

Parameters of a loyalty activity program not managed in the WLW Platform.

Attribute	Description
`externalActivityWeight`	Required Integer Multiplier used to calculate the value of the loyalty activity sent from the external activity program and the corresponding points. For example, if the external loyalty program awards 2 points for every dollar spent, this value would equal 2.
`externalActivityType`	Required Enum Indicates the kind of external loyalty scheme used. Valid values are: `GAME_LEVEL_REACHED` `SOCIAL_NETWORKING` `ONDEMAND_AWARD`
`externalRefId`	Required Integer Unique identifier for the external loyalty program.
`externalRefId`	Required DateTime Date on which the external loyalty activity posted. In UNIX timestamp format.

MessageHeader

Additional details about the call. These fields are for information only and are not evaluated.

Attribute	Description
`partnerId`	Required String The parent code generated by WLW that identifies the wallet issuer from which the API call originated.
`messageId`	Required String The code generated by the calling entity that identifies an API request.
`versionId`	Required String Identifies the version of the Customer Care API through which the call was made.
`environmentId`	Required String Identifies the WLW platform on which the calling service is running, for example, `Test`, `Production`, or `Staging`.

PaymentInfo

Details about the payment transaction.

Attribute	Description
`paydiantReferenceId`	Required String The unique identifier of the transaction within the WLW service.
`currencyCode`	Required String The `CurrencyCode` that identifies the monetary unit used for the transaction, as recognized by the ISO 4217 standard, for example, `USD` = United States Dollar
`paymentStatus`	Required `PaymentStatus` Describes the current status of the payment transaction.
`paidOrRefundAmount`	Required Double Amount of the payment that has been paid or refunded.
`paidOrRefundTime`	Required String `UNIX Timestamp` of when the payment was paid or refunded. 12 char
`paymentAccountNetworkUri`	Required String WLW’s identification of the tender associated with an originating payment authorization. This value is applicable for any transaction that represents a modification or continuation of a previously completed transaction or payment event, such as a void, refund, or split tender payment. 12 char
`paymentAccountTypeUri`	Required String The unique identifier for the payment account type. 120 char
`cardUri`	Required String The unique identifier for this card.
`maskedCardNumber`	Required String The last four digits of the card used as an identifier.
`merchantUri`	Required String The unique identifier for this merchant.
`paymentAccountNetworkName`	Required String The official name of the payment network that this card runs on, for example, `VISA`.
`paymentAccountNickName`	Required String The familiar name for this card, for example, `BOAVisa`
`paymentAccountTypeName`	Required String The kind of payment account this card represents, for example `CREDIT`.
`paymentRefId`	Required String The reference number used to identify this payment.

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.

QueryRequest

Criteria you can use to query a transaction. Adds the following query parameters to a B2bRequest.

Attribute	Description
`startDate`	Optional dateTime First date of the group of transactions you want to retrieve using UNIX timestamp.
`endDate`	Optional dateTime Last date of the group of transactions you want to retrieve in UNIX timestamp.
`maxNumberOfRows`	Optional String The total number of rows that can be added to this group of transactions. Do not set the `MaxNumberOfRows` greater than the maximum number of rows configured by WLW which is currently 50 rows. If this value is not set, it defaults to the maximum number of rows allowed by WLW which is currently 50 rows.
`startIndex`	Optional String The record number of the first transaction in the collection. Used for pagination. Defaults to the first row if not provided.

QuestionAnswer

The question that will be posed.

Attribute	Description
`question`	Required String The question selected by the user to verify the user.
`answer`	Required String The response required to verify the user.

QuestionDetail

The question that will be posed.

Attribute	Description
`question`	Required String The identifier for this question.
`mandatory`	Required Boolean Indicates if this question is required. Valid values are: `TRUE` - This question must be answered to verify the applicationID. `FALSE` - This question is not required.
`newQuestion`	Required Boolean Indicates if this is question a new one that has not been stored previously. Valid values are: `TRUE` - This is a new question. `FALSE` - This is an existing question.

Receipt

Defines the metadata properties that the POS must provide to the WLW platform in order to generate a digital receipt for a mobile transaction.

Attribute	Description
`cashierId`	Required String Any merchant-assigned unique identifier of the employee who rang in the sale on the POS.
`merchantRefundReceiptId`	Required String The ID number generated by the merchant that identifies a refund receipt.
`merchantTransactionRefId`	Required String A unique transaction identifier generated by the POS for a merchant’s own tracking purposes. 36 char.
`paydiantTransactionRefId`	Required String A unique transaction identifier generated by the WLW service. 36 char
`receiptId`	Required String A unique identifier assigned by the WLW host to associate receipt data with a specific transaction. 100 char
`secondaryIdentifier`	Required String A randomly generated access code submitted by the mobile wallet user in conjunction with payment selection for the purpose of confirming a pre-authorization charge.
`terminalId`	Required String Unique identifier of the specific POS terminal within a particular acceptance location. 8 char.
`externalReceiptUrl`	Required String A URL where an external version of the receipt exists.
`savings`	Optional Double The dollar amount by which the purchase total was reduced due to discounts, coupons, or other promotional reductions. 100 char.
`subTotal`	Required Double The amount of the purchase after discounts or tip adjustments have been applied, but before applicable tax has been added. 100 char.
`tax`	Required Double The dollar amount added to the amount due based on required sales or meals tax calculations. 100 char.
`tipAmount`	Required Double The dollar amount added to the amount due based on the wallet user’s allocation of a gratuity. 100 char.
`totalAmount`	Required Double The total amount due for the transaction at the time of submission, after all adjustments have been applied. 100 char.
`offerDiscount`	Required Double The amount by which the cost of an item is reduced when the associated offer is redeemed. This value represents a dollar amount. 100 char.
`tax`	Required Double The dollar amount added to the amount due based on required sales or meals tax calculations. 100 char.
`tipAmount`	Required Double The dollar amount added to the amount due based on the wallet user’s allocation of a gratuity. 100 char.
`totalAmount`	Required Double The total amount due for the transaction at the time of submission, after all adjustments have been applied. 100 char.
`offerDiscount`	Required Double The amount by which the cost of an item is reduced when the associated offer is redeemed. This value represents a dollar amount. 100 char.
`createDate`	Required dateTime Date the receipt was created.
`items`	Optional Array The set of `LineItem` objects that details each item included in the total purchase.
`surcharge`	Optional Double Dollar amount charged as a transaction fee, typically to cash withdrawals.

SKUItems

Used to add the numbers of the SKU for items that are part of a reward offer for a campaign.

Attribute	Description
`itemCode`	Required String Code to identify the item.

Status

Attribute	Description
`statusCode`	Required Enum Identifies the current state of an API call. Valid values are: `SUCCESS` `PARTIAL_SUCCESS` `PENDING_COMPLETION` `FAILED` `INVALID_DATA` `FATAL_ERROR` `TIMEOUT` `INVALID_OPERATION` `REQUIRED_DATA_MISSING` `NOT_FOUND` `ALREADY_EXISTS` `INVALID_ARGUMENTS`
`statusDescription`	Required String A plain text message that further describes the nature of the status code to which it is associated.
`error`	Required `Error` Defines an error that occurred during processing of the call.

StoreInfo

Details that identify the store.

Attribute	Description
`merchantName`	Optional String Name of the umbrella merchant for this store.
`name`	Required String Name of the store.
`code`	Required String Store code assigned by issuer.
`acceptancePartnerUri`	Optional String Unique identifier for the acceptance partner for this store location.
`acceptanceLocationUri`	Optional String Unique identifier for the physical location of this acceptance partner.
`address1`	Optional String The number and street of the physical address of the store location.
`address2`	Optional String Any secondary information about the position of the business within the street address, such as a suite number.
`city`	Optional String The name of the city in which the store exists.
`state`	Optional String A namespace value that identifies the US state in the postal address of an entity.
`zip`	Optional String A namespace value that identifies the postal zip code associated with an entity’s mailing or physical address.
`country`	Optional String A value from the `CountryCode` enum that identifies the country of the acceptance location’s physical address.
`phone`	Optional String A namespace value that specifies the phone contact number for the acceptance location.
`transactionDate`	Required dateTime The `UNIX Timestamp` date on which the transaction took place.

TenderType

Details about the kinds of tenders used.

Attribute	Description
`paymentAccountTypeName`	Optional String The name used to identify this tender type/payment account; for example `Credit Card`
`paymentAccountTypeUri`	Required String The unique identifier that for this tender type/payment account.
`paymentNetworkTypeName`	Optional String The name that identifies the type of Network this tender operates on.
`paymentNetworkTypeUri`	Required String The unique identifier that identifies the payment network this tender type operates on.
`networkTypeLabel`	Required String A text label used to identify the type of network.
`imagePath`	Required String The unique identifier that identifies the payment network this tender type operates on.
`messageKey`	Required String The unique identifier that identifies the payment network this tender type operates on.
`validateIIN`	Required Boolen Indicates if the Issuer Identification Number (IIN) must be validated for this tender type. Valid values are: `TRUE` - The IIN number must be validated. `FALSE` - The IIN does not need to be validated for this tender type.
`iinLength`	Optional String Indicates the number of characters permitted for the IIN for this tender type.
`requireVerification`	Required Boolean Specifies whether the property value requires revalidation upon any change to the payment account. Valid values are: `TRUE` - The account must be re-validated if any change is made to the account `FALSE` - Changes to this account do not require revalidation
`supportsProvisioning`	Required Boolean Specifies whether the tender type is permitted to generate a new account for the wallet through the card provisioning feature.Valid values are: `TRUE` - New accounts can be created using provisioning. `FALSE` - Provisioning cannot be used to create new accounts.
`metaData`	Optional `TenderTypeMetaData` Additional details or requirements of this payment type.

TenderTypeMetaData

Additional details or requirements about this payment type.

Attribute	Description
`key`	Required String Details about this metadata attribute. Allows metadata attribute and the values set here to be recognized by the SDK.
`dataType`	Required String The type of data for this key, such as `STRING`, `INTEGER`, `BOOLEAN`.
`name`	Optional String A plain language name used to refer to this metadata value such as `Masked Card Number`.
`defaultValue`	Optional String The setting for this value that will be used if no other value is entered.
`maxLength`	Optional Integer The maximum field length for this value, for example if the metadata is zip code, the max length could be 5 while for a mobile phone the max length could be 10. Note: This attribute is validated before the request is processed and will throw an error if the specified criteria is not met.
`minLength`	Optional Integer The minimum field length for this value as appropriate for the payment type and property as well as whether the property is required. For example, the card number of an AMEX card is 24 digits while the card number for a Visa card is 16, but if this property is not required, the minimum value would likely be 0. Note: This attribute is validated before the request is processed and will throw an error if the specified criteria is not met.
`order`	Optional Integer Specifies the numerical sequence of the attribute so the UI controls can follow a logical progression.
`pciEncryptionRequired`	Required Boolean Indicates if the value must be encrypted in compliance with PCI sensistive data policies.
`storageRestricted`	Required Boolean Indicates if the value cannot be cached or stored in the app’s private data directory.
`required`	Required Boolean Indicates if this value is required for this payment type. When set to `true`, a null value throws an error.
`updatesAllowed`	Required Boolean Indicates if the user can change the value for this property during an update action. For example, when updating a payment account, the user can change the nickname but cannot change the card number.
`reverificationRequired`	Required Boolean Indicates if the value requires reverification upon any change to the payment account.
`maskingRequired`	Required Boolean Indicates if the payment account number must be hidden from view. When set to `true`, the card number is obscured up to the last 4 digits. For example `XXXXXXXXXXXX4215`.
`ignoreForProvisioning`	Required Boolean Indicates if this metadata value should be disregarded when a new card account is generated for the wallet.
`dataGroup`	Optional String Identifies the category of information of the metadata. For example, `CARD_INFORMATION`, `ISSUER_INFORMATION`, `BILLING_INFORMATION`, etc.
`additionalDataValuation`	Required `additionalDataValidation` An array of rules used to validate the metadata prior submission to the WLW service. For example, the rules can define if the value must be an exact character length or a future date. Each validation rule is defined by an individual dictionary object.

TransactionProcessingEvent

Details of the event.

Attribute	Description
`eventReferenceId`	Required String Unique id of the processing event used for this trigger.
`eventType`	Required String The type of event used for this trigger.
`transactionReferenceId`	Required String Unique identifier of the transaction triggering the event.
`eventAttributes`	Optional `EventAttributes` KeyValues needed for the notification payload.
`additionalHeaderValues`	Optional `AdditionalheaderValues` KeyValue used to transfer and additional metadata needed for the notification.

Enums and String Values

CountryCode

Code	Country
`US`	United States
`CA`	Canada
`AU`	Australia
`AT`	Austria
`BE`	Belgium
`BR`	Brazil
`CZ`	Czech Republic
`DK`	Denmark
`FI`	Finland
`FR`	France
`DE`	Germany
`GR`	Greece
`IE`	Ireland
`IT`	Italy
`LU`	Luxembourg
`NL`	Netherlands
`NZ`	New Zealand
`NO`	Norway
`PL`	Poland
`PT`	Portugal
`SI`	Slovenia
`ES`	Spain
`SE`	Sweden
`CH`	Switzerland
`ZA`	South Africa
`TR`	Turkey
`GB`	Great Britain

CurrencyCode

Important: Effective 1 April, 2021, PayPal will no longer offer domestic payment services in India. As a result of this, PayPal Payments Private Limited users cannot use Indian rupees (INR) to receive payments. This change, however, has no impact on PayPal’s international services. Users in India can continue to send and receive international payments in US dollars (USD).

Code	Currency
`USD`	United States dollar
`CAD`	Canadian dollar
`EUR`	Euro
`AUD`	Australian dollar
`BRL`	Brazilian Real
`CZK`	Check Koruna
`DKK`	Danish Krone
`NZD`	New Zealand Dollar
`NOK`	Norwegian Kroner
`PLN`	Polish Zloty
`ZAR`	South Afrian Rand
`SEK`	Swedish Krona
`CHF`	Swiss Franc
`TRY`	Turkish New Lira

TransactionStatus

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

Value	Description
`BLOCKED`	The transaction was prevented from completing because it was waiting for some other process to complete.
`CANCELED`	The transaction was stopped.
`COMPLETE`	Transaction is finished processing.
`FAILED`	Transaction did not complete.
`FULL_REVERSAL`	The transaction was reversed.
`INPROGRESS`	Transaction is still processing.
`TIMEDOUT`	Transaction timed out.
`VOID`	Transaction was voided.

B2B Customer Care - Data Objects

Enums

Data Objects

AccountBalance

AdditionalCustomerInformation

AdditionalData

AdditionalDataValidation

AdditionalHeaderValues

AuditInfo

B2bRequest

B2bResponse

Card

CardDetails

ConfigurationDetails

CustomerCardInfo

CustomerDevice

CustomerEmailInfo

CustomerLookupInfo

CustomerOfferInfo

CustomerTransactionInfo

Device

DeviceTypesInfo

DoubleDeposit

Error

EventAttributes

LineItem

LoyaltyAccuralActivity

LoyaltyAccrualActivityResult

LoyaltyExternalActivity

MessageHeader

PaymentInfo

PaymentResponse

PaymentStatus

QueryRequest

QuestionAnswer

QuestionDetail

Receipt

SKUItems

Status

StoreInfo

TenderType

TenderTypeMetaData

TransactionProcessingEvent

Enums and String Values

CountryCode

CurrencyCode

TransactionStatus

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more