Clients with pending notes

Clients with Pending Notes

This endpoint returns the count of customers whose applications are neither approved nor declined — that is, they remain in a pending state. Results can be filtered by agent IDs, ISO ID, and profile IDs. The response provides separate counts for banking and merchant customer types.

Endpoint

POST /api/Widget/pending

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint to populate dashboard widgets or administrative reports that display how many customers are awaiting review or approval. It is particularly useful for partner portals where agents or ISO managers need a real-time snapshot of their pending customer pipeline, broken down by banking and merchant profile types.

Request Body

The request body accepts one of the following schemas. All share the base filter fields (agentsId, isoId, profileIds) and extend them with additional date or status fields depending on the use case.

Base Fields (shared across all request types)

FieldTypeRequiredDescription
agentsIdarray of integerNoList of agent IDs to filter pending customers by. Pass an empty array or omit to include all agents.
isoIdintegerNoISO ID to scope results to a specific ISO organization.
profileIdsarray of integerNoList of profile IDs to restrict results to specific customer profiles.

Extended Fields — widgetrequest variant

FieldTypeRequiredDescription
fromDatestring (date-time)YesStart of the date range (ISO 8601).
toDatestring (date-time)YesEnd of the date range (ISO 8601).

Extended Fields — reportrequest variant

FieldTypeRequiredDescription
reportDatestring (date-time)YesThe single report date for the snapshot.
havePointsbooleanNoFilter to customers who have reward points.
profileTypeintegerNoCustomer profile type. Enum: 1, 2, 3, 4, 5.
applicationStatusstringNoFilter by application status. Enum: New, Submitted, PendingUW, ApprovedUW, Closed, Cancelled, Pending_Review, Denied, Approved, Pending, InReview, AutoApprovedUW.

Extended Fields — widgetreportrequest variant

FieldTypeRequiredDescription
reportDatesarray of string (date-time)YesArray of specific report dates to aggregate counts across.

Extended Fields — balancesrequest variant

FieldTypeRequiredDescription
fromDatestring (date-time)YesStart of the date range (ISO 8601).
toDatestring (date-time)YesEnd of the date range (ISO 8601).
skipintegerNoPagination offset. Default: 0.
limitintegerNoMaximum number of records to return. Default: 100.

Extended Fields — rewardsreportrequest variant

FieldTypeRequiredDescription
reportDatestring (date-time)NoOptional report date to filter rewards data.

Minimal request body example (base filters only):

{
  "agentsId": [101, 102],
  "isoId": 5,
  "profileIds": [201, 202, 203]
}

Widget date-range request example:

{
  "agentsId": [101],
  "isoId": 5,
  "profileIds": [201],
  "fromDate": "2026-01-01T00:00:00Z",
  "toDate": "2026-06-01T00:00:00Z"
}

Response

200 OK

FieldTypeDescription
bankingCountinteger or nullNumber of pending banking customers matching the provided filters.
merchantCountinteger or nullNumber of pending merchant customers matching the provided filters.
{
  "bankingCount": 47,
  "merchantCount": 12
}

Error Codes

CodeWhen it happens
400Missing required fields (e.g., fromDate/toDate omitted for widgetrequest) or validation error in request body
401Token missing, expired, or invalid
403Insufficient permissions to access widget data for the specified agents, ISO, or profiles
404Specified resource (agent, ISO, or profile) not found
500Internal server error

Common Mistakes

  • Omitting fromDate and toDate when using the widgetrequest or balancesrequest schema — both fields are required for those variants.
  • Passing an empty agentsId array expecting it to return no results; an empty or null array means no agent filter is applied and all agents are included.
  • Assuming a null response for bankingCount or merchantCount indicates an error — null values simply mean no matching pending customers were found for that category.
  • Sending reportDates as a single string instead of an array when using the widgetreportrequest variant.
  • Using an applicationStatus value outside the defined enum list, which will result in a 400 validation error.

Related Endpoints

  • POST /api/Widget/approved — Returns the count of customers with approved application status
  • POST /api/Widget/declined — Returns the count of customers with declined application status
  • POST /api/Widget/totalClients — Returns the total count of all customers regardless of status
  • POST /api/Widget/newClients — Returns the count of newly created customer records within a date range

Example

curl -X POST https://api.banking.netevia.dev/api/Widget/pending \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "agentsId": [101, 102],
    "isoId": 5,
    "profileIds": [201, 202],
    "fromDate": "2026-01-01T00:00:00Z",
    "toDate": "2026-06-01T00:00:00Z"
  }'
Body Params
agentsId
array of int32s | null
agentsId
int32 | null
profileIds
array of int32s | null
profileIds
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json