Retrieve a transactions report

Retrieves a transactions report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string <date-time>

Date and time when the report starts.

periodEnd
required
string <date-time>

Date and time when the report ends.

aggregationField
required
string

Report aggregation field.

Enum: "website" "currency" "bin" "rebillNumber" "transactionResult" "transactionType" "gatewayAccount" "gateway" "retryNumber" "plan" … 9 more
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

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

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

Responses
200

Report retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array of objects

Transaction data.

Array
aggregationFieldValue
string

Aggregation field value.

authApprovedThroughput
number <double>

Percentage of approved authentication transactions.

approvedThroughput
number <double>

Percentage of approved sale transactions.

authApprovalCount
integer

Total number of approved authentication transactions.

disputesRate
number <double>

Percentage of disputed sale and capture transactions.

disputesCount
integer

Total number of disputed sale and capture transactions.

salesCount
integer

Total number of sales.

salesValue
number <double>

Total sales value.

salesAverage
number <double>

Average sales value.

refundsCount
integer

Total number of refunds.

refundsValue
number <double>

Total value of refunds.

amount
number <double>

Amount of revenue. This value is the result of salesValue minus refundsValue.

count
number <double>

Total number of transactions.

unapprovedCount
number <double>

Total number of unapproved transactions.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/reports/transactions
Request samples
const params = {
    aggregationField: 'website',
    periodStart: '2017-09-22T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getTransactions(params);
Response samples
application/json
{
  • "data": [
    ]
}