Skip to main content

Reporting APIs

The Reporting APIs let you look up your data on Open Fabric: transactions, reconciliation and settlement records, accounts, devices and tokens. Use them to build back-office views and to reconcile against your own records. Use them for operational lookups too, such as finding the account behind a secure device wallet.

You only ever see your own data, and the Reporting APIs never change anything.

Available reports​

AreaEndpointReturnsGuide
Account TokenizationPOST /v1/reporting/rest/pba/transactionsCard transactions, with nested transactions and reconciliationTransactions
Account TokenizationPOST /v1/reporting/rest/pba/accountsAccounts, with their devices and static tokensAccounts and tokens
Account TokenizationPOST /v1/reporting/rest/pba/customer/accountsAll accounts of one customerAccounts and tokens
Account TokenizationPOST /v1/reporting/rest/pba/static-tokensStatic tokens (virtual cards)Accounts and tokens
Account TokenizationPOST /v1/reporting/rest/pba/devicesDevicesAccounts and tokens
Account TokenizationPOST /v1/reporting/rest/pba/secure-device-walletsLatest device per secure device walletAccounts and tokens
Account TokenizationPOST /v1/reporting/rest/pba/accounts/secure-wallet-idsSecure device wallet IDs for your account or customer referencesAccounts and tokens
Account TokenizationPOST /v1/reporting/rest/pba/devices/accountThe account behind each secure device wallet IDAccounts and tokens
Online OrchestrationPOST /v1/reporting/rest/txn/transactionsOrchestrated transactionsOnline Orchestration
Online OrchestrationPOST /v1/reporting/rest/recon/transactionsTransactions with their reconciliation statusOnline Orchestration
Online OrchestrationPOST /v1/reporting/rest/recon/settlementsSettlement recordsOnline Orchestration

Each guide lists the request fields and response fields of its endpoints, along with the GraphQL query each one runs.

tip

For daily clearing and settlement files, use the file ready notifications rather than these APIs. See Clearing reports and Settlement.

Authentication and scopes​

Call the Reporting APIs with an access token from Authentication:

POST /v1/reporting/rest/pba/transactions
Authorization: Bearer <access_token>
Content-Type: application/json

Each endpoint requires one read scope:

ScopeEndpoints
transactions.readpba/transactions, txn/transactions, recon/transactions, recon/settlements
accounts.readpba/accounts
customers.readpba/customer/accounts
tokens.readpba/static-tokens, pba/devices, pba/secure-device-wallets, pba/accounts/secure-wallet-ids, pba/devices/account

Making a request​

All Reporting endpoints use POST, with the filters in a JSON body. The body is optional, unless an endpoint marks a filter as required. Send {} to get the first page with no filters.

curl -X POST "https://<api-host>/v1/reporting/rest/pba/transactions" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"startDate": "2026-10-01T00:00:00Z",
"endDate": "2026-11-01T00:00:00Z",
"statuses": ["approved", "processed"],
"limit": 100,
"offset": 0
}'

Filters​

  • List filters match exact values. A filter such as statuses: ["approved", "processed"] returns records whose status is any of those values. Values are case-sensitive, with no wildcards or partial matches.
  • An omitted filter matches everything. Leave out a filter rather than sending an empty list.
  • Filters combine with AND. A record must match every filter you send.
  • Date ranges include the start and exclude the end. A record matches when start <= created_at < end. Send timestamps in ISO 8601, in UTC.

Pagination​

Use limit and offset to page through results:

FieldDescription
limitRecords per page. The maximum is 500; a larger value returns 500 records.
offsetNumber of records to skip.

Results are ordered newest first, unless the endpoint guide says otherwise. To read every page, increase offset by limit until a page returns fewer than limit records.

Some endpoints also return a total count of matching records, in an <name>_aggregate.aggregate.count field. Counting takes longer when there are many records. If you don't need the total, send "withCount": false where the endpoint supports it.

caution

New records can arrive while you page through results, which moves records between pages. For a complete export, set endDate to a time in the past.

Responses​

A successful response is 200 OK. The response is a JSON object keyed by the record type, such as pba_transactions or recon_settlements. An empty array means that no records matched.

{
"pba_transactions": [ { "transaction_id": "…" } ],
"pba_transactions_aggregate": { "aggregate": { "count": 1 } }
}

Fields with no value are returned as null, not left out.

Errors​

StatusMeaning
400The request body is invalid, for example a filter with the wrong type or a missing required filter.
401The access token is missing, invalid or expired.
403The access token does not have the required scope.
500Unexpected error. Retry with backoff.

A 400 response describes the problem:

{
"code": "validation-failed",
"error": "expecting a value for non-nullable variable: \"statuses\"",
"path": "$"
}

GraphQL endpoint​

Each endpoint above is built on a GraphQL query, shown at the end of its guide. The fields you send in the request body fill in that query.

To fetch only the fields you need, or to combine data in one request, send your own query to POST /v1/reporting/graphql. It returns up to 500 records per request.

FieldTypeDescription
querystringRequired. The GraphQL query.
variablesobjectVariable values, if the query declares variables.
operationNamestringThe operation to run, if query contains more than one.
Request
{
"query": "query Accounts($refs: [String!]) { pba_accounts(where: {tenant_account_ref: {_in: $refs}}) { account_id status devices { secure_device_wallet_id } } }",
"variables": { "refs": ["ACC-20031"] }
}
Response
{
"data": {
"pba_accounts": [
{
"account_id": "9f8e7d6c-5b4a-4321-8fed-cba987654321",
"status": "active",
"devices": [ { "secure_device_wallet_id": "sdw_01J9Z0Q4X3" } ]
}
]
}
}

A GraphQL error returns an errors array, with each entry's message and extensions.code.

Start from a query in the guides, then remove the fields you don't need. For integrations you depend on, prefer the endpoints above: data that is only available through GraphQL can change.