Retrieve

POST 
/retrieve/:apiKey

Retrieves a list of transactions between from and to along with the fees associated with them.

Request parameters

If both a request body and GET parameters are specified, the GET parameters take precedence.

Request

Path Parameters

apiKey stringrequired

Possible values: <= 50 characters

API key of connector.

Query Parameters

retrieve object

application/x-www-form-urlencoded

Body

required

from date-timerequired
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.
Example: 2001-02-03T 04:05:06
to date-timerequired
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.
Example: 2001-02-03 04:05:06
page int64required
Page number.
Possible values: >= 1
Example: 1

Responses

200

A paged response of reconciled transactions.

Pagination

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

Schema

total_entry_count int64

Total number of entries.

page_count int64

Total number of pages.

current_page int64

Current page of data set.

current_page_entry_count int64

Entry count of current page.

Possible values: <= 100

next_page_exists boolean

Whether there is a next page.

transactions

object[]

List of transactions on the current page (maximum 100).

Array [

uuid stringrequired

Transaction ID.

Example: 20230315-6d432fb7217843388847

merchantTransactionId stringnullable

Transaction's merchant ID.

Default value: null

Example: ed0687ad-a876-42fd-bfc2-ce7c91d9700d

referenceUuid stringnullable

ID of an initial transaction if it exists, e.g. a refund.

Default value: null

Example: 20230315-6d432fb7217843388847

type stringnullable

Transaction type.

Possible values: [debit, capture, deregister, preauthorize, refund, register, void, chargeback, payout, cb-reversal, prepare-debit, prepare-preauthorize, inc-auth]

Default value: null

Example: debit

status stringnullable

Default value: null

Example: success

createdAt date-timenullable

Transaction creation date.

Default value: null

Example: 2001-02-03T04:05:06+02:00

amount Amount (string)nullable

Decimal amount separated by ., maximum of 3 decimals.

Possible values: Value must match regular expression ^(([0-9]+)|([0-9]+\.[0-9]{1,3}))$

Default value: null

Example: 9.99

currency Currency (string)nullable

ISO 4217 three-letter currency code.

Possible values: Value must match regular expression ^[A-Z]{3}$

Default value: null

Example: EUR

withRegister boolean

Was a debit transaction performed with registering the payment instrument.

Default value: false

description stringnullable

Transaction description.

Default value: null

errors

object[]

nullable

Errors of a transaction.

Array [

message stringnullable

Error message.

Default value: null

Example: Transaction declined.

code stringnullable

Error code.

Default value: null

Example: 3002

adapter_message stringnullable

Adapter specific error message, passed verbatim from the upstream Adapter.

Default value: null

Example: Do not honour

adapter_code stringnullable

Adapter specific error code, passed verbatim from the upstream Adapter.

Default value: null

Example: 5

]

fees

object[]

nullable

Transaction fees.

Array [

amount Amount (string)nullable

Decimal amount separated by ., maximum of 3 decimals.

Possible values: Value must match regular expression ^(([0-9]+)|([0-9]+\.[0-9]{1,3}))$

Default value: null

Example: 9.99

currency Currency (string)nullable

ISO 4217 three-letter currency code.

Possible values: Value must match regular expression ^[A-Z]{3}$

Default value: null

Example: EUR

entity_type FeeEntityType (string)

Type of fee.

Possible values: [normal, markup, interchange, scheme, scheme-2, scheme-3, conversion, gateway, commission, merchant-normal, merchant-markup, merchant-interchange, merchant-scheme, merchant-conversion, surcharge]

]

]

property name* any

Example (from schema)

{
  "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"
        }
      ]
    }
  ]
}

Loading...