GET /experimental/reports/declined-transactions

Retrieves a report on declined transactions.

Servers

Query parameters

Name Type Required Description
limit Integer No

Limits the number of collection items to be returned.

filter String No

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

periodStart String No

Date and time when the report starts. If no value is provided, the start date of the previous month is used.

periodEnd String No

Date and time when the report ends. If no value is provided, the end date of current month is used.

aggregationField String No

Aggregation field of the report. If a value is not provided, gatewayResponseMessage is used.

Valid values:

  • "gatewayResponseOriginalMessage"
  • "gatewayResponseMessage"
offset Integer No

Specifies the starting point within the collection of items to be returned.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.