Skip to main content

Configure employee payout rails

Set up bank or mobile-money payout rails for employees via HR API.
Include acting-client headers on product API calls: X-Workspace-Id and X-Acting-Company-Id. See Act as a client.

Prerequisites

  • Employee record exists
Required permissions: hr:employees:write.

Steps

1

Configure payout rail

Use employee payout configuration endpoints under /api/v1/hr/employees/{id} in HR API reference. Required before payroll disbursement.

Tips

  • Rails must match Pay provider capabilities for the company’s country.

first payroll disbursement