Enable/Disable EWA

This endpoint activates or deactivates Earned Wage Access (EWA) for a customer via the Pinwheel integration. When enabling EWA, partners specify the payout frequency (one-time or recurring every paycheck) and the requested wage advance amount. A secure verification code is required to authorize the status change.

Endpoint

POST /api/PinW/set/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 when a customer opts into or out of the Earned Wage Access program. EWA allows employees to access a portion of their earned wages before their regular payday through Pinwheel's payroll integration. Call this endpoint after the customer's payroll account has been linked and they have confirmed their EWA preferences, or when they wish to cancel the service.

Request Body

{
  "active": true,
  "frequency": 2,
  "ewaAmount": 10000,
  "oneTimeCode": "847392",
  "secureOperationType": "ShortMessageCode"
}

Response

200 OK

Returns a plain string confirmation message indicating the result of the EWA status update.

"EWA status updated successfully."

Error Codes

Common Mistakes

• Submitting frequency or ewaAmount when setting active to false — these fields are only meaningful when enabling EWA and will be ignored or may cause unexpected behavior.
• Using an integer value other than 1 or 2 for frequency — the enum only accepts 1 (One-Time) or 2 (Every Paycheck).
• Omitting oneTimeCode or secureOperationType when the customer's account requires secure operation verification for EWA changes.
• Providing ewaAmount as a dollar value instead of cents — the field is in cents (e.g., 10000 = $100.00).
• Calling this endpoint before the customer's payroll account has been successfully linked via Pinwheel.

Related Endpoints

• POST /api/auth/v2 — Obtain a Bearer token for authentication
• POST /api/auth/refresh — Refresh an expiring Bearer token
• GET /api/PinW/get/earnedWageAccess — Retrieve the current EWA status and settings for a customer

Example

curl -X POST https://api.banking.netevia.dev/api/PinW/set/earnedWageAccess \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "active": true,
    "frequency": 2,
    "ewaAmount": 10000,
    "oneTimeCode": "847392",
    "secureOperationType": "ShortMessageCode"
  }'