Point-of-sale icon

Get transaction data from TxStoreReport

Class

Name Description
MerchantPed Extends AdyenPed. Class used to implement all PIN entry device (PED) functionality.

Method

NameDescription

txStoreQuery

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

Object

NameDescription

TxStoreQueryRequest

Object used to contain parameters for the request.

Parameters

Name

Type

Required

Description

merchantAccount

String

-white_check_mark-

The merchantAccount used in transactions.

tenderReference

String

-white_check_mark-

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

maxTransaction

int

-x-

Number of transaction reports to return.

Callback

NameDescription

txStoreQueryCallback

Callback to txStoreQuery that provides the reports.

Parameters

Name

Type

Description

result

AdyenResult

The transaction result details

reportSets

List

A list of reports included in the txStore.

Result Parameters

Name

Type

Description

libraryResult

String

Result code generated by the LIBRARY.

pedResult

string

Result code generated by the PED.

pspResult

long

Result code generated by the PSP.

errorMessage

String

Information that clarifies the error code.

A Report contains:

Report 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).

  • 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

long

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

  • 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 report:

Helper methods

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

IDispatch

getTenderReference

 

 

Returns tender reference for the stored transactions.

tenderReference

String

getState

 

 

Returns the state of the transaction.

state

String

getTimestamp

 

 

Returns the time the transaction was processed.

timestamp

String

getCapturePending

 

 

Returns transactions where the capture is still pending.

pending

long

getAmount

CURRENCY

Variant

Returns the transaction amount in the specified currency .

value

long

getMerchantReference

 

 

Returns the merchant reference for the transactions

reference

String

getPspReference

 

 

Returns the PSP reference for the transactions

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 Object