Billing Payload

SNA pushes a billing payload to the Sahamati endpoint every 10 minutes. The payload captures billable data fetches for each FIU, broken down by FIP and by period. The tag for this payload is req-billing-aa.

Schema Reference

Field	Type	Description
agentVersion	string	Version of the SahamatiNet Agent generating data for the Sahamati API endpoint. Note: Required only when using SNA
jsonVersion	string	Version of the JSON schema used for the Sahamati API endpoint. (e.g. "1.0.0")
tag	string	req-billing-aa identifies this as a billing payload
txnId	string	Unique transaction ID for this push request
metricCollectionId	string	Identifier for the input request Note: Required only when using SNA
fromDateTime	string	Start of the 10-minute reporting window (ISO 8601, UTC)
toDateTime	string	End of the 10-minute reporting window (ISO 8601, UTC)
duration	int	Duration in seconds of the reporting window (600 for 10 minutes)
aaId	string	Entity ID of the Account Aggregator. Must match the authenticated AA.
enums.period	array[string]	Ordered list of period buckets. See Period Enum.
fius[].fiuId	string	Entity ID of the FIU for which billing data is reported in this block
fius[].fips[].fipId	string	Entity ID of the FIP from which data was fetched for this FIU
fius[].fips[].counts	array[int]	Counts positionally aligned to enums.period

The counts array must have the same length as enums.period. fius may be an empty array if there is no billable activity in the reporting window.

Period Enum

The counts array for each FIU–FIP pair is positionally aligned to the following periods, in this exact order. Each count is the number of FI/fetch requests whose data range falls within that period.

Position	Period	Description
1	13mo	Count of accounts in FI/fetch with data range ≥ 13 months
2	7mo	Count of accounts in FI/fetch with data range ≥ 7 months and < 13 months
3	4mo	Count of accounts in FI/fetch with data range ≥ 4 months and < 7 months
4	1mo	Count of accounts in FI/fetch with data range ≥ 1 month and < 4 months
5	1w	Count of accounts in FI/fetch with data range ≥ 1 week and < 1 month
6	5d	Count of accounts in FI/fetch with data range ≥ 5 days and < 1 week
7	1d	Count of accounts in FI/fetch with data range ≥ 1 day and < 5 days
8	ps	Count of accounts in FI/fetch with profile and summary fetches.
9	other	Count of accounts in FI/request that could not be mapped to a profile and summary fetch or a transaction fetch

Sample Payload

All values below are synthetic and for illustration only.

{
  "agentVersion": "1.0.0",
  "jsonVersion": "1.0.0",
  "tag": "req-billing-aa",
  "txnId": "00000000-0000-0000-0000-000000000001",
  "metricCollectionId": "mc-test-0001",
  "fromDateTime": "2026-01-01T10:00:00Z",
  "toDateTime": "2026-01-01T10:10:00Z",
  "duration": 600,
  "aaId": "aa-test-001",
  "enums": { "period": ["13mo", "7mo", "4mo", "1mo", "1w", "5d", "1d", "ps", "other"] },
  "fius": [
    {
      "fiuId": "fiu-test-001",
      "fips": [
        {
          "fipId": "fip-test-001",
          "counts": [12, 3, 4, 5, 6, 13, 1, 3, 0]
        }
      ]
    }
  ]
}