Skip to main content
GET
https://sandbox.finhub.cloud
/
api
/
v2.1
/
admin
/
fees
/
revenue
Fee Management API
curl --request GET \
  --url https://sandbox.finhub.cloud/api/v2.1/admin/fees/revenue \
  --header 'Authorization: <authorization>' \
  --header 'X-Tenant-ID: <x-tenant-id>'
{
  "success": true,
  "data": {
    "period": {
      "startDate": "2024-01-01",
      "endDate": "2024-01-31"
    },
    "totalRevenue": {
      "value": 25000.00,
      "currency": "EUR"
    },
    "transactionCount": 15000,
    "averageFee": {
      "value": 1.67,
      "currency": "EUR"
    },
    "byOperationType": {
      "TRANSFER": {
        "count": 8000,
        "revenue": 12000.00
      },
      "SEPA": {
        "count": 5000,
        "revenue": 7500.00
      },
      "SWIFT": {
        "count": 2000,
        "revenue": 5500.00
      }
    },
    "dailyBreakdown": [
      {
        "date": "2024-01-01",
        "revenue": 800.00,
        "transactions": 500
      }
    ]
  }
}

Fee Management API

APIs for managing fee configurations and querying fee-related information.
Base URL: https://sandbox.finhub.cloud/api/v2.1/admin

Available Endpoints

Fee Revenue

Query fee revenue reports

Tenant Fees

Get tenant fee summary

Order Fees

Get fees for specific orders

Get Fee Revenue

Retrieves fee revenue data for a specified period with optional tenant filtering.

Request

startDate
string
Start date for the report (ISO 8601 format)
endDate
string
End date for the report (ISO 8601 format)
tenantId
string
Filter by specific tenant (optional)
Authorization
string
required
Bearer token for authentication
X-Tenant-ID
string
required
Tenant identifier

Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/admin/fees/revenue?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"
{
  "success": true,
  "data": {
    "period": {
      "startDate": "2024-01-01",
      "endDate": "2024-01-31"
    },
    "totalRevenue": {
      "value": 25000.00,
      "currency": "EUR"
    },
    "transactionCount": 15000,
    "averageFee": {
      "value": 1.67,
      "currency": "EUR"
    },
    "byOperationType": {
      "TRANSFER": {
        "count": 8000,
        "revenue": 12000.00
      },
      "SEPA": {
        "count": 5000,
        "revenue": 7500.00
      },
      "SWIFT": {
        "count": 2000,
        "revenue": 5500.00
      }
    },
    "dailyBreakdown": [
      {
        "date": "2024-01-01",
        "revenue": 800.00,
        "transactions": 500
      }
    ]
  }
}

Get Tenant Fee Summary

Retrieves comprehensive fee summary for a specific tenant.

Request

tenantId
string
required
Tenant identifier

Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/admin/tenant/tenant_123/fees/summary" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"
{
  "success": true,
  "data": {
    "tenantId": "tenant_123",
    "feeConfigurations": [
      {
        "operationType": "TRANSFER",
        "feeType": "FIXED",
        "value": 1.50,
        "currency": "EUR",
        "minAmount": 0,
        "maxAmount": 50000
      },
      {
        "operationType": "SEPA",
        "feeType": "FIXED",
        "value": 1.50,
        "currency": "EUR"
      },
      {
        "operationType": "SEPA_INSTANT",
        "feeType": "FIXED",
        "value": 2.50,
        "currency": "EUR"
      },
      {
        "operationType": "SWIFT",
        "feeType": "TIERED",
        "tiers": [
          { "upTo": 1000, "fee": 15.00 },
          { "upTo": 10000, "fee": 25.00 },
          { "above": 10000, "fee": 35.00 }
        ],
        "currency": "EUR"
      }
    ],
    "monthlyStats": {
      "totalFees": 5000.00,
      "totalTransactions": 3000
    }
  }
}

Get Order Fees

Retrieves fee details for a specific order.

Request

accountId
string
required
Account identifier
orderId
string
required
Order identifier

Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/fintrans/acc_12345/orders/ord_67890/fees" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"
{
  "success": true,
  "data": {
    "orderId": "ord_67890",
    "accountId": "acc_12345",
    "operationType": "SEPA",
    "transactionAmount": {
      "value": 500.00,
      "currency": "EUR"
    },
    "fee": {
      "value": 1.50,
      "currency": "EUR"
    },
    "feeType": "FIXED",
    "feeBreakdown": {
      "baseFee": 1.50,
      "additionalFees": 0,
      "discounts": 0
    },
    "totalDebit": {
      "value": 501.50,
      "currency": "EUR"
    }
  }
}

Fee Types

FIXED

Fixed fee regardless of amount

PERCENTAGE

Percentage of transaction amount

TIERED

Different rates based on amount tiers

HYBRID

Combination of fixed + percentage

Response Codes

CodeDescription
200Request successful
400Invalid request parameters
401Unauthorized
403Insufficient permissions
404Resource not found
500Internal server error