Payment summary report
Generates a payment summary report with flexible grouping and metric calculations.
Query parameters
Field to group results by.
Available fields: currency, status, displayStatus, createdAt, authorizedAt, capturedAt, customer, gatewayProfile, product.name, customer.shippingAddress.country, attribution.utmSource, attribution.utmCampaign
Date granularity for groupBy when it is a date field. Defaults to day. hour additionally requires the query to be bounded to a createdAt range of at most two days. Accepts hour, day, week, month, quarter, year; anything else falls back to the default.
Optional second axis for pivoting (must differ from groupBy). Each row will then carry both the primary groupBy value and a secondaryGroupBy value.
Available fields: currency, status, displayStatus, createdAt, authorizedAt, capturedAt, customer, gatewayProfile, product.name, customer.shippingAddress.country, attribution.utmSource, attribution.utmCampaign
Date granularity for secondaryGroupBy when it is a date field. Defaults to day.
Metrics to include in the results. Multiple measures can be specified as comma-separated values. If measures is not provided, all metrics specified in the config will be calculated.
Available metrics: fcPaymentsCount, fcSuccessfulCount, fcSuccessfulItemCount, fcIncompleteCount, fcFailedCount, fcRefundAmount, fcChargebackAmount, fcRevenue, fcApprovalRate, recurringPaymentsCount, recurringSuccessfulCount, recurringSuccessfulItemCount, recurringDeclinedCount, recurringRefundAmount, recurringChargebackAmount, recurringRevenue, recurringApprovalRate, refundedPaymentsCount, refundAmount, refundPercentage, chargebacksCount, chargebackAmount, chargebackPercentage, totalGrossRevenue, totalNetRevenue
Whether to include a rollup row aggregating every group. Pass false to omit it.
Response
OK
Example response
{
"data": [
{
"groupBy": "USD",
"secondaryGroupBy": "eur",
"fcPaymentsCount": 42,
"fcSuccessfulCount": 35,
"fcSuccessfulItemCount": 58,
"fcIncompleteCount": 3,
"fcFailedCount": 4,
"fcRevenue": 15000,
"fcApprovalRate": 89.74,
"recurringPaymentsCount": 120,
"recurringSuccessfulCount": 110,
"recurringSuccessfulItemCount": 185,
"recurringDeclinedCount": 10,
"recurringRevenue": 45000,
"recurringApprovalRate": 91.67,
"refundedPaymentsCount": 5,
"refundAmount": 2500,
"refundPercentage": 4.17,
"chargebacksCount": 2,
"chargebackAmount": 1000,
"chargebackPercentage": 1.67,
"fcRefundAmount": 1500,
"fcChargebackAmount": 600,
"recurringRefundAmount": 1000,
"recurringChargebackAmount": 400,
"totalGrossRevenue": 60000,
"totalNetRevenue": 56500
}
],
"total": {
"groupBy": "USD",
"secondaryGroupBy": "eur",
"fcPaymentsCount": 42,
"fcSuccessfulCount": 35,
"fcSuccessfulItemCount": 58,
"fcIncompleteCount": 3,
"fcFailedCount": 4,
"fcRevenue": 15000,
"fcApprovalRate": 89.74,
"recurringPaymentsCount": 120,
"recurringSuccessfulCount": 110,
"recurringSuccessfulItemCount": 185,
"recurringDeclinedCount": 10,
"recurringRevenue": 45000,
"recurringApprovalRate": 91.67,
"refundedPaymentsCount": 5,
"refundAmount": 2500,
"refundPercentage": 4.17,
"chargebacksCount": 2,
"chargebackAmount": 1000,
"chargebackPercentage": 1.67,
"fcRefundAmount": 1500,
"fcChargebackAmount": 600,
"recurringRefundAmount": 1000,
"recurringChargebackAmount": 400,
"totalGrossRevenue": 60000,
"totalNetRevenue": 56500
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.