Changelog

A 504 Gateway Timeout can now be returned from Get Wallet Balance if the server is unable to retrieve the balance response in a timely manner.

Invoice Reports provide a daily summary of the invoices associated with an organization. The V1 Invoice Summary provided a snapshot of in-progress data, whereas the V2 Invoice Summary ensures that customers receive complete and finalized data sets, addressing scenarios where invoices span multiple days. The V1 Invoice Summary will be deprecated after 2026-10-31. Organizations can request historical backfill data for the V2 Invoice Summary by providing the org_id and backfill_start_date in an Admin Support ticket.

Setting order_card = true in Create Wallet will now ship Personalized Physical cards upon triggering Wallet Claimed, instead of Wallet Created.

When using Create Employee or Update Employee, a nullable state field can now be supplied. This value will now be returned in the response of Create Employee, Update Employee, Get Employee, and Search Employees. This information is used for configuring and verifying the Worker in an Earned Wage Access integration.

New V2 Update Shift and V2 Delete Shift API endpoints are available, providing CRUD parity with V1 Shift operations.

A additional wallet field is now returned in the PAYMENT_PROFILE_ACTIVATED webhook event when the active_type = WALLET. It contains the account_number and routing_number information for the Worker's wallet. This streamlines integrations by removing the need to call Get Employee Wallet upon receipt of the webhook. Details for implementation are available in the Payment Profile Activated Webhook Reference guide.

The DIRECT_DEPOSIT_CREATED webhook event is sent when a worker submits a Direct Deposit authorization form, providing an accurate trigger for updating account and routing numbers. Details for implementation are available in the Direct Deposit Created Webhook Reference guide.

The INACTIVITY_OVER_TIME reason code value is useful for clearly identifying when a wallet or card is deactivated due to inactivity, which filters out dormancy-driven events to reduce alert noise and unnecessary on-call escalation. This reason code can now be returned in a Wallet Deactivated or Card Deactivated webhook event. Existing webhook integrations will not receive or need to handle this reason code.

Added an App Engagement Reports guide to the White-Label Reports section.

Added TIN Verification Matched and TIN Verification Failed guides. Added sample requests in the Postman Collection for Triggering Sandbox Webhooks