Enter at least two characters to search. Searching documentation… No matching sections. Try an endpoint, field or event name.

Search could not load. Check your connection and try again.

Account overview

View as Markdown

The figures on the dashboard's overview, for the mode of the key: the last 30 days against the 30 before, where customers drop out, and what is waiting on a person. They are worked out at most every five minutes, and sooner when anything in the account changes.

On this page

The overview object

Field	Type	Description
`object` "overview"	"overview"	The kind of object.
`period.from, period.to` string	string	The 30 days the figures cover, today included, as YYYY-MM-DD.
`currency` string	string	The currency the amounts are in: the one most charges were paid in over the period, otherwise the account's default.
`volume, sent_volume` string	string	What was paid in that currency over the period, and what of it reached your wallets once its payout confirmed.
`volume_change_percent` number\|null	number\|null	How volume compares with the 30 days before, in percent. Null when nothing was paid then.
`paid_charges, conversion_rate_percent` integer, number\|null	integer, number\|null	How many charges were paid, and what share of the charges that ended over the period ended paid.
`pending_charges, active_payment_links, open_invoices, overdue_invoices` integer	integer	What is open right now.
`funnel` object	object	Where the period's charges ended: started, paid, waiting, abandoned and incomplete, and the same per coin under assets.
`attention` object	object	What waits on a person: underpaid_charges and late_payments to accept or refund (id, asset, amount, received_amount, at most five each), payouts_waiting_for_address per coin, and failing_webhook_endpoints, the active endpoints with a failed delivery in the last 7 days.
`assets` array	array	The coins charges were paid in over the period: asset, paid_charges and share_percent.
`top_payment_links` array	array	The four payment links with the most paid charges over the period: id, title and paid_charges.
`setup` object	object	Whether the account has a payout_address, a payment_link, a paid_charge, a webhook_endpoint and a public_profile in this mode, to tell what is left to set up.
`daily` array	array	One entry per day of the period: date, volume, sent_volume and paid_charges.

Endpoints

GET /v1/overview The overview of the key's mode, with meta.mode. Needs overview:read.

Example: read the overview

GET /v1/overview

Copy failed. Select the code and copy it manually.

curl 'https://api.velirapay.com/v1/overview' \
  --fail-with-body --silent --show-error --max-time 30 \
  -H "Authorization: Bearer ${VELIRAPAY_API_KEY:?Set VELIRAPAY_API_KEY}" \
  -H 'Accept: application/json'

<?php

use VeliraPay\VeliraPayClient;

require __DIR__.'/vendor/autoload.php';

$apiKey = getenv('VELIRAPAY_API_KEY') ?: throw new RuntimeException('Set VELIRAPAY_API_KEY.');
$velirapay = new VeliraPayClient($apiKey, baseUrl: 'https://api.velirapay.com');

$overview = $velirapay->overview->retrieve();

echo json_encode($overview, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_THROW_ON_ERROR), PHP_EOL;

use VeliraPay\Laravel\Facades\VeliraPay;

$overview = VeliraPay::overview()->retrieve();

const secretKey = process.env.VELIRAPAY_API_KEY;
if (!secretKey) throw new Error('Set VELIRAPAY_API_KEY.');

const response = await fetch('https://api.velirapay.com/v1/overview', {
  headers: {
    Authorization: `Bearer ${secretKey}`,
    Accept: 'application/json',
  },
  redirect: 'error',
  signal: AbortSignal.timeout(30_000),
});

if (!response.ok) {
  throw new Error(`VeliraPay ${response.status}: ${await response.text()}`);
}

const overview = response.status === 204 ? null : (await response.json()).data;
console.log(JSON.stringify(overview, null, 2));

import json
import os
import requests

api_key = os.environ["VELIRAPAY_API_KEY"]

response = requests.get(
    "https://api.velirapay.com/v1/overview",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Accept": "application/json",
    },
    timeout=(5, 30),
    allow_redirects=False,
)

if not 200 <= response.status_code < 300:
    raise RuntimeError(f"VeliraPay {response.status_code}: {response.text}")

overview = None if response.status_code == 204 else response.json()["data"]
print(json.dumps(overview, indent=2))

using System;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text.Json;

var secretKey = Environment.GetEnvironmentVariable("VELIRAPAY_API_KEY")
    ?? throw new InvalidOperationException("Set VELIRAPAY_API_KEY.");

using var client = new HttpClient(new HttpClientHandler { AllowAutoRedirect = false })
{
    Timeout = TimeSpan.FromSeconds(30),
};
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.velirapay.com/v1/overview");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", secretKey);
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

using var response = await client.SendAsync(request);
var responseBody = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
{
    throw new HttpRequestException($"VeliraPay {(int)response.StatusCode}: {responseBody}");
}

JsonElement? overview = null;
if (response.StatusCode != HttpStatusCode.NoContent)
{
    using var document = JsonDocument.Parse(responseBody);
    overview = document.RootElement.GetProperty("data").Clone();
}

Console.WriteLine(overview?.GetRawText() ?? "null");

Response

Copy failed. Select the code and copy it manually.

{
  "data": {
    "object": "overview",
    "period": { "from": "2026-10-08", "to": "2026-11-06" },
    "currency": "USD",
    "volume": "4280.00",
    "volume_change_percent": 12.5,
    "sent_volume": "4011.62",
    "paid_charges": 37,
    "conversion_rate_percent": 82.22,
    "pending_charges": 3,
    "funnel": { "started": 45, "paid": 37, "waiting": 3, "abandoned": 4, "incomplete": 1, "assets": [ … ] },
    "attention": {
      "underpaid_charges": [ { "id": "2t4bcuqkpkoy", "asset": "BTC", "amount": "0.00151", "received_amount": "0.0015" } ],
      "late_payments": [],
      "payouts_waiting_for_address": [],
      "failing_webhook_endpoints": 0
    },
    "daily": [ { "date": "2026-10-08", "volume": "120.00", "sent_volume": "116.40", "paid_charges": 1 }, … ],
    …
  },
  "meta": { "mode": "live" }
}

What each coin has been paid out and is still owed is under payouts. See the payout summary