1. Employees
Payflow API
Spain
  • Spain
  • Colombia
  • Peru
  • Guides
    • API Integration guide
  • Definitions
    • Employees
      • Employee Statuses
      • Salary Concepts
    • Payments
      • Payment Lifecycle
  • Explore our Public API
    • Auth & Health
      • Health
      • Test an API Key
    • Company
      • Retrieve your Company Details
    • Employee
      • Retrieve an Employee
      • Retrieve all Employees
      • Retrieve all Employees (V1.1)
      • Create an Employee
      • Upsert Employees in Bulk
      • Update an Employee by Personal ID
      • Update an Employee by Payflow ID
      • Update an Employee by Payroll ID
    • Leaves
      • Retrieve all Employees on Leave
      • Create an Employee Leave
      • Remove an Employee Leave
    • Payments
      • Retrieve a Payment
      • Retrieve all Payments
      • Retrieve Employee Payments
      • Calculate Employee Available Amount
      • Request a Payment
      • Subscribe to Payment Updates
      • Mark Payments as Informed
    • Flexflow
      • Retrieve all Flexflow Transactions
      • Retrieve Employee Flexflow Transactions
  • Notifications Structure
    • Payment Updates
  • Schemas
    • Company
      • Company Response
    • Employee
      • ES | Create Employee Request
      • ES | Update Employee Request
      • ES | Employee Response
      • Create Employee Leave Request
    • Payment
      • Payment Response
      • Payment Response Convoluted
      • Payment Update
    • Flexflow
      • Employee Flexflow Transactions
    • Error
      • Generic Error Response
  1. Employees

Employee Statuses

Employees can be in one of the following statuses, reflecting their current relationship with the company and their access to the Payflow app:
active: The employee is currently working at the company, has valid data, and is allowed to use Payflow.
inactive: The employee is no longer working at the company and is not allowed to use Payflow.
on_leave: The employee is temporarily on leave. They still belong to the company but cannot use Payflow until they return.
incomplete: The employee record is missing required information (such as salary, email, or phone) and cannot be processed until completed.
deleted: The employee was created by mistake and has been removed from the system.
For employees who have left the company, use the inactive status instead.
The active status vs. the active field
An employee can have active status without being registered in the Payflow app.
To check whether an employee has completed the Payflow signup process, verify that the active field is set to true.

Flexible Compensation card behavior#

Employee status also affects the behavior of the Flexible Compensation card:
active: The card remains active and can be used for food and transport transactions until the employee reaches their monthly usage limits.
inactive, on_leave, incomplete: The card is frozen. If the employee is later returned to active status, they can unfreeze the card and continue using it. Otherwise, the card is automatically terminated after three months.
deleted: The card is terminated immediately. If the employee is activated again in the future, a new card must be requested.
Modified at 2026-05-14 17:43:26
Previous
API Integration guide
Next
Salary Concepts
Built with