{"title":"Get transaction data from TxStoreReport","category":"default","creationDate":1776961627,"content":"

PedDevice Object<\/h2>\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
PedDevice<\/a><\/td>\nPED object representing the terminal.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Method<\/h2>\n<\/colgroup>
Name<\/th>Description<\/th><\/tr><\/thead>
\n

GetTxStoreReport<\/code><\/p>\n<\/td>

\n

Used to retrieve the TxStoreReport<\/code> object, which contains results from past transactions.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

Parameters<\/h2>\n<\/colgroup>

Name<\/p><\/th>

Type<\/p><\/th>

Required<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

\n

tenderReference<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

\"-x-\"<\/p>\n<\/td>

\n

Reference for the tender. Specify a tenderReference<\/code> to return a report for that tender.<\/p>\n<\/td><\/tr>

\n

maxTransaction<\/code><\/p>\n<\/td>

\n

Long<\/p>\n<\/td>

\n

\"-x-\"<\/p>\n<\/td>

\n

Number of transaction reports to return.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

Callback<\/h2>\n<\/colgroup>
Name<\/th>Description<\/th><\/tr><\/thead>
\n

TxStoreReportCB<\/code><\/p>\n<\/td>

\n

Callback to GetTxStoreReport<\/code> that provides the reports.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

Parameters<\/h2>\n<\/colgroup>

Name<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

\n

reportObj<\/code><\/p>\n<\/td>

\n

TxStoreReport<\/a><\/p>\n<\/td>

\n

The TxStoreReport<\/code> object that contains the reports.<\/p>\n<\/td><\/tr>

\n

pedResult<\/code><\/p>\n<\/td>

\n

int<\/p>\n<\/td>

\n

Result denoting whether an error occurred on the PED.\u00a0A value of 0 means no error occurred.<\/p>\n<\/td><\/tr>

\n

pspResult<\/code><\/p>\n<\/td>

\n

int<\/p>\n<\/td>

\n

Result denoting whether an error occurred on the PSP.\u00a0A value of 0 means no error occurred.<\/p>\n<\/td><\/tr>

\n

libResult<\/code><\/p>\n<\/td>

\n

int<\/p>\n<\/td>

\n

Result denoting whether an error occurred in the Library. A value of 0 means no error occurred.<\/p>\n<\/td><\/tr>

\n

errorMessage<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

Error message describing what went wrong.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

TxStoreReport Parameters<\/h2>\n

Name<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

\n

tenderReference<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

Reference for the tender. Specify a\u00a0tenderReference<\/code>\u00a0to return a report for that tender.<\/p>\n<\/td><\/tr>

\n

currency<\/code><\/p>\n<\/td>

\n

string<\/p>\n<\/td>

The transaction currency
\n<\/p><\/td><\/tr>

\n

amount<\/code><\/p>\n<\/td>

\n

long<\/p>\n<\/td>

\n

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

  • For a normal authorization, this contains the authorized amount.<\/li>
  • For a partial authorization, this contains the authorized amount.<\/li>
  • For a DCC transaction, this contains the pre-DCC total.<\/li><\/ul><\/p>\n<\/td><\/tr>
\n

referenceAmount<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

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

  • For a normal authorization, this field is empty.<\/li>
  • For a partial authorization, this contains the initial amount.<\/li>
  • For a DCC transaction, this contains the final, post-conversion, total.<\/li><\/ul>



    \n<\/p><\/p>\n<\/td><\/tr>

\n

timestamp<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

The date and time at which the tender was created.<\/p>\n<\/td><\/tr>

\n

state<\/code><\/p>\n<\/td>

\n

Transaction.TenderState<\/p>\n<\/td>

\n

The state of the transaction.<\/p>\n<\/td><\/tr>

\n

capturePending<\/code><\/p>\n<\/td>

\n

boolean<\/p>\n<\/td>

\n

Is set to true if a pending transaction exists on the PED, to be sent to the plataforma de pagamentos da Adyen and captured.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

An extended report also contains:<\/p>\n

Name<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

\n

merchantReference<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

The transaction reference provided by the Merchant (reported in the plataforma de pagamentos da Adyen).<\/p>\n<\/td><\/tr>

\n

pspReference<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

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

<\/p>\n

A pspReference<\/code> and authCode<\/code> will not be visible if the transaction was performed offline.<\/p>\n<\/div><\/div>\n<\/td><\/tr>

\n

maskedPan<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

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.<\/p>\n<\/td><\/tr>

\n

posEntryMode<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

POS entry mode (ICC\/MSR\/MKE\/CLESS_CHIP\/CLESS_SWIPE).<\/p>\n<\/td><\/tr>

\n

receiptSets<\/code><\/p>\n<\/td>

\n

List<\/receiptset><\/p>\n<\/td>

\n

Set used to hold\u00a0a list of receipt information.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

Some helper methods are provided in the reportObj:<\/p>\n

Helper methods and parameters<\/h2>\n<\/colgroup>

Name<\/p><\/th>

Input Parameters<\/p><\/th>

Type<\/th>

Description<\/p><\/th>

Returned Parameters<\/th>Type<\/th><\/tr><\/thead>
\n

GetRequestedTenderReference<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns the specified tender reference.<\/p>\n<\/td>

\n

tenderReference<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td><\/tr>

\n

GetRequestedMaxTransaction<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Number of transaction reports to return.<\/p>\n<\/td>

\n

maxTransaction<\/code><\/p>\n<\/td>

\n

long<\/p>\n<\/td><\/tr>

\n

GetReportCount<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns the number of reports in the TXStoreReport object.<\/p>\n<\/td>

\n

reportCount<\/code><\/p>\n<\/td>

\n

long<\/p>\n<\/td><\/tr>

\n

GetReport<\/code><\/p>\n<\/td>

\n

reportId<\/code><\/p>\n<\/td>

\n

long<\/p>\n<\/td>

\n

Returns an report object which contains the specified report.<\/p>\n<\/td>

\n

reportObj<\/code><\/p>\n<\/td>

\n

TxStoreReport<\/p>\n<\/td><\/tr>

\n

GetTenderReference<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns tender reference for the transaction.<\/p>\n<\/td>

\n

tenderReference<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td><\/tr>

\n

GetState<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns the state of the transaction.<\/p>\n<\/td>

\n

state<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td><\/tr>

\n

GetTimestamp<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns the time the transaction was processed.<\/p>\n<\/td>

\n

timestamp<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td><\/tr>

\n

GetCapturePending<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns transaction where the capture is still pending.<\/p>\n<\/td>

\n

pending<\/code><\/p>\n<\/td>

\n

long<\/p>\n<\/td><\/tr>

\n

GetAmount<\/code><\/p>\n<\/td>

\n

currency<\/code><\/p>\n<\/td>

\n

Variant<\/p>\n<\/td>

\n

Returns the transaction amount in the specified currency.<\/p>\n<\/td>

\n

value, currency<\/code><\/p>\n<\/td>

\n

long<\/p>\n<\/td><\/tr>

\n

GetMerchantReference<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns the merchant reference for the transactions<\/p>\n<\/td>

\n

reference<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td><\/tr>

\n

GetPspReference<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns the PSP reference for the transactions

<\/p>\n

A pspReference<\/code> and authCode<\/code> will not be visible if the transaction was performed offline.<\/p>\n<\/div><\/div>\n<\/td>

\n

reference<\/code>\u00a0<\/p>\n<\/td>

\n

String<\/p>\n<\/td><\/tr>

\n

GetMaskedPan<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

The PAN associated with the transaction, masked such that only personnel with a legitimate business need can see the full PAN.\u00a0<\/p>\n<\/td>

\n

maskPan<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td><\/tr>

\n

GetPosEntryMode<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns the entry mode used, ICC, magstripe, NFC, or MKE.<\/p>\n<\/td>

\n

mode<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td><\/tr>

\n

GetReceiptCount<\/code><\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

\u00a0<\/p>\n<\/td>

\n

Returns the number of receipts stored in the TxStoreReport<\/p>\n<\/td>

\n

receiptTotal<\/code><\/p>\n<\/td>

\n

long<\/p>\n<\/td><\/tr>

\n

GetReceipt<\/code><\/p>\n<\/td>

\n

receiptId<\/code><\/p>\n<\/td>

\n

long<\/p>\n<\/td>

\n

Returns up to 25 receipts, or a specific receipt if you specify an ID.<\/p>\n<\/td>

\n

receiptsObj<\/code><\/p>\n<\/td>

\n

Receipts<\/p>\n<\/td><\/tr><\/tbody><\/table>","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension\/get-transaction-data-from-txstorereport-com","articleFields":{"id":"25147319","type":"page","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension\/get-transaction-data-from-txstorereport-com","title":"Get transaction data from TxStoreReport","content":"PedDevice Object\n\n\n\nName\nDescription\n\n\n\n\nPedDevice\nPED object representing the terminal.\n\n\n\nMethod\nNameDescription\nGetTxStoreReport\n\nUsed to retrieve the TxStoreReport object, which contains results from past transactions.\n\nParameters\nNameTypeRequiredDescription\ntenderReference\n\nString\n\n\n\nReference for the tender. Specify a tenderReference to return a report for that tender.\n\nmaxTransaction\n\nLong\n\n\n\nNumber of transaction reports to return.\n\nCallback\nNameDescription\nTxStoreReportCB\n\nCallback to GetTxStoreReport that provides the reports.\n\nParameters\nNameTypeDescription\nreportObj\n\nTxStoreReport\n\nThe TxStoreReport object that contains the reports.\n\npedResult\n\nint\n\nResult denoting whether an error occurred on the PED.\u00a0A value of 0 means no error occurred.\n\npspResult\n\nint\n\nResult denoting whether an error occurred on the PSP.\u00a0A value of 0 means no error occurred.\n\nlibResult\n\nint\n\nResult denoting whether an error occurred in the Library. A value of 0 means no error occurred.\n\nerrorMessage\n\nString\n\nError message describing what went wrong.\n\nTxStoreReport Parameters\nNameTypeDescription\ntenderReference\n\nString\n\nReference for the tender. Specify a\u00a0tenderReference\u00a0to return a report for that tender.\n\ncurrency\n\nstring\nThe transaction currency\n\namount\n\nlong\n\nThe 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.\n\nreferenceAmount\n\n\u00a0\n\nThe transaction amount in minor units (100 is 1.00 with EUR).\u00a0For 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.\n\n\ntimestamp\n\nString\n\nThe date and time at which the tender was created.\n\nstate\n\nTransaction.TenderState\n\nThe state of the transaction.\n\ncapturePending\n\nboolean\n\nIs set to true if a pending transaction exists on the PED, to be sent to the plataforma de pagamentos da Adyen and captured.\n\nAn extended report also contains:\nNameTypeDescription\nmerchantReference\n\nString\n\nThe transaction reference provided by the Merchant (reported in the plataforma de pagamentos da Adyen).\n\npspReference\n\nString\n\nAdyen's unique 16-character string associated with the transaction\/the request.\u00a0\nA pspReference and authCode will not be visible if the transaction was performed offline.\n\n\nmaskedPan\n\nString\n\nThe 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.\n\nposEntryMode\n\nString\n\nPOS entry mode (ICC\/MSR\/MKE\/CLESS_CHIP\/CLESS_SWIPE).\n\nreceiptSets\n\nList\n\nSet used to hold\u00a0a list of receipt information.\n\nSome helper methods are provided in the reportObj:\nHelper methods and parameters\nNameInput ParametersTypeDescriptionReturned ParametersType\nGetRequestedTenderReference\n\n\u00a0\n\n\u00a0\n\nReturns the specified tender reference.\n\ntenderReference\n\nString\n\nGetRequestedMaxTransaction\n\n\u00a0\n\n\u00a0\n\nNumber of transaction reports to return.\n\nmaxTransaction\n\nlong\n\nGetReportCount\n\n\u00a0\n\n\u00a0\n\nReturns the number of reports in the TXStoreReport object.\n\nreportCount\n\nlong\n\nGetReport\n\nreportId\n\nlong\n\nReturns an report object which contains the specified report.\n\nreportObj\n\nTxStoreReport\n\nGetTenderReference\n\n\u00a0\n\n\u00a0\n\nReturns tender reference for the transaction.\n\ntenderReference\n\nString\n\nGetState\n\n\u00a0\n\n\u00a0\n\nReturns the state of the transaction.\n\nstate\n\nString\n\nGetTimestamp\n\n\u00a0\n\n\u00a0\n\nReturns the time the transaction was processed.\n\ntimestamp\n\nString\n\nGetCapturePending\n\n\u00a0\n\n\u00a0\n\nReturns transaction where the capture is still pending.\n\npending\n\nlong\n\nGetAmount\n\ncurrency\n\nVariant\n\nReturns the transaction amount in the specified currency.\n\nvalue, currency\n\nlong\n\nGetMerchantReference\n\n\u00a0\n\n\u00a0\n\nReturns the merchant reference for the transactions\n\nreference\n\nString\n\nGetPspReference\n\n\u00a0\n\n\u00a0\n\nReturns the PSP reference for the transactions\nA pspReference and authCode will not be visible if the transaction was performed offline.\n\n\nreference\u00a0\n\nString\n\nGetMaskedPan\n\n\u00a0\n\n\u00a0\n\nThe PAN associated with the transaction, masked such that only personnel with a legitimate business need can see the full PAN.\u00a0\n\nmaskPan\n\nString\n\nGetPosEntryMode\n\n\u00a0\n\n\u00a0\n\nReturns the entry mode used, ICC, magstripe, NFC, or MKE.\n\nmode\n\nString\n\nGetReceiptCount\n\n\u00a0\n\n\u00a0\n\nReturns the number of receipts stored in the TxStoreReport\n\nreceiptTotal\n\nlong\n\nGetReceipt\n\nreceiptId\n\nlong\n\nReturns up to 25 receipts, or a specific receipt if you specify an ID.\n\nreceiptsObj\n\nReceipts\n","type":"page","locale":"pt","boost":14,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Deprecation of classic libraries","lvl3":"Library integrations","lvl4":"COM extension for Windows integration","lvl5":"Extras","lvl6":"Get transaction data from TxStoreReport"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation","lvl3":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations","lvl4":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration","lvl5":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension","lvl6":"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension\/get-transaction-data-from-txstorereport-com"},"levels":7,"category":"In-person payments","category_color":"green","tags":["transaction","TxStoreReport"]}}