Retrieve a declined transactions report
Experimental

Request

Retrieves a report on declined transactions.
Security
SecretApiKey or JWT
Query
aggregationFieldstring

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

Enum:"gatewayResponseMessage""gatewayResponseOriginalMessage"
periodStartstring, (date-time)
Date and time when the report starts. If no value is provided, the start date of the previous month is used.
periodEndstring, (date-time)
Date and time when the report ends. If no value is provided, the end date of current month is used.
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
filterstring

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.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/declined-transactions?aggregationField=gatewayResponseMessage&periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&limit=0&offset=0&filter=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.
Bodyapplication/json
dataArray of objects
Response
{
  "data": [
    { … }
  ]
}