Point-of-sale icon

Get transaction data from TxStoreReport

PedDevice Object

Name Description
PedDevice PED object representing the terminal.

Method

NameDescription

GetTxStoreReport

Used to retrieve the TxStoreReport object, which contains results from past transactions.

Parameters

Name

Type

Required

Description

tenderReference

String

-x-

Reference for the tender. Specify a tenderReference to return a report for that tender.

maxTransaction

Long

-x-

Number of transaction reports to return.

Callback

NameDescription

TxStoreReportCB

Callback to GetTxStoreReport that provides the reports.

Parameters

Name

Type

Description

reportObj

TxStoreReport

The TxStoreReport object that contains the reports.

pedResult

int

Result denoting whether an error occurred on the PED. A value of 0 means no error occurred.

pspResult

int

Result denoting whether an error occurred on the PSP. A value of 0 means no error occurred.

libResult

int

Result denoting whether an error occurred in the Library. A value of 0 means no error occurred.

errorMessage

String

Error message describing what went wrong.

TxStoreReport Parameters

Name

Type

Description

tenderReference

String

Reference for the tender. Specify a tenderReference to return a report for that tender.

currency

string

The transaction currency

amount

long

The transaction amount in minor units (100 is 1.00 with EUR).

  • For a normal authorization, this contains the authorized amount.
  • For a partial authorization, this contains the authorized amount.
  • For a DCC transaction, this contains the pre-DCC total.

referenceAmount

 

The transaction amount in minor units (100 is 1.00 with EUR). 

  • For a normal authorization, this field is empty.
  • For a partial authorization, this contains the initial amount.
  • For a DCC transaction, this contains the final, post-conversion, total.



timestamp

String

The date and time at which the tender was created.

state

Transaction.TenderState

The state of the transaction.

capturePending

boolean

Is set to true if a pending transaction exists on the PED, to be sent to the Adyen payments platform and captured.

An extended report also contains:

Name

Type

Description

merchantReference

String

The transaction reference provided by the Merchant (reported in the Adyen payments platform).

pspReference

String

Adyen's unique 16-character string associated with the transaction/the request. 

A pspReference and authCode will not be visible if the transaction was performed offline.

maskedPan

String

The PAN, masked so that sensitive information is not visible. The first six and last four digits are the maximum number of digits to be displayed.

posEntryMode

String

POS entry mode (ICC/MSR/MKE/CLESS_CHIP/CLESS_SWIPE).

receiptSets

List

Set used to hold a list of receipt information.

Some helper methods are provided in the reportObj:

Helper methods and parameters

Name

Input Parameters

Type

Description

Returned ParametersType

GetRequestedTenderReference

 

 

Returns the specified tender reference.

tenderReference

String

GetRequestedMaxTransaction

 

 

Number of transaction reports to return.

maxTransaction

long

GetReportCount

 

 

Returns the number of reports in the TXStoreReport object.

reportCount

long

GetReport

reportId

long

Returns an report object which contains the specified report.

reportObj

TxStoreReport

GetTenderReference

 

 

Returns tender reference for the transaction.

tenderReference

String

GetState

 

 

Returns the state of the transaction.

state

String

GetTimestamp

 

 

Returns the time the transaction was processed.

timestamp

String

GetCapturePending

 

 

Returns transaction where the capture is still pending.

pending

long

GetAmount

currency

Variant

Returns the transaction amount in the specified currency.

value, currency

long

GetMerchantReference

 

 

Returns the merchant reference for the transactions

reference

String

GetPspReference

 

 

Returns the PSP reference for the transactions

A pspReference and authCode will not be visible if the transaction was performed offline.

reference 

String

GetMaskedPan

 

 

The PAN associated with the transaction, masked such that only personnel with a legitimate business need can see the full PAN. 

maskPan

String

GetPosEntryMode

 

 

Returns the entry mode used, ICC, magstripe, NFC, or MKE.

mode

String

GetReceiptCount

 

 

Returns the number of receipts stored in the TxStoreReport

receiptTotal

long

GetReceipt

receiptId

long

Returns up to 25 receipts, or a specific receipt if you specify an ID.

receiptsObj

Receipts