API enhancements
inactive
was added as a possible value for the status
field in the Employments resource.
Most relevant updates and all breaking changes.
inactive
was added as a possible value for the status
field in the Employments resource.
pay_allocations
were added into accounts.availability, allowing you to see whether the pay allocations objects have been synced or updated for an account.
Link items can now be filtered by greater/less than or equal number of max allocations allowed.
It is now possible to limit the Link items shown to the user with respect to which pay distribution allocation types are defined in the payDistributionConfig
. If you define only the amount_allocation
or percent_allocation
values in the pay-distribution-config
, then only the Link items that support percent or amount allocations will be shown to the user. For more information, please refer to the Argyle Update guide.
A new pay_distribution.error
value was added in the Accounts resource. unsupported_mfa_method
is displayed when the Link item connected by the user does not support updating pay distributions.
The Sandbox environment has been updated to make the testing process easier. Please refer to either the Testing: Console guide for a no-code testing workflow via the Argyle Console, or the Testing: API guide for testing an API integration.
A new optional attribute was added to the pay distribution configs. Setting allow_add_allocation
to false
, reove the Add bank account button in the PD Edit screen.
A new document_id
field was added to /payouts. It contains a unique ID of a document (e.g. paystub) associated with the payout.
The new features
object in link items contain information about direct deposit switching capabilities.
A new flag for Argyle Link configuration was added. closeOnOutsideClick
toggles the closing of Link when a user clicks outside the bounds of the UI element provided by Argyle.
accounts.source
field was added to /v1/accounts. It denotes the source of the account's employment records provided in the Argyle API.