Get Earned Wage Access Status

This endpoint allows a customer to check the availability and conditions of the Earned Wage Access (EWA) service. The response provides details about whether the service is enabled, the maximum amount the customer can withdraw, upcoming pay dates, applicable fees, and the current EWA status. EWA is integrated via Pinwheel and requires an active payroll connection.

Endpoint

GET /api/PinW/earnedWageAccess

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 before initiating an EWA withdrawal to confirm the service is active and to retrieve the current maximum withdrawal amount and next pay dates. This is also useful for displaying EWA eligibility and status information in a customer-facing dashboard. Call this endpoint to check whether a prior EWA request is still in review, has been accepted, or requires repayment.

Response

200 OK

{
  "connectedFinancialAccountId": "XXXXXXXXXX",
  "maxEwaAmount": 50000,
  "nextPayDate": "2024-10-01T00:00:00Z",
  "ewaPayDate": "2024-09-28T00:00:00Z",
  "fee": 5.0,
  "reviewStatus": 2,
  "updateRequestStatusDate": "2024-09-25T14:32:00Z",
  "currentStatus": {
    "isActive": true,
    "frequency": 1,
    "userOwnsMoney": false,
    "ewaAmount": 20000
  }
}

Error Codes

Common Mistakes

• Calling this endpoint without a Pinwheel payroll connection established — EWA requires an active Direct Deposit connection via Pinwheel before the service can be activated.
• Misinterpreting maxEwaAmount and ewaAmount — both values are in cents; divide by 100 to display dollar amounts.
• Ignoring userOwnsMoney — if true, a prior EWA withdrawal has not yet been repaid and a new withdrawal may not be permitted.
• Not checking reviewStatus before attempting a withdrawal — a status of 3 (Rejected) or 4 (Cancelled) means the current EWA request cannot proceed.
• Confusing nextPayDate and ewaPayDate — nextPayDate is the actual payday, while ewaPayDate is when the advance funds are made available (typically a few days earlier).

Related Endpoints

• POST /api/PinW/earnedWageAccess — Submit a new EWA withdrawal request
• POST /api/PinW/connect — Connect a payroll account via Pinwheel to enable EWA
• GET /api/PinW/status — Retrieve overall Pinwheel payroll connection status

Example

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