GuidesAPI ReferenceChangelog
Log In
Changelog
added

Disconnect a payroll account

Added the ability to disconnect a payroll account using POST /v1/accounts/{id}/disconnect. Disconnected payroll accounts have no Recurring Access, e.g., On Demand Updates will no longer work and Monitoring will no longer be performed. All existing data for the account will be retained so it can still be accessed.

deprecated

Deprecate obsolete disconnected and reconnected webhook events

Deprecated the account.disconnected and account.reconnected webhook events. Use account.monitoring_status.updated instead. We are coordinating with customers currently using these webhook events to sunset usage and transition to the new event.

added

Monitoring Status in API Endpoints

  • Modified REST API endpoints:
    • Changed GET /accounts/{account_id} and GET /accounts
      • New monitoring_status in the data field, indicating the ability of Pinwheel to automatically monitor for data changes in the payroll account.
  • New REST API endpoints:
    • Added POST /accounts/{account_id}/disable_monitoring
      • This is a renaming of the POST /accounts/{account_id}/disconnect REST API endpoint. We are coordinating with customers currently using this endpoint to sunset usage and transition to the new endpoint.
added

Account Monitoring Status

Added account.monitoring_status.updated webhook event. It is triggered whenever a payroll account's monitoring status is updated.

improved

React and React Native Package Updates

React (2.3.4) and React Native (2.3.4) packages updated to:

added

Income & Employment Monitoring

I&E Monitoring released in beta. To support this new feature we've made the following modifications to REST API endpoints:

added

New Unpaid Earning Category

Added a new enum value unpaid to earnings category for paystubs and shifts.

added

Platform ID in LinkResult

Added the property platformId to the LinkResult payload sent for a success event from Link.

added

Session Timeout Error Code

Added new error code sessionTimeout. This error occurs when the session closes after a period of inactivity, e.g., due to lack of user action.

added

Direct Deposit Allocation Monitoring

DDA Monitoring released in beta. To support this new feature we've made the following modifications to REST API endpoints and webhook events: