logo

Retrieve a transactions report

Retrieve a transactions report.

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

Report start day.

periodEnd
required
string <date-time>

Report end day.

aggregationField
required
string

Report aggregation field.

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

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

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

Selected aggregation field value.

authApprovedThroughput
integer

Approved auth transactions to all transactions percentage.

approvedThroughput
integer

Approved sale transactions to all transactions percentage.

authApprovalCount
integer

Approved auth transactions count.

disputesRate
integer

Disputed transactions to all approved sale and capture transactions percentage.

disputesCount
integer

Disputed transactions to all approved sale and capture transactions count.

salesCount
integer

Sales count.

salesValue
number <double>

Sales value.

salesAverage
number <double>

Sales average value.

refundsCount
integer

Refunds count.

refundsValue
number <double>

Refunds value.

amount
number <double>

Amount.

count
number <double>

Transactions count.

unapprovedCount
number <double>

Unapproved transactions count.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/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": [
    ]
}
➔ Next to Data Exports