Skip to content

Transactions Overview

Nikolaj Leischner edited this page Oct 31, 2019 · 18 revisions

StashQ's Dashboard users will have an overview of their transactions where they can filter the list of transactions by specific criteria and access each transaction's details.

Operations

Transaction Details

The transactions will be queried by the transactionId. In case there are multiple transactions with the same transaction id, the last transaction will be returned as main, and it will contain a list of related transactions in a TransactionTimeline object. The details can be retrieved by providing the following parameters in an URL path:

Parameter Name Description Type Required
Merchant-Id Merchant id String Yes
Transaction-Id Transaction id String Yes

Response body:

Parameter Name Description Type
createdDate Created date Date
transactionId Transaction id String
currencyId Currency String
amount Amount String
reason Reason String
action PREAUTH, AUTH, CAPTURE, REVERSAL or REFUND String
status SUCCESS or FAIL String
customerId Merchant customer id String
paymentMethod CC, SEPA, PAY_PAL, or VISA, MASTERCARD etc, if CC type is provided during alias registration String
paymentInfo Payment info PaymentInfo
merchantTransactionId Merchant transaction id String
merchantCustomerId Merchant customer id String
pspTestMode Whether it is a test transaction or not Boolean
merchantId Merchant id String
aliasId Alias id String
timelineInfo Info about related transactions TransactionTimeline

TransactionTimeline:

Parameter Name Description Type
amount Amount String
reason Reason String
action PREAUTH, AUTH, CAPTURE, REVERSAL or REFUND String
status SUCCESS or FAIL String
createdDate Created date Date

Filter Transactions

To filter the list of transactions, you need to provide the following parameter in an URL path:

Parameter Name Description Type Required
Merchant-Id Merchant id String Yes

The transactions can be filtered by providing the following criteria:

Parameter Name Description Type Required
createdAtStart It will return all the transactions created after this date if provided (Example: 2019-08-06T08:00:00Z) String No
createdAtEnd It will return all the transactions created before this date if provided (Example: 2019-08-06T08:00:00Z) String No
paymentMethod CC, SEPA or PAY_PAL String No
action PREAUTH, AUTH, CAPTURE, REVERSAL or REFUND String No
status SUCCESS or FAIL String No
text Text relevant for the transaction - PSP, reason, transaction id, currency, merchant transaction id, merchant customer id, alias id, payment method type, cc mask, cc expiry date, cc type, IBAN String No
limit Number of results to show Int No
offset A starting point to return the rows Int No

The response body will contain a list of the following parameters:

Parameter Name Description Type
transactionId Transaction id String
amount Amount String
currencyId Currency String
action PREAUTH, AUTH, CAPTURE, REVERSAL or REFUND String
status SUCCESS or FAIL String
reason Reason String
customerId Merchant customer id String
paymentMethod CC, SEPA, PAY_PAL, or VISA, MASTERCARD etc, if provided during registration String
createdDate Created date String

Merchants have the possibility to export the filtered transactions as a .csv file from the dashboard.

Clone this wiki locally