Skip to content
StraventaDocs
Now in Sandbox.

Merchant payments dashboard snapshot

GET
/v1/payments/dashboard

Returns the merchant payments dashboard snapshot for the selected rolling window (today | 7d | 30d). The response includes both last_payout_at and next_payout_at (AC-11.3) so the FE renders the "next payout ETA" tile in a single roundtrip — no second call to /v1/payments/merchants/{id}/payout-schedule required. next_payout_at is null when the scheduler has not yet computed a first tick for the merchant (no payout-settings row, or row with a NULL next_payout_at).

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

merchant_id*string
Formatuuid
window?string
Value in"today" | "7d" | "30d"
compare_to?string

AC-46.6 — when set to prev_period, the response includes a comparison block giving each headline KPI's {value, previous_value, delta_pct} against the immediately preceding window of equal length. Omitted otherwise (back-compat).

Value in"prev_period"

Response Body

application/json

application/json

application/json

curl -X GET https://sandbox.505pay.link/v1/payments/dashboard \  -H "Authorization: Bearer $TOKEN" \  -H "Content-Type: application/json"
{}
Empty
{
  "error": "validation_failed",
  "message": "amount_idr is required",
  "request_id": "req_018f4d9f"
}
Empty
{
  "error": "validation_failed",
  "message": "amount_idr is required",
  "request_id": "req_018f4d9f"
}

Was this page helpful?