Skip to main content
GET
/
payment
/
summary
Get Payment Summary
curl --request GET \
  --url https://api.royalti.io/payment/summary \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/payment/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/payment/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.royalti.io/payment/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.royalti.io/payment/summary"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.royalti.io/payment/summary")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/payment/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "message": "success",
  "summary": {
    "total": 150,
    "byStatus": {
      "completed": 120,
      "processing": 25,
      "failed": 5
    },
    "byCurrency": {
      "USD": 80,
      "EUR": 40,
      "GBP": 30
    },
    "totalAmounts": {
      "amountUSD": 123,
      "amount": 123
    }
  }
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Get Payment Summary The Get Payment Summary endpoint returns aggregated payment statistics for the tenant. Method: GET Authorization:
  • Required role: user or higher
Response Data:
FieldTypeDescription
totalintegerTotal number of payments
byStatusobjectCount of payments grouped by status (completed, processing, failed)
byCurrencyobjectCount of payments grouped by currency
totalAmountsobjectTotal amounts (amountUSD and amount)
Query Parameters:
ParameterTypeDescription
startDate (Optional)stringFilter payments from this date (inclusive)
endDate (Optional)stringFilter payments to this date (inclusive)
currency (Optional)stringFilter by currency code
status (Optional)stringFilter by payment status

Code Examples

const response = await fetch('https://api.royalti.io/payment/summary', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get(
  'https://api.royalti.io/payment/summary',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)
curl -X GET https://api.royalti.io/payment/summary \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

startDate
string<date>

Filter payments from this date (inclusive)

endDate
string<date>

Filter payments to this date (inclusive)

currency
string

Filter by currency code (e.g., USD, EUR)

status
enum<string>

Filter by payment status

Available options:
completed,
processing,
failed

Response

Success

message
string
Example:

"success"

summary
object