BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/unmatched-payments
getDashboardAdmin BFF

/bff/dashboard/unmatched-payments

Returns bank transactions not matched to any order. Critical for cash recovery - identifies failed variable symbols, gateway issues, and import errors.

DashboardgetBffDashboardUnmatched-payments

Parameters

1 query

Query parameters

· 1
daysnumberOptional

Number of days to analyze. Defaults to 30.

Default: 30
Example30

Response schema

1 status code documented

200SuccessUnmatched payments analysis.
totalAmountnumberRequired

Total value of unmatched transactions.

transactionCountnumberRequired

Number of unmatched transactions.

agingBucketsobjectRequired

Transactions grouped by age.

todayobjectRequired
amountnumberRequired

Amount received today.

countnumberRequired

Count of transactions today.

thisWeekobjectRequired
amountnumberRequired

Amount received this week.

countnumberRequired

Count of transactions this week.

thisMonthobjectRequired
amountnumberRequired

Amount received this month.

countnumberRequired

Count of transactions this month.

olderobjectRequired
amountnumberRequired

Amount from older transactions.

countnumberRequired

Count of older transactions.

recentTransactionsobject[]Required

Recent unmatched transactions (max 20).

Each array item:
idnumberRequired

Transaction ID.

bankTransactionIdstringRequired

Bank transaction reference.

datestringRequired

Transaction date (YYYY-MM-DD).

amountnumberRequired

Transaction amount.

variableSymbolstringOptional

Variable symbol if present.

accountNamestringOptional

Sender account name.

messagestringOptional

Transaction message.

currencystringRequired

Currency code.

Response example

application/json
{
  "totalAmount": 0,
  "transactionCount": 0,
  "agingBuckets": {
    "today": {
      "amount": 0,
      "count": 0
    },
    "thisWeek": {
      "amount": 0,
      "count": 0
    },
    "thisMonth": {
      "amount": 0,
      "count": 0
    },
    "older": {
      "amount": 0,
      "count": 0
    }
  },
  "recentTransactions": [
    {
      "id": 0,
      "bankTransactionId": "example_bankTransactionId",
      "date": "example_date",
      "amount": 0,
      "variableSymbol": "example_variableSymbol",
      "accountName": "example_accountName",
      "message": "example_message"
    }
  ],
  "currency": "example_currency"
}

Request example

GET /bff/dashboard/unmatched-payments

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/unmatched-payments?days=30" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key