/api/PinW/directDepositStatus

Get Direct Deposit Status

Retrieves the current direct deposit status for a user's financial account via the Pinwheel (EWA) integration. This endpoint indicates whether direct deposit is currently connected, the financial account it is linked to, and whether a reconnection flow needs to be triggered. Direct deposit statuses must be refreshed every 180 days if no updates have occurred during that period.

Endpoint

GET /api/PinW/directDepositStatus

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 periodically validate that a customer's direct deposit connection is still active. If the response indicates needReconnect: true or connected: false, trigger a reconnection flow to restore direct deposit service. This check is essential for EWA (Earned Wage Access) flows that depend on an active direct deposit connection.

Response

200 OK

Field	Type	Description
`connected`	boolean	Whether direct deposit is currently connected for the user.
`connectedDate`	string (date-time)	ISO 8601 timestamp of when direct deposit was connected.
`financialAccountId`	string	Identifier of the financial account receiving direct deposit. May be null if not connected.
`financialAccountName`	string	Display name of the linked financial account. May be null if not connected.
`last4`	string	Last 4 digits of the account number receiving direct deposit. May be null if not connected.
`allocationType`	integer (enum)	Type of allocation: `1` = Full, `2` = Fixed Amount, `3` = Percentage, `4` = Remainder.
`allocationValue`	integer	The allocation amount or percentage, depending on `allocationType`. Null when full paycheck is deposited.
`needReconnect`	boolean	`true` if the direct deposit connection has expired or needs to be re-established (e.g., after 180 days of inactivity).

{
  "connected": true,
  "connectedDate": "2025-11-15T09:30:00Z",
  "financialAccountId": "fa_XXXXXXXXXX",
  "financialAccountName": "Primary Checking",
  "last4": "4321",
  "allocationType": 1,
  "allocationValue": null,
  "needReconnect": false
}

Error Codes

Code	When it happens
401	Token missing, expired, or invalid
403	Insufficient permissions to access direct deposit status for this user
404	No direct deposit record found for the authenticated user
500	Internal server error

Common Mistakes

Not checking needReconnect — if true, the direct deposit is stale and must be re-established before EWA features will function correctly.
Assuming connected: true means the deposit is actively flowing — always verify connectedDate and needReconnect together to confirm live connectivity.
Ignoring the 180-day refresh requirement — direct deposit status is not permanently cached; re-verify periodically to avoid silent failures in EWA workflows.
Misinterpreting allocationValue as null meaning an error — a null value is expected when allocationType is 1 (Full paycheck deposit).

Related Endpoints

POST /api/PinW/directDeposit — Initiate or update a direct deposit connection via Pinwheel
GET /api/PinW/ewaStatus — Retrieve Earned Wage Access eligibility and status for a user
POST /api/auth/v2 — Obtain a Bearer token for authentication

Example

curl -X GET https://api.banking.netevia.dev/api/PinW/directDepositStatus \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"