Class
Name | Description |
---|---|
MerchantPed |
Extends AdyenPed . Class used to implement all PIN entry device (PED) functionality. |
Method
Name | Description |
---|---|
|
Used to retrieve the TxStoreReport object, which contains results from past transactions. |
Object
Name | Description |
---|---|
|
Object used to contain parameters for the request. |
Parameters
Name |
Type |
Required |
Description |
---|---|---|---|
|
String | ![]() |
The merchantAccount used in transactions. |
|
String |
Reference for the tender. Specify a |
|
|
int | ![]() |
Number of transaction reports to return. |
Callback
Name | Description |
---|---|
|
Callback to txStoreQuery that provides the reports. |
Parameters
Name |
Type |
Description |
---|---|---|
|
AdyenResult |
The transaction result details |
|
List |
A list of reports included in the txStore. |
Result Parameters
Name |
Type |
Description |
---|---|---|
|
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 |
---|---|---|
|
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).
|
referenceAmount |
long |
The transaction amount in minor units (100 is 1.00).
|
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 |
---|---|---|
|
String |
The transaction reference provided by the Merchant (reported in the Adyen payments platform). |
|
String |
Adyen's 16-digit unique reference associated with the transaction/the request.
A pspReference and authCode will not be visible if the transaction was performed offline.
|
|
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. |
|
String | POS entry mode (ICC/MSR/MKE/CLESS_CHIP/CLESS_SWIPE). |
|
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 Parameters | Type |
---|---|---|---|---|---|
|
Returns the specified tender reference. |
tenderReference |
String |
||
|
|
Number of transaction reports to return. | maxTransaction |
long | |
|
|
Returns the number of reports in the TXStoreReport object. | reportCount |
long |
|
|
reportId |
long | Returns an report object which contains the specified report. | reportObj |
IDispatch |
|
Returns tender reference for the stored transactions. | tenderReference |
String |
||
|
Returns the state of the transaction. | state |
String | ||
getTimestamp |
Returns the time the transaction was processed. | timestamp |
String | ||
|
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 |
|
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 |