Skip to main content
GET
/
api
/
v2
/
partner
/
portfolio
/
summary
Get portfolio summary
curl --request GET \
  --url https://api.modulate.aurorapayments.net/api/v2/partner/portfolio/summary \
  --header 'X-Partner-API-Key: <api-key>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-Partner-API-Key
string
header
required

Query Parameters

period
string | null
default:last_30_days

Aggregation period

timezone
string | null
default:UTC

IANA timezone for period boundaries

Maximum string length: 50

Response

Successful Response