Payments Summary

Return payment totals grouped by provider and status.

Method

GET /v1/analytics/payments/summary

Query Parameters

from · string · required

Start date (YYYY-MM-DD, inclusive).

to · string · required

End date (YYYY-MM-DD, inclusive).

workspaceId · uuid · required

Workspace identifier.

Headers

Authorization · string

Bearer token with analytics:read scope.

Request Example

cURL

curl "https://api.voyantcloud.com/v1/analytics/payments/summary?from=2025-02-01&to=2025-02-07&workspaceId=ws_abc" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

[
  { "day": "2025-02-01", "provider": "netopia", "status": "captured", "amount_cents_sum": 1580000, "cnt": 7 },
  { "day": "2025-02-01", "provider": "netopia", "status": "failed", "amount_cents_sum": 45000, "cnt": 1 },
  { "day": "2025-02-02", "provider": "bank", "status": "pending", "amount_cents_sum": 320000, "cnt": 3 }
]

Use the status field to separate captured vs failed payments and monitor provider health over time.