Overview
Octoberโs API updates improve payroll import performance, expand transaction visibility, and provide clearer bank-account and state-registration information. Integrations can also specify payroll processing days when creating pay schedules.Highlights
- State-registration guidance: Display readable format examples alongside validation rules.
- Transaction transparency: Retrieve transaction identifiers and payment details for reconciliation and troubleshooting.
- Payroll import performance: Benefit from enhanced processing for synchronous and asynchronous imports where enabled.
- Payroll processing configuration: Specify processing days when creating a pay schedule, with next-day payroll available through production enablement.
Enhancements
State-Registration Format Examples
getStateRegistrationFields now includes an optional expectedFormat array in field metadata. These examples help integrations display readable input guidance alongside existing validationFormat rules.
What to update: Display format examples when available. Continue using validationFormat for validation and support fields where expectedFormat is absent.
Payroll Transaction Transparency and IDs
getPayPeriodDetails provides transaction-level details when includeTransactions is set to true, making payroll payments easier to reconcile and investigate.
Employee and company transaction records include:
payrollTransactionIdto identify individual transactions.parentTransactionIdto link related transactions.requestReferenceIdfor request correlation.- Transaction amounts, statuses, and initiation/update timestamps.
Synchronous and Asynchronous Payroll Import Performance
Payroll import processing has been enhanced with parallel employee processing, batched tax calculations, and shared preparation work that reduces repeated processing. These enhancements support both synchronous and asynchronous regular and differential payroll imports where parallel processing is enabled. Historical payroll imports also support a configuration-controlled parallel processing path. What to update: Continue using the existing import endpoints. UseimportMethod to request synchronous or asynchronous execution for regular and differential imports, subject to feature availability. Parallel processing is enabled separately through Rollfi configuration.
Bank-Account Linking Details in getCompanyInfo
Bank-account records returned by getCompanyInfo now include linkType, helping integrations identify how an account was connected:
ManualPlaidCustomProvider
N/A when linking information cannot be resolved. Bank-account status also reflects a relinking requirement when one is recorded, helping integrations identify accounts that need attention.
What to update: Use linkType to distinguish linking methods and handle relink-related statuses in account recovery workflows.
Set Payroll Processing Days with addPaySchedule
Integrations can supply payrollProcessingWorkingDays when calling addPaySchedule to configure the processing interval for a new pay schedule. This setting is separate from paymentMode, which controls Automatic versus Self-Initiated payroll submission.
Next-day payroll carries an additional customer charge and must be enabled by Rollfi before use in production. Supplying a next-day processing value does not itself enable the service. Please reach out to Rollfi for pricing, eligibility, and production-enablement details.
Notes for Integrators
Recommended Next Steps
- Review transaction and bank-account response handling for the additional fields.
- Add state-registration format examples to your forms where available.
- Contact Rollfi to confirm parallel-import availability or enable next-day payroll in production.
