Retrieve
POST/retrieve/:apiKey
Retrieves a list of transactions between from and to along with the fees associated with them.
If both a request body and GET parameters are specified, the GET parameters take precedence.
Request
Path Parameters
Possible values: <= 50 characters
API key of connector.
Query Parameters
- application/x-www-form-urlencoded
Body
required
Date range start, must be before to and the duration between from—to cannot be more than 30 days.
Use the RFC 3339 date-time format, but replace "T" with a space (" ") and exclude the timezone.
Date range end, must be after from and the duration between from—to cannot be more than 30 days.
Use the RFC 3339 date-time format, but replace "T" with a space (" ") and exclude the timezone.
Possible values: >= 1
Page number.
Responses
- 200
A paged response of reconciled transactions.
Each request will return a maximum of 100 data sets.
In order to fetch the next page, simply indicate this using the page property.
The response has the next_page_exists field that indicates if more data needs to be retrieved.
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
Total number of entries.
Total number of pages.
Current page of data set.
Possible values: <= 100
Entry count of current page.
Whether there is a next page.
transactions
object[]
List of transactions on the current page (maximum 100).
Transaction ID.
Transaction's merchant ID.
ID of an initial transaction if it exists, e.g. a refund.
Possible values: [debit, capture, deregister, preauthorize, refund, register, void, chargeback, payout, cb-reversal, prepare-debit, prepare-preauthorize, inc-auth]
Transaction type.
Transaction creation date.
Possible values: Value must match regular expression ^(([0-9]+)|([0-9]+\.[0-9]{1,3}))$
Decimal amount separated by ., maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Was a debit transaction performed with registering the payment instrument.
Transaction description.
errors
object[]
nullable
Errors of a transaction.
Error message.
Error code.
Adapter specific error message, passed verbatim from the upstream Adapter.
Adapter specific error code, passed verbatim from the upstream Adapter.
fees
object[]
nullable
Transaction fees.
Possible values: Value must match regular expression ^(([0-9]+)|([0-9]+\.[0-9]{1,3}))$
Decimal amount separated by ., maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Possible values: [normal, markup, interchange, scheme, scheme-2, scheme-3, conversion, gateway, commission, merchant-normal, merchant-markup, merchant-interchange, merchant-scheme, merchant-conversion, surcharge]
Type of fee.
{
"total_entry_count": 0,
"page_count": 0,
"current_page": 0,
"current_page_entry_count": 0,
"next_page_exists": true,
"transactions": [
{
"uuid": "20230315-6d432fb7217843388847",
"merchantTransactionId": "ed0687ad-a876-42fd-bfc2-ce7c91d9700d",
"referenceUuid": "20230315-6d432fb7217843388847",
"type": "debit",
"status": "success",
"createdAt": "2001-02-03T04:05:06+02:00",
"amount": "9.99",
"currency": "EUR",
"withRegister": false,
"description": "string",
"errors": [
{
"message": "Transaction declined.",
"code": 3002,
"adapter_message": "Do not honour",
"adapter_code": 5
}
],
"fees": [
{
"amount": 0.5,
"currency": "EUR"
}
]
}
]
}