iOS SDK - Receipt Objects

Receipt Domain Objects

PDAcceptanceLocationSummary

Identifies the physical location that accepted the transaction represented by the receipt.

Property Description
acceptancePartnerSummary PDAcceptancePartnerSummary
Identifies the hierarchy of the merchant’s registration with Paydiant.
acceptanceLocationName String
The name of the store location relevant to the receipt summary.
acceptanceLocationUri String
Paydiant’s unique identifier for the store location.
addressLine1 String
The first line of the physical location of the store.
addressLine2 String
The second line of the physical store location.
city String
The city in which the store is located.
country String
The country in which the store is located.
state String
The U.S. state in which the store is located.
zipCode String
The U.S. postal code for the store location.
storeCode String
The unique identifier for the specific retail location.

PDAcceptancePartnerSummary

Identifies an entity registered to process mobile payment transactions with the Paydiant platform.

Property Description
acceptancePartnerUri String
The unique identifier of a merchant registered to accept Paydiant-powered mobile payments.
acceptancePartnerName String
The name of the merchant as it will appear on the receipt.
partnerUri String
The unique identifier of the Paydiant partner under which the merchant is registered.
acceptancePartnerLogoUrl String
The URL path through which the merchant’s logo image is served for use on digital receipts.

PDLineItem

Identifies an individual purchase included in a transaction.

Property Description
createdDate NSDate
Time at which the line item was added to the receipt.
categoryCode String
The unique identifier of the category to which the line item belongs.
categoryDisplayName String
The plain language name of the category to which the line item belongs. For example, Women’s Gloves.
categoryName String
The unique descriptive name of the category to which the line item belongs. For example, apparel_women_outerwear_gloves.
unitPrice String
The unit price of the line item. For example, a bunch of grapes may be $1.99 per pound.
totalAmount String
The total amount charged for the line item. For example, three pounds of grapes has a total cost of $5.97.
itemCount 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, 3 is the value for this property.
description String
The description of the item purchased. For example, red seedless grapes.
itemCode String
The unique identifier for the item, such as its SKU or UPC.
itemDiscountAmount NSNumber
The dollar amount by which the item’s purchase price is reduced in this transaction.
itemTaxAmount NSNumber
The dollar amount of the applied tax for the item.
unitType String
The unit of measure used for the item, such as gallon, each, or package, as defined by the acceptance partner.

PDPaymentResultSummary

An abbreviated snapshot of the outcome of a particular payment authorization request for inclusion on the receipt summary. A single transaction can have multiple instances due to, for example, split tender or declines.

Property Description
currencyCode String
The code that identifies the monetary unit used for the transaction, as recognized by the ISO 4217 standard, for example, USD = United States Dollar.
paidOrRefundAmount NSNumber
The dollar amount paid or refunded in this instance, which may be a partial payment in a split tender transaction.
paymentStatus String
The result of this payment authorization instance, such as Approved or Declined.

PDReceipt

Defines all data relevant to a completed transaction.

Property Description
amount String
The total amount due for the transaction.
subTotalAmount NSNumber
The calculated total of the purchase, prior to any discounts, tax, or other modifications to the amount due.
paidAmount String
The amount that was authorized for payment by the mobile wallet payment account(s) for this receipt.
cashierId String
The identifier of the employee who was logged into the POS when the transaction was processed.
terminalId String
The unique identifier of the POS terminal on which the transaction was processed.
createdDate NSDate
Time at which the receipt was generated.
loyaltyReceipts PDLoyaltyReceipt
Defines the loyalty activity relevant to this transaction.
totalAmountPoints NSNumber
The total number of loyalty reward points earned for the transaction.
merchantTransactionId String
The unique identifier for the transaction, as provided by the POS.
paydiantReferenceId String
The unique identifier for the transaction, as supplied by Paydiant’s managed service.
receiptId String
The unique identifier of the receipt object.
originalReceiptId String
If the transaction is a refund, the unique identifier of the originating purchase transaction.
savingsDiscount String
The dollar amount by which the total was reduced due to the application of a discount.
tax String
The total amount of sales tax collected for the purchase.
merchantUri String
The unique identifier of the retailer that conducted the transaction.
lineItems PDLineItem
The array of objects that define each item included in the receipt.
tipAmount String
The dollar amount added to the total due based on the user’s input of a tip.
includedGratuity NSNumber
The dollar amount added to the total due as an automatically applied gratuity (such as with large dining parties).
surcharge NSNumber
The dollar amount added to a cash access transaction as an ATM fee.
storeLocation PDStoreLocation
Defines the location at which the transaction was conducted.
fuelReceiptProperties PDFuelReceiptProperties
Details data values that are specific to fuel related transactions, such as the amount of fuel dispensed.
receiptType PDReceiptType
The type of transaction for which the receipt was generated.
transactionSubType PDTransactionSubType Enum
Further distinguishes a transaction within its primary type.
transactionSubTypeDescriptions String
Captures any optional plain text explanation that further describes the transaction, such as a Refund or Exchange may contain an additional note explaining that the exchange item cost less than the returned item, resulting in a credit.
paymentResults Array
The set of one or more PDTransactionAccount objects that were used for this transaction. Payments may include partial payments from different payment accounts, for example, gift plus credit or a declined payment, followed by a successful payment.
offersArray PDOffer
The array of objects defining the offers redeemed for this transaction.
accountsArray PDTransactionAccount
The array of objects defining the payment accounts used to complete the transaction.
externalReceiptUrl String
A URL that can optionally be included on the e-receipt generated for the mobile app, giving wallet users the ability to view the receipt in a secure online portal.
receiptText String
Any additional content that the merchant would like included on the e-receipt generated for the mobile app, such as the return policy or other legal disclaimer.

PDReceiptCollection

A set of receipt instances grouped by some shared characteristic.

Property Description
totalRecordsCount Integer
The total number of receipts included in a collection.
receiptsArray Array
The set of receipts, identified by receiptId, included in the collection.
startIndex Integer
The receipt record number of the first receipt in the collection.
endIndex Integer
The receipt record number of the last receipt in the collection.
receiptStartDate NSDate
The earliest receipt generation date of receipts included in the collection.
receiptEndDate NSDate
The latest receipt generation date of receipts included in the collection.

PDReceiptSummary

Briefly identifies a receipt instance with data that would appear in a list view in the wallet.

Property Description
acceptanceLocationSummary PDAcceptanceLocationSummary
Defines a brief identification of the physical store location through which the transaction was processed.
receiptType PDReceiptSummaryType
The type of transaction for which the receipt was generated.
externalReceiptUrl String
A URL that can optionally be included on the e-receipt generated for the mobile app, giving wallet users the ability to view the receipt in a secure online portal.
merchantTransactionReferenceId String
The unique identifier for the transaction, as provided by the POS.
paydiantTransactionReferenceId String
The unique identifier for the transaction, as supplied by Paydiant’s managed service.
createdDate NSDate
The time at which the receipt was generated.
receiptId String
The unique identifier of the receipt object.
subTotalAmount NSNumber
The amount of the purchase prior to the application of tax and tip adjustments.
taxAmount NSNumber
The total amount of sales tax collected for the purchase.
tip NSNumber
The dollar amount of the user-applied tip.
includedGratuity NSNumber
The dollar amount automatically applied as a gratuity, such as with large dining parties.
surcharge NSNumber
The dollar amount applied as a withdrawal ATM fee.
totalPoints NSNumber
The number of reward points earned for the transaction.
total NSNumber
The amount that was authorized for payment by the mobile wallet payment account(s) for this receipt.
paymentResultSummary Array
The set of PDPaymentResultSummary instances of summarized outcome of each payment authorization request for the transaction.
transactionSubType PDTransactionSummarySubType Enum
Further distinguishes the transaction within the primary type.

PDRefund

Captures the details of a completed refund transaction.

Property Description
receiptId String
The unique identifier of the receipt object.
merchantId String
The unique identifier of the merchant that processed the refund transaction.
checkoutToken String
The checkout token that was generated for the refund transaction.
refundAmount String
The total dollar amount credited back to the payment account.
walletAccountId String
The unique identifier of the Paydiant mobile wallet.
currencyCode String
The code that identifies the monetary unit used for the transaction, as recognized by the ISO 4217 standard, for example, USD = United States Dollar.
refundedDate NSDate
The time and date that the refund transaction completed.
offersArray Array
The set of PDOffer objects for offers that were applied to the original purchase and are applicable to the refund transaction.

PDTransactionAccount

Identifies a payment account relative to its use as tender in a mobile transaction. Some receipt instances (such as split tender) may reference multiple instances of this object in the accountsArray property.

Property Description
paydiantReferenceId String
The unique identifier of the transaction.
paidOrRefundAmount String
The dollar amount that was debited or credited to the account for a particular transaction.
paymentAccountTypeUri String
The unique identifier of the type of payment account associated with the tender type.
paymentAccountNetworkTypeUri String
The unique identifier of the network type associated with this tender.
paymentAccountUri String
The unique identifier of the payment account.
paymentRefId String
The unique identifier of a payment that was conducted using the account. This is not the transaction identifier, as a transaction can have more than one associated payment.
paidOrRefundedDate NSDate
The time and date that the payment or refund network authorization completed.
paymentStatusDescription String
The plain language message describing the current status of the payment or refund.
paymentStatusCode String
Paydiant’s code identifier indicating the result of the payment authorization request. The code populated here depends on the attribute for which the TransactionAccount instance is relevant. For example, if the object is populating the currentPaymentResult attribute of PDTransactionDetail, the value here will be the appropriate HTTP code for success or failure.
However, in the event that this instance populating the previousPaymentResult attribute for an ultimately successful transaction that included previous payment attempts that failed, this value may be the status code representing the failure.
paymentInstrument PDPaymentInstrument
Defines the payment account to which this object refers.
currencyCode String
The code that identifies the monetary unit used for the transaction, as recognized by the ISO 4217 standard, for example, USD = United States Dollar.
externalStatusCode String
Status of the payment or refund as communicated by the processor.
externalStatusDescription String
The plain language message that defines the externalStatusCode.

Receipt Message Objects

PDRetrieveReceiptSummaryRequest

Retrieves the receipt for the split tender transaction identified.

Property Description
filterType PDReceiptSummaryFilterType Enum
The criteria by which the set of split tender receipts will be limited
startIndex Integer
The returned set of receipt objects should begin with this object number.
noOfRecords Integer
The returned set of receipts should display this number of receipts per page at a maximum.
startDate NSDate
The earliest receipt generation date of receipts to be returned.
endDate NSDate
The latest receipt generation date of receipts to be returned.
acceptancePartnerPartnerUri String
If relevant based on filterType, this value identifies the merchant parent partner.
acceptancePartnerUri String
If relevant based on filterType, this value identifies the merchant by which to filter the returned receipts.

PDRetrieveReceiptSummaryResponse

Returns the result of the request from the server.

Property Description
receiptSummariesList Array
The set of PDReceiptSummary objects that is returned based on the filtering criteria specified in the request.
startIndex Integer
The returned set of receipt summary objects begins with this object number.
endIndex Integer
The returned set of receipt summaries ends with this object number.
maxNumberOfRows Integer
The returned set of receipt summaries includes this many returned objects.
startDate NSDate
The earliest receipt generation date of receipt summaries returned.
endDate NSDate
The latest receipt generation date of receipt summaries returned.

PDRetrieveReceiptDetailRequest

Specifies the transaction for which receipt detail is requested.

Property Description
paydiantReferenceId String
Identifies the transaction for which the receipt detail is being requested.

PDRetrieveReceiptDetailResponse

Returns the object that defines the requested receipt.

Property Description
receipt PDReceipt
The receipt object generated for the transaction identified in the request.

PDRetrieveReceiptWithSplitTenderPaymentsRequest

Retrieves the receipt for the split tender transaction identified.

Property Description
paydiantReferenceId String
Identifies the split tender transaction for which the receipt is being requested.

PDRetrieveReceiptWithSplitTenderPaymentResponse

Returns the result of the request from the server.

Property Description
receipt PDReceipt
The receipt object defined by the referenceID provided in the request.

PDRetrieveReceiptsWithSplitTenderPaymentsRequest

Retrieves all split tender receipts meeting the specified criteria.

Property Description
filterType PDReceiptFilterType Enum
The criteria by used to limit the split tender receipts.
startIndex Integer
The returned set of receipt objects begins with this object number.
noOfRecords Integer
The returned set of receipts displays this number of receipts per page at a maximum.
receiptStartDate NSDate
The earliest receipt generation date of receipts to be returned.
receiptEndDate NSDate
The latest receipt generation date of receipts to be returned.
acceptancePartnerPartnerUri String
The merchant parent partner for the acceptance partner specified by filterType.
acceptancePartnerUri String
Unique identifier for the merchant acceptance partner identified by filtertype used to filter the returned receipts.

PDRetrieveReceiptsWithSplitTenderPaymentsResponse

Returns the result of the request from the server.

Property Description
receipts Array
The set of PDReceipt objects returned based on the filtering criteria specified in the request.
startIndex Integer
The returned set of receipt objects begins with this object number.
endIndex Integer
The returned set of receipts ends with this object number.
noOfRecords Integer
The returned set of receipts includes this many returned objects.
receiptStartDate NSDate
The earliest receipt generation date of receipts returned.
receiptEndDate NSDate
The latest receipt generation date of receipts returned.

PDRefundableReceiptsWithSplitTenderPaymentsRequest

Retrieves the set of PDReceipt objects that include split payments and are refundable.

Property Description
startIndex Integer
The returned set of receipt objects begin with this object number.
noOfRecords Integer
The returned set of receipts display this number of receipts per page at a maximum.
receiptStartDate NSDate
The earliest receipt generation date of receipts to be returned.
receiptEndDate NSDate
The latest receipt generation date of receipts to be returned.
acceptancePartnerPartnerUri String<brUnique identifier for the merchant partner identified by filtertype used to filter the returned receipts.
acceptancePartnerUri String
If the filterType specifies the acceptance partner, this value identifies the merchant to use when filtering the returned receipts.
storeLocationUri String
This value identifies the particular location of the merchant, which determines whether the receipt is refundable for the current location.

PDRefundableReceiptsWithSplitTenderPaymentsResponse

Returns the result of the split tender receipt request from the server.

Property Description
receipts Array
The set of PDReceipt objects returned based on the filtering criteria specified in the request.
startIndex Integer
The returned set of receipt objects begins with this object number.
endIndex Integer
The returned set of receipts ends with this object number.
noOfRecords Integer
The returned set of receipts includes this many returned objects.
receiptStartDate NSDate
The earliest receipt generation date of returned receipts.
receiptEndDate NSDate
The latest receipt generation date of returned receipts.

Receipt Enums

PDReceiptFilterType

Enum
kReceiptFilterNotSet (default)
kReceiptsByUser
kReceiptsByUserAndDateRange
kReceiptsByAcceptancePartnerPartnerAndUser
kReceiptsByAcceptancePartnerPartnerAndUserAndDateRange

PDReceiptType

Enum
kPDReceiptTypeUnknown (default)
kPDReceiptTypePurchase
kPDReceiptTypeRefund
kPDReceiptTypeCashWithdrawal
kPDReceiptTypeCashDeposit
kPDreceiptTypeFuel

PDTransactionSubtype

Enum
kPDTransactionSubTypeUnknown (default)
kPDTransactionSubTypeCashBack
kPDTransactionSubTypeCredit
kPDTransactionSubTypeExchange
kPDTransactionSubTypeFuel
kPDTransactionSubTypeNonPairedRefund
kPDTransactionSubTypeNonReferencedRefund
kPDTransactionSubTypeOther
kPDTransactionSubTypePairedRefund
kPDTransactionSubTypePayment
kPDTransactionSubTypePaymentOnAccount
kPDTransactionSubTypeRefund
kPDTransactionSubTypeReturn
kPDTransactionSubTypeReward
kPDTransactionSubTypeSale

PDReceiptSummaryType

Type Enum
1 kPDReceiptSummaryTypePurchase
2 kPDReceiptSummaryTypeRefund
3 kPDReceiptSummaryTypeCashWithdrawal
4 kPDReceiptSummaryTypeCashDeposit
5 kPDReceiptSummaryTypeFuel
0 kPDReceiptSummaryTypeUnknown (default)

PDReceiptSummaryFilterType

Enum
kReceiptSummaryFilterNotSet (default)
kReceiptSummaryByUser
kReceiptSummaryByUserAndDateRange
kReceiptSummaryByAcceptancePartnerPartnerAndUser
kReceiptSummaryByAcceptancePartnerPartnerAndUserAndDateRange

PDTransactionSummarySubType

Number Enum
0 kPDTransactionSummarySubTypeUnknown(default)
1 kPDTransactionSummarySubTypeCashBack
2 kPDTransactionSummarySubTypeCredit
3 kPDTransactionSummarySubTypeExchange
4 kPDTransactionSummarySubTypeFuel
5 kPDTransactionSummarySubTypeNonPairedRefund
6 kPDTransactionSummarySubTypeNonReferenceRefund
7 kPDTransactionSummarySubTypeOther
8 kPDTransactionSummarySubTypePairedRefund
9 kPDTransactionSummarySubTypePayment
10 kPDTransactionSummarySubTypePaymentOnAccount
11 kPDTransactionSummarySubTypeRefund
12 kPDTransactionSummarySubTypeReturn
13 kPDTransactionSummarySubTypeReward
14 kPDTransactionSummarySubTypeSale
Feedback