B2B Mobile Transaction API - Data Objects

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.

Enums

Data Objects

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.

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 Paydiant 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
Paydiant’s unique system identifier for the acceptance location.
name Required String
Paydiant’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 Paydiant. AcceptancePartner is also referred to as the merchant.

Attribute Description
uri Required String
Paydiant's unique identifier for the acceptance partner.
name Required NCName
Paydiant's plain text name of the acceptance partner.
partnerUri Required String
Paydiant’s unique identifier for a business entity that has been configured to participate in mobile transactions on the Paydiant 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.

AdvertisingNetwork

Defines the details of the offer sponsor, as registered and defined by Paydiant. An Advertising Network (AdNetwork) aggregates advertisement space supply available from publishers and matches it with advertiser demand. In the Paydiant 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 Paydiant. 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 Paydiant 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 denonmination 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
Paydiant’s unique identifier for this device.
customerUri Required String
Paydiant’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
Paydiant’s unique identifier for a business entity that has been configured to participate in mobile transactions on the Paydiant platform.
issuingPartnerUri Required String
Paydiant’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
Paydiant’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
Paydiant’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 Paydiant value that indicates the device is registered to accept offers from the Paydiant platform.
advertizingIdType Optional String
The type of offers for which the device is registered.
pushNotificationId Optional String
A Paydiant value that indicates the device is registered to receive push notifications from the Paydiant 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
Paydiant’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 Paydiant platform entity.

Attribute Description
partnerUri Required String
Paydiant’s unique identifier for a business partner who is configured to participate in mobile transactions on the Paydiant platform.
tenantUri Required String
The unique ID generated in the Paydiant system that identifies an acceptance partner, issuer, or third-party processor for a partner that is configured to participate in mobile transactions on the Paydiant platform.
uri Optional String
The unique identifier of the entity generated by the Paydiant 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.

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 Paydiant system to identify the location engaged in the transaction.
acceptancePartnerUri Optional String
The unique identifier generated by Paydiant to identify the acceptance partner of the fuel site.
partnerUri Optional String
The unqiue identifier generated in the Paydiant 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.

For example, if customers are ranked according to loyalty and afforded benefits such as fee waivers or discounts when they achieve that rank, a Customer_Rank property could be defined to augment the customer profile object where key = customer_rank and value = gold

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

LoyaltyAccrualActivity

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

Attribute Description
accrualActivityUri Required String
Paydiant’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
Paydiant’s unique identifier of the loyalty program for which the activity is eligible.
paydiantReferenceId Required String
Paydiant’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

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

Attribute Description
accrualActivityUri Required String
Paydiant’s unique identifier of the qualified activity.
loyaltyAccrualActivityType Required LoyaltyAccrualActivityTypeEnum
Identifies the loyalty activity category. Valid values are:
EXTERNAL_ACTIVITY
ENROLLMENT
PURCHASE
REFUND
VOID_PURCHASE
VOID_REFUND
loyaltyProgramUri Required String
Paydiant’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 Paydiant B2B Gateway.

Attribute Description
partnerId Required String
A unique value assigned by Paydiant 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
Paydiant’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 Optional LoyaltyAccrualActivity
The 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
Paydiant’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
Paydiant’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 Paydiant or if the entire discount is calculated by the Paydiant 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 Paydiant 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 Discription
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
Paydiant’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 Paydiant 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
Paydiant’s unique identifier for the transaction.
paymentStatus Required String
Paydiant’s text description for the current state of the payment authorization.
paymentStatusCode Required Integer
Paydiant’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
Paydiant’s unique identifier for the type of payment configured on the platform for a specific partner or tenant.
networkTypeUri Optional String
Paydiant’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 Optional LoyaltyReceipt
The set of loyalty activity instances applied to the transaction.
offers Optional OfferThe 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
Paydiant’s unique identifier of the transaction.
receiptId Required String
Paydiant’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
Paydiant’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 Optional Double
The total 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 Paydiant system to identify the acceptance partner of the transaction.
paydiantReferenceId Required String
Paydiant’s unique identifier of the current transaction.
receiptId Required String
The unique identifier generated in the Paydiant 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 GeoCoordinateThe 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

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 Errors
Defines an error that occurred during processing of the call.

Status (v2)

Statement returned from the Cloud Service indicating whether the originating call failed or succeeded.

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
A set of instances that provide a deeper level of information about the status, such as specific errors or external status codes submitted by a third party.

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 Paydiant 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 Paydiant system to identify the parent partner of the acceptance partner.
tenantUri Required String
The unique ID generated in the Paydiant system that identifies an acceptance partner, issuer, or third-party processor for a partner that is configured to participate in mobile transactions on the Paydiant 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, Gift, Loyalty, etc.
accountTypeUri Optional String
Paydiant’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
Paydiant’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. adding lineItemsadding lineItems adding lineItems

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 maxium char.
originalAmountLessTaxes Optional Double
The dollar amount of the transaction before tax was applied. Maxium 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
Paydiant’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 Optional Double
The 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.
totalOfferDiscountAmount Required Double
The dollar amount by which the total is reduced by coupons or other promotions. Maximum 100 char.
transactionPointsAmount Required Double
The number of loyalty points associated with the transaction. Maximum 100 char.
totalPointsDue Required Double
The number of loyalty points owed. Maximum 100 char.
totalPointsPaid Required Double
The number of loyalty points redeemed to pay for the transaction.

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 if the [PaydiantReferenceId] If this call specifies this flow rule (TRUE) the paydiantreferenceid must be populated. If this flow rule is not specified, paydiantreferenceid can be null (FALSE).
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 Paydiant 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 SiteCheckInDetail
Information sent about the location that is applicable when the location is a fuel site.

TransactionMetaData webhook

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.

Enums and String Values

AdvertisingNetworkType

Identifies the Advertising Network’s tenant relationship with Paydiant.

Enum Description
ACCEPTANCE_PARTER The merchant who sponsors the offer to be redeemed.
ISSUING_PARTNER The partner who sponsors the mobile wallet where an offer is proffered.
THIRD_PARTY An entity that is external to the Paydiant platform that can sponsor an offer or wallet, such as a bank or coupon club.

CashAccessType

Valid values for a transaction conducted with an ATM.

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

Identifies the type of transaction the ticket represents.

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

CheckoutTokenType

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

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

DeviceType

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

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

DiscoveryType

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

Enum Type of data the app is requesting
FUEL_CHECK_IN Fuel site data.
REMOTE_ORDER Buy on-line/pick up in-store (BOPUS) data.
PURCHASE In-store purchase data.
REFUND In-store refund data.
EXCHANGE In-store exchange data.
CASH_ACCESS ATM data.
CLOUD_DETERMINED Transaction data as determined by the platform.
PATT Dine-in, pay-at-the-table data.

EligibleOfferType

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

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

ExternalEventType

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

Enum Description
FUEL_PUMP_ACTIVATED The fuel pump is ready to dispense fuel.
FUEL_START The pump has begun dispensing fuel.
FUEL_END The pump has completed dispensing fuel.
FUEL_PUMP_DEACTIVATED The pump is been locked and is not available for fueling.
FUEL_SECONDARY_ID_RECEIVED The pre-authorization confirmation access code has been correctly entered into the pump.
FUEL_CANCELED The fuel transaction has been canceled.
FUEL_RECEIPT_RECEIVED The completed transaction details have been returned to the pump.
FUEL_PRE_AUTH_SUBMITTED The pump has requested a pre-authorization charge from the processor and is awaiting approval before dispersing fuel.

FuelUnitType

The unit of fuel volume specified for the fuel site.

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

LifeCycleEventType

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

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

LoyaltyAccrualActivityType

A qualifying action that affects the loyalty reward balance.

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

MobileTransactionFlowRule

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

Enum Description
OBTAIN_PURCHASE_TOKEN Generate a checkout token for transaction type of PURCHASE in order to initiate a new transaction.
OBTAIN_REFUND_TOKEN Generate a checkout token for transaction type of REFUND in order to initiate a new transaction.
PROCESS_PAYMENT Submit the payment details to the network processor for payment authorization.
PROCESS_SPLIT_PAYMENT Submit the payment details to network processors for payment authorization using multiple payment sources.
RETRIEVE_TRANSACTION_METADATA_DISCOVERY Upon QR Code scan, request relevant merchant data, such as supported tender types.
RETRIEVE_TRANSACTION_METADATA_OTHER Request updated transaction data relevant to the executing flow rule.
RETRIEVE_TRANSACTION_METADATA_SUMMARY Request completed transaction details.
SUBMIT_CASH_ACCESS_TICKET Update transaction with details relevant to an ATM transaction.
SUBMIT_OFFERS Update transaction with user’s selected offers for redemption.
SUBMIT_PAYMENT_TENDERS Update transaction with user’s selected payment instruments.
SUBMIT_OFFERS_AND_PAYMENT_TENDERS Update transaction with user’s selected offers for redemption and payment instruments simultaneously.
SUBMIT_REFUNDABLE_RECEIPT Update transaction with the original receipt related to a refund.
SUBMIT_TENDER_FOR_FUEL Update transaction with selected payment for a fuel pump purchase.
SUBMIT_TENDER_FOR_FUEL_WITH_SECONDARY_ID Update transaction with selected payment for a fuel pump purchase and the generated secondary ID for pre-auth.
SUBMIT_TENDER_FOR_OPENTAB Update transaction with selected payment for dine-in bill.
SUBMIT_TENDER_FOR_PRE_AUTH_PURCHASE Update transaction with selected payment for a pre-auth funds hold.
SUBMIT_MOBILE_TENDER_FOR_PROCESSING Update transaction with user’s selected payment tender and route to the processor for authorization.
SUBMIT_TENDER_FOR_FUEL_WITH_FUEL_TICKET Update transaction with changes to the fuel ticket and the user’s selected payment for the fuel purchase.
SUBMIT_TENDER_FOR_FUEL_WITH_FUEL_TICKET
_AND_SECONDARY_ID
Update transaction with all referenced items in one submission.
SUBMIT_TENDER_FOR_FUEL_WITH_FUEL_TICKET
_AND_OFFERS
Update transaction with all referenced items in one submission.
SUBMIT_TENDER_FOR_FUEL_WITH_FUEL_TICKET
_AND_SECONDARY_ID_AND_OFFERS
Update transaction with all referenced items in one submission.
CANCEL_TRANSACTION Send a request from the mobile to cancel a fuel transaction before any fuel has been dispensed.

OfferArtifactChannelType

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

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

OfferArtifactContentType

The format of the artifact file.

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

OfferArtifactViewType

The part of the offer beind defined.

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

OfferCampaignRedemptionScheduleType

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

Enum Description
DAY_OF_WEEK The redemption schedule uses the days of the week to identify when the offer is valid.
DAY_OF_MONTH The redemption schedule uses the days of the month to identify when the offer is valid.

OfferProcessingPoint

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

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

OfferStatus

The state of an offer relative to its usability.

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

OfferType

The type of compensation promoted by an offer.

Enum Description
VALUE_BASED_OFFER The offer is a dollar or percentage amount discount, such as $5 off or 10% off.

PaymentAccountEnrollmentState

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

Enum Description
START The enrollment was initiated, but no response has been issued yet.
MORE_INFO The enrollment is in progress, pending additional data requested by the processor.
EXPIRED The time allowed to completed the enrollment has expired and it needs to be restarted.
USER_CANCELLED The enrollment was canceled before completion and the payment account is not available as a tender.
END The enrollment was processed to completion, which can mean that it was successfully added as a tender in the wallet, or declined by the processor.

PaymentAccountEnrollmentType

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

Enum Description
LINK Indicates that the value sent in the CARD_NUMBER field is stored and managed (vaulted) in the Paydiant platform.
PROVISION Indicates that the value sent in the CARD_NUMBER field is stored (vaulted) by the authorizing party and a tokenized replacement is stored in Paydiant’s system.

ReceiptType

The type of transaction for which a receipt is generated.

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

RewardType

The type of compensation promoted by an offer.

Enum Description
VALUE_BASED The offer is a dollar or percentage amount discount, such as $5 off or 10% off.
SKU_BASED The offer gives a product reward, such as a free cookie or car wash.

StatusCode

The outcome of a request submitted to the Platform through the B2B Gateway.

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

StatusType

The entity from which a Status instance originates.

Enum Description
PLATFORM The status information originated in the Paydiant platform.
EXTERNAL_PROCESSOR The status information originated in an external system and was passed to the Paydiant platform in relation to the transaction.

TicketType

The type of transaction for which a ticket is generated.

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

TransactionStatus

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

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

TransactionSubType

Further describes the TransactionType.

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

TransactionType

The type of transaction.

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

Next

Feedback