The Payflow Public API is a comprehensive RESTful API that enables companies to integrate with Payflow's earned wage access (EWA) platform. The API provides functionality for employee management, payment processing, flexible wage advance calculations, and administrative operations.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"52263847","collectionId":"d205a55f-edf5-4d53-94f9-722bfffa8205","publishedId":"2sBXcBm26H","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-12T09:26:32.000Z"},"item":[{"name":"Auth & Health","item":[{"name":"Health Check","id":"09023090-17f6-4740-8288-65ec489dc892","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api-public.payflow.es/health-check","description":"Performs a health check on the system. There is no request body for this endpoint, and the response body is expected to be empty.
\n","urlObject":{"path":["health-check"],"host":["https://api-public.payflow.es"],"query":[],"variable":[]}},"response":[{"id":"4535f3e6-bc30-489f-b6c7-77a236a7dd59","name":"Service available","originalRequest":{"method":"GET","header":[],"url":"https://api-public.payflow.es/health-check"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"09023090-17f6-4740-8288-65ec489dc892"},{"name":"Test API Key","id":"bce351e3-e035-4101-9b3b-b902608727a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/test","description":"Validates the current authentication credentials and returns the associated company name. The request body must be an empty JSON object ({}).
Upon successful request, the response will have the following structure:
\ncompany [string]: The name of your company
status [string]: Fixed value to confirm the key is valid
Essential endpoints for testing connectivity and authentication.
\n","_postman_id":"6dae0971-0bdc-4bf3-a029-ec3971362dfe","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}}},{"name":"Company","item":[{"name":"Read Company Details","id":"1149951f-cf18-42ad-86a4-a99234140d44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/company","description":"Retrieves company information including all subsidiaries and settings.
\nid [number]: Internal company ID
createdAt [string]: Company creation date (ISO string)
name [string]: Company display name
legalName [string]: Company legal name
taxId [string]: Company CIF
billingAddress [string]: Company billing address
settings [object]: Company configuration settings
[array]: Array of cutoff days for payment cyclessubsidiaries [array]: List of company subsidiaries
id [number]: Subsidiary ID
createdAt [string]: Subsidiary creation date (ISO string)
name [string]: Subsidiary display name
legalName [string]: Subsidiary legal name
taxId [string]: Company CIF
billingAddress [string]: Subsidiary billing address
subsidiaryCode [string]: Internal subsidiary code
technicalIssuesEmails [array, optional]: Email addresses for technical notifications
sendSFTPNotifications [boolean]: Whether SFTP notifications are enabled
Read-only access to company details and configuration.
\nThis collection retrieves information about the company associated with the API key, including its subsidiaries, settings, and technical contact details.
\nReturned settings may include Payflow-specific configurations such as the cutoff date for salary periods, whether to send SFTP notifications, and the list of email addresses for technical contacts.
\n","_postman_id":"3fc40174-f479-4a5f-a5d3-100734c245a4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}}},{"name":"Employee","item":[{"name":"Employee","id":"9a5a75c8-eb8a-48e8-ae03-705925df1853","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/employee?id=","description":"Retrieves employee data by specified query param. Either personalId, payrollId or id must be provided.
\nUpon a successful request, the response will have the following structure:
\nid [integer]: Employee ID in Payflow
payrollId [string, null]: Employee ID in your payroll software
firstName [string]: Employee first name
lastName [string]: Employee last name
documentType [string, null]: Employee document type. Possible values: DNI, NIE, CODICE_FISCALE, C_CIUDADANIA, C_EXTRANJERIA, PASSPORT, PEP
personalId [string]: Employee document number
bankAccountNumber [string, null]: Employee bank account number
bankAccountType [string, null]: Employee bank account type. Possible values: checking, savings, maestra
iban [string, null]: (Europe only) Employee IBAN
bic_swift [string, null]: Employee bank SWIFT code
bankEntity [string, null]: Employee bank name
grossSalary [number, null]: Employee salary before taxes
netSalary [number, null]: Employee salary after taxes
paymentFrequency [string]: Employee salary time unit. Possible values: yearly, monthly, twiceAMonth
availableAmount [integer]: Amount of salary available for withdrawal
restrictedAmount [integer]: Amount of salary not available for withdrawal
startDate [string]: Employee contract start date (YYYY-MM-DD)
contractEnd [string, null]: Employee contract end date (YYYY-MM-DD)
email [string, null]: Employee email address
address [string, null]: Employee address
phone [string, null]: Employee phone number
status [string]: Employee status in Payflow. Possible values: active, on_leave, inactive, incomplete, deleted]
subsidiary [integer, null]: Subsidiary ID where the employee belongs
subsidiaryTaxId [string, null]: Subsidiary tax ID
subsidiaryCode [string, null]: Subsidiary ID in your payroll software
active [boolean]: Whether the employee has an active Payflow account
counter [integer]: Employee failed login attempts
agreedTyC [boolean]: Whether the employee has accepted Payflow's T&C
lastLearnflowUse [string, null]: Employee last Learnflow use (YYYY-MM-DD)
Employee ID in Payflow
\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"Employee ID in your payroll software
\n","type":"text/plain"},"key":"payrollId","value":""},{"disabled":true,"description":{"content":"Employee document number
\n","type":"text/plain"},"key":"personalId","value":""}],"variable":[]}},"response":[{"id":"b0722ecf-b22e-4f42-b45b-2244ac0ae2f8","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/employee?id=1","protocol":"https","host":["api-public","payflow","es"],"path":["employee"],"query":[{"key":"id","value":"1","description":"Employee ID in Payflow"},{"key":"payrollId","value":null,"disabled":true},{"key":"personalId","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1,\n \"payrollId\": \"Emp01\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"documentType\": null,\n \"personalId\": \"12345678A\",\n \"bankAccountNumber\": null,\n \"bankAccountType\": null,\n \"iban\": \"ES0000000000000000000000\",\n \"bic_swift\": null,\n \"bankEntity\": null,\n \"grossSalary\": null,\n \"netSalary\": 1500,\n \"paymentFrequency\": \"monthly\",\n \"availableAmount\": 0,\n \"restrictedAmount\": 0,\n \"startDate\": \"2020-06-30\",\n \"contractEnd\": null,\n \"email\": \"john.doe@payflow.es\",\n \"address\": \"Employee Adress\",\n \"phone\": null,\n \"status\": \"active\",\n \"subsidiary\": 1,\n \"subsidiaryTaxId\": \"A00000000\",\n \"subsidiaryCode\": \"01\",\n \"active\": false,\n \"counter\": 0,\n \"agreedTyC\": true,\n \"lastLearnflowUse\": null\n }\n}"},{"id":"109cb9d3-21f4-4645-9d16-98ce9d30cfa6","name":"Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/employee?id=10","protocol":"https","host":["api-public","payflow","es"],"path":["employee"],"query":[{"key":"id","value":"10","description":"Id of the employee in Payflow"},{"key":"payrollId","value":"","description":"Id of the employee in your payroll software","disabled":true},{"key":"personalId","value":"","description":"Document number of the employee","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Employee not found with options: {\\\"id\\\":10}\"\n}"}],"_postman_id":"9a5a75c8-eb8a-48e8-ae03-705925df1853"},{"name":"All Employees","id":"8b5c1417-91e4-4726-859d-51e512b2d92e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/employees","description":"[DEPRECATED – Use v1.1 Instead] Retrieves data for all employees within the company.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["employees"],"host":["https://api-public.payflow.es"],"query":[],"variable":[]}},"response":[{"id":"8e101cd0-0a61-4ce4-94f8-44ecf15cfdb4","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://api-public.payflow.es/employees"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"payrollId\": \"Emp01\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"documentType\": null,\n \"personalId\": \"12345678A\",\n \"bankAccountNumber\": null,\n \"bankAccountType\": null,\n \"iban\": \"ES0000000000000000000000\",\n \"bic_swift\": null,\n \"bankEntity\": null,\n \"grossSalary\": null,\n \"netSalary\": 1500,\n \"paymentFrequency\": \"monthly\",\n \"availableAmount\": 0,\n \"restrictedAmount\": 0,\n \"startDate\": \"2020-06-30\",\n \"contractEnd\": null,\n \"email\": \"john.doe@payflow.es\",\n \"address\": \"Employee Adress\",\n \"phone\": null,\n \"status\": \"active\",\n \"subsidiary\": 1,\n \"subsidiaryTaxId\": \"A00000000\",\n \"subsidiaryCode\": \"01\",\n \"active\": false,\n \"counter\": 0,\n \"agreedTyC\": true,\n \"lastLearnflowUse\": null\n }\n ],\n \"total\": 1\n}"}],"_postman_id":"8b5c1417-91e4-4726-859d-51e512b2d92e"},{"name":"All Employees [V1.1]","id":"891dc121-e2f8-48a2-ba44-76c107779f2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-version","value":"1.1","description":"API version. Use 1.1 for pagination.
\n","type":"text"}],"url":"https://api-public.payflow.es/employees?offset=&limit=","description":"Retrieves data for all employees within the company, with pagination support. Offset and limit query parameters are required.
\nUpon a successful request, the response will have the following structure:
\ndata [array] : List of employee records
\nid [number] : Employee's internal ID
payrollId [string] : Employee's payroll ID
firstName [string] : Employee's first name
lastName [string] : Employee's last name
documentType [string, null] : Type of identification document
personalId [string] : Employee's identification document number
bankAccountNumber [string, null] : Bank account number
bankAccountType [string, null] : Type of bank account
iban [string, null] : (Europe only) Employee IBAN
bic_swift [string, null]: Employee bank SWIFT code
bankEntity [string, null]: Employee bank name
grossSalary [number, null]: Employee salary before taxes
netSalary [number, null]: Employee salary after taxes
paymentFrequency [string]: Employee salary time unit. Possible values: yearly, monthly, twiceAMonth
availableAmount [integer]: Amount of salary available for withdrawal
restrictedAmount [integer]: Amount of salary not available for withdrawal
startDate [string]: Employee contract start date (YYYY-MM-DD)
contractEnd [string, null]: Employee contract end date (YYYY-MM-DD)
email [string, null]: Employee email address
address [string, null]: Employee address
phone [string, null]: Employee phone number
status [string]: Employee status in Payflow. Possible values: active, on_leave, inactive, incomplete, deleted]
subsidiary [integer, null]: Subsidiary ID where the employee belongs
subsidiaryTaxId [string, null]: Subsidiary tax ID
subsidiaryCode [string, null]: Subsidiary ID in your payroll software
active [boolean]: Whether the employee has an active Payflow account
counter [integer]: Employee failed login attempts
agreedTyC [boolean]: Whether the employee has accepted Payflow's T&C
lastLearnflowUse [string, null]: Employee last Learnflow use (YYYY-MM-DD)
Index of the first record to return
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"Maximum number of records to return
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"ea8eec74-0d58-4680-ade8-19e9ae35bb8d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"api-version","value":"1.1","type":"text"}],"url":{"raw":"https://api-public.payflow.es/employees?offset=0&limit=50","protocol":"https","host":["api-public","payflow","es"],"path":["employees"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"payrollId\": \"Emp01\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"documentType\": null,\n \"personalId\": \"12345678A\",\n \"bankAccountNumber\": null,\n \"bankAccountType\": null,\n \"iban\": \"ES0000000000000000000000\",\n \"bic_swift\": null,\n \"bankEntity\": null,\n \"grossSalary\": null,\n \"netSalary\": 1500,\n \"paymentFrequency\": \"monthly\",\n \"availableAmount\": 0,\n \"restrictedAmount\": 0,\n \"startDate\": \"2020-06-30\",\n \"contractEnd\": null,\n \"email\": \"john.doe@payflow.es\",\n \"address\": \"Employee Adress\",\n \"phone\": null,\n \"status\": \"active\",\n \"subsidiary\": 1,\n \"subsidiaryTaxId\": \"A00000000\",\n \"subsidiaryCode\": \"01\",\n \"active\": false,\n \"counter\": 0,\n \"agreedTyC\": true,\n \"lastLearnflowUse\": null\n }\n ],\n \"total\": 1\n}"}],"_postman_id":"891dc121-e2f8-48a2-ba44-76c107779f2a"},{"name":"Employee","id":"95f6f61d-16db-4863-a537-f15fa0322fac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"Emp02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"documentType\": \"DNI\",\n \"personalId\": \"12345678B\",\n \"bankAccountType\": \"savings\",\n \"iban\": \"ES0000000000000000000000\",\n \"bic_swift\": \"swift code\",\n \"bankEntity\": \"bank name\",\n \"grossSalary\": 1500,\n \"paymentFrequency\": \"monthly\",\n \"restrictedAmount\": 0,\n \"startDate\": \"2025-06-01\",\n \"contractEnd\": \"2028-06-01\",\n \"email\": \"jane.doe@payflow.es\",\n \"address\": \"Employee address\",\n \"phone\": \"+34 600 00 00 00\",\n \"status\": \"active\",\n \"subsidiary\": \"1\",\n \"subsidiaryCode\": \"01\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee","description":"\n\n⚠️ BEST PRACTICE
\n\n
\n- Use POST /employees for bulk employee creation/updates.
\n- It is more efficient, consistent, and reduces validation errors.
\n- Use this endpoint only for specific cases.
\n
It is mandatory to specify which subsidiary the employee belongs to. This can be done by providing either the subsidiary (CIF) or the subsidiaryId (the company's internal code).
\nYou must specify grossSalary or netSalary, but not both. If only grossSalary is provided, netSalary will be calculated. If netSalary is provided, grossSalary will be ignored.
\nIt is important that if grossSalary is provided, netSalary should not be sent (do not send it as 0€).
\nThe frequency of all salaries must be monthly.
\nIf you are integrating the flexible compensation benefit, you must send the gross salary.
\nIf you don’t want to use/update a field, simply omit it from the payload.
\nnull, \"\", or 0 to “disable” a field — this often causes unexpected validation errors.Mandatory fields*
\npersonalId* [string]: Valid identification document number (will be validated)
firstName* [string, null]: Employee complete first name (maximum 100 characters)
lastName* [string, null]: Employee complete last name (maximum 100 characters)
payrollId [string, null]: Employee ID in your payroll software
email* [string, null] [required if no phone]: Valid employee email address (maximum 100 characters, cannot be generic, must be unique). Invalid emails will be nullified
phone* [string, null] [required if no email]: Valid employee phone number (cannot be generic, must be unique). Invalid phones will be nullified
iban* [string, null]: Valid employee IBAN for salary payments (will be validated). Invalid IBANs will be nullified
grossSalary* [number, null]: Employee salary before taxes (must be positive number, 0 allowed, defaults to null). Important: If grossSalary is lower than €1,400, the employee will not be able to use the card and it will be frozen
netSalary* [number, null]: Employee net salary (must be a positive number).
grossSalary is provided, omit netSalary from the payload — do not send it as 0€.status* [string]: Employee status (defaults to 'active'). Possible values: active, inactive, on_leave, deleted
subsidiary*[number|string, null]: Subsidiary CIF/tax code
bankAccountNumber [string, null]: Employee bank account number. Invalid values will be nullified
bic_swift [string, null]: Bank BIC/SWIFT code (maximum 100 characters)
bankEntity [string, null]: Bank name (maximum 100 characters)
bankAccountType [string, null]: Employee bank account type. Possible values: checking, savings, maestra
documentType [string, null]: Type of identification document. Possible values: DNI, NIE
address [string, null]: Employee home address
restrictedAmount [number, null]: Restricted amount (must be positive number, 0 allowed, defaults to null)
availableAmount [number, null]: Available amount (must be positive number, 0 allowed, defaults to null)
paymentFrequency [string]: Employee salary time unit (defaults to 'monthly'). Possible values: yearly, monthly, twiceAMonth
startDate [string, null]: Employee contract start date in YYYY-MM-DD format
contractEnd [string, null]: Contract end date in YYYY-MM-DD format (can be empty string, defaults to null)
leaveEnd [string, null]: Leave end date in YYYY-MM-DD format (defaults to null)
subsidiaryCode [string|number, null]: Subsidiary internal code (defaults to null)
Important Validation Notes:
\nInvalid email, phone, IBAN, or bankAccountNumber values will be automatically nullified
\nAt least one contact method (email OR phone) must be valid and provided
\nDates must be in YYYY-MM-DD format
\nDuplicate employee data will result in a 409 Conflict error
\nUpon a successful request, the response will have the following structure:
\n[number] : The ID of the newly created employee in PayflowAPI version. Use 1.1 for better performance.
\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"payrollId\": \"Emp02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"documentType\": \"DNI\",\n \"personalId\": \"12345678Z\",\n \"bankAccountType\": \"savings\",\n \"iban\": \"ES0000000000000000000000\",\n \"bic_swift\": \"swift code\",\n \"bankEntity\": \"bank name\",\n \"grossSalary\": 1500,\n \"paymentFrequency\": \"monthly\",\n \"restrictedAmount\": 0,\n \"startDate\": \"2025-06-01\",\n \"contractEnd\": \"2028-06-01\",\n \"email\": \"jane.doe@payflow.es\",\n \"address\": \"Employee address\",\n \"phone\": \"+34 600 00 00 00\",\n \"status\": \"active\",\n \"subsidiary\": \"1\",\n \"subsidiaryCode\": \"01\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employees","description":"Creates or updates employees in bulk.
\nAll validations from POST /employee apply to each employee in the payload — for example, you must specify either grossSalary or netSalary, but not both.
Invalid records will not trigger a 4xx error — instead, an error element will be included in the response. An empty array means all employees were processed successfully.
Set the api-version header to v1.1 for improved performance and stability
Use this endpoint for all batch employee creations and updates
\nSend employees in batches of up to 50 for optimal performance
\nThe maximum batch size is 500 employees. To sync more, make multiple sequential calls
\nIf you don’t want to use/update a field, simply omit it from the payload.
\nImplement a retry mechanism to ensure the integration succeeds if there is a failure during processing
\nMandatory fields*
\nArray of employee objects with the following structure (max 500, recommended 50 per batch):
\npersonalId* [string, null]: Valid identification document number (maximum 100 characters, will be validated)
firstName* [string, null]: Employee complete first name (maximum 100 characters)
lastName* [string, null]: Employee complete last name (maximum 100 characters)
payrollId [string, null]: Employee ID in your payroll software
documentType [string, null]: Type of identification document
grossSalary* [number|string, null]: Employee salary before taxes (must be positive number, defaults to null). If grossSalary is lower than €1,400, the employee will not be able to use the card and it will be frozen
netSalary* [number|string, null]: Employee net salary (must be positive number).
email* [string, null] [required if no phone]: Valid employee email address (cannot be generic, must be unique). Invalid emails will be nullified
phone* [string, null] [required if no email]: Valid employee phone number (cannot be generic, must be unique). Invalid phones will be nullified
iban* [string, null]: Valid employee IBAN for salary payments. Invalid IBANs will be nullified
subsidiary* [number|string, null]: Subsidiary ID or code
subsidiaryCode* [string, null]: Subsidiary code
restrictedAmount [number, null]: Restricted amount (must be positive number, 0 allowed, defaults to null)
availableAmount [number|string, null]: Available amount for withdrawal
paymentFrequency [string, null]: Employee salary time unit. Possible values: yearly, monthly, twiceAMonth
bankAccountNumber [string, null]: Employee bank account number. Invalid values will be nullified
bankAccountType [string, null]: Employee bank account type. Possible values: checking, savings, maestra
bic_swift [string, null]: Bank BIC/SWIFT code
bankEntity [string, null]: Bank name
address [string, null]: Employee home address
startDate [string, null]: Employee contract start date (YYYY-MM-DD)
status [string, null]: Employee status. Possible values: active, inactive, on_leave, deleted
contractEnd [string, null]: Contract end date (YYYY-MM-DD)
leaveEnd [string, null]: Leave end date (YYYY-MM-DD)
flexflowEnabled [boolean, null]: Whether flexflow is enabled for employee
At least one contact method (email OR phone) must be provided and valid for each employee
\nAll employee data must be unique (no duplicates within the request or with existing employees)
\npersonalId is required for each employee
\nInvalid email, phone, IBAN, or bankAccountNumber values will be automatically nullified
\nUpon successful processing, the response will have the following structure:
\nid [number] : Employee ID in Payflow
personalId [string] : Employee's personal ID
payrollId [string] : Employee ID in your payroll software
action [string] : Action performed (\"created\" or \"updated\")
Import a File from a payroll software into Payflow.
\nEmployees in the file are processed the same way as in POST /employees: existing records are updated, new ones are created, and all standard validation rules apply.
Upon a successful request, the response will have the following structure:
\nrowsProcessed [number] : Total number of employees successfully created or updated
warningRows [array] : Rows that were processed but had non-critical issues
rowNumber [number] : Row number in the original file
message [string] : Warning description
data [object] : Original row data that caused the warning
Payroll file format type
\n","type":"text/plain"},"type":"any","value":"","key":"type"}]}},"response":[{"id":"751d9ccd-378b-4322-978e-166a14f9affb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","type":"text"}],"body":{"mode":"file","file":{"src":"/Users/haroldbravo/Downloads/payflow.csv"}},"url":{"raw":"https://api-public.payflow.es/employees/file/:type","protocol":"https","host":["api-public","payflow","es"],"path":["employees","file",":type"],"variable":[{"key":"type","value":"payflow","description":"Payroll file format type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"rowsProcessed\": 2,\n \"warningRows\": [],\n \"invalidRows\": []\n}"},{"id":"e7abf4a8-7975-47f4-81c3-f652a803a550","name":"File with invalid rows","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","type":"text"}],"body":{"mode":"file","file":{"src":"/Users/haroldbravo/Downloads/payflow.csv"}},"url":{"raw":"https://api-public.payflow.es/employees/file/:type","protocol":"https","host":["api-public","payflow","es"],"path":["employees","file",":type"],"variable":[{"key":"type","value":"payflow","description":"Payroll file format type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"rowsProcessed\": 0,\n \"warningRows\": [],\n \"invalidRows\": [\n {\n \"error\": {\n \"_original\": {\n \"payrollId\": \"12345678B\",\n \"firstName\": \"Josh\",\n \"lastName\": \"Doe\",\n \"netSalary\": 950,\n \"paymentFrequency\": \"monthly\",\n \"status\": \"active\",\n \"personalId\": \"12345678B\",\n \"iban\": \"ES0000000000000000000000\",\n \"startDate\": \"2025-05-02\",\n \"rowNumber\": 1\n },\n \"details\": [\n {\n \"message\": \"Employee with personalId 12345678B already exists in another company\",\n \"path\": [\n \"personalId\"\n ],\n \"type\": \"identifier.already.in.use\",\n \"context\": {}\n }\n ]\n },\n \"rowNumber\": 1\n }\n ]\n}"}],"_postman_id":"dc5c1c89-dc98-4138-9c6d-f063ab3032dd"},{"name":"Employee by Personal ID","id":"2fce75dc-f869-4d6f-bdfa-c73fd7bc807b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"E02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"iban\": \"ES0000000000000000001111\",\n \"grossSalary\": 1450,\n \"contractEnd\": \"2030-06-01\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee/:personalId","description":"Updates the information of a specific employee by Personal ID (DNI/NIE). You can update any combination of the fields below - only the fields you include in the request will be modified.
\nIf you want to update the grossSalary or netSalary, remember that if netSalary is provided, grossSalary will be ignored. It is important that if grossSalary is provided, netSalary should not be sent (do not send it as 0€).
\nFor updating multiple employees at once, use POST /employees
firstName [string, null]: Employee complete first name (maximum 100 characters)
lastName [string, null]: Employee complete last name (maximum 100 characters)
payrollId [string, null]: Employee ID in your payroll software (maximum 100 characters)
personalId [string, null]: Identification document number (maximum 100 characters)
documentType [string, null]: Type of identification document. Possible values: DNI, NIE, CODICE_FISCALE, C_CIUDADANIA, C_EXTRANJERIA, PASSPORT, PEP
email [string, null]: Valid employee email address (maximum 100 characters). Invalid emails will be nullified
phone [string, null]: Valid employee phone number (5-25 characters). Invalid phones will be nullified
address [string, null]: Employee home address (maximum 256 characters)
iban [string, null]: Valid employee IBAN for salary payments (will be validated and automatically normalized). Invalid IBANs will be nullified
bankAccountNumber [string, null]: Employee bank account number (5-50 characters). Invalid values will be nullified
bic_swift [string, null]: Bank BIC/SWIFT code (maximum 100 characters)
bankEntity [string, null]: Bank name (maximum 100 characters)
bankAccountType [string, null]: Employee bank account type. Possible values: checking, savings, maestra
netSalary [number, null]: Employee net salary (must be positive number, 0 allowed). If grossSalary is provided, do not send netSalary as 0€
grossSalary [number, null]: Employee salary before taxes (must be positive number, 0 allowed). If grossSalary is lower than €1400, the employee will not be able to use the card and it will be frozen
restrictedAmount [number, null]: Restricted amount (must be positive number)
availableAmount [number, null]: Available amount for withdrawal (must be positive number)
paymentFrequency [string]: Employee salary time unit (defaults to 'monthly'). Possible values: yearly, monthly, twiceAMonth
startDate [string, null]: Employee contract start date in YYYY-MM-DD format
contractEnd [string, null]: Contract end date in YYYY-MM-DD format (can be empty string)
leaveEnd [string, null]: Leave end date in YYYY-MM-DD format (can be empty string)
status [string, null]: Employee status. Possible values: active, inactive, on_leave, deleted
flexflowEnabled [boolean, null]: Whether flexflow is enabled for employee
subsidiary [number|string, null]: Subsidiary ID (positive number) or code
subsidiaryCode [string|number, null]: Subsidiary internal code (maximum 30 characters or positive number)
Important Notes:
\nAll fields are optional - you only need to include the fields you want to update
\nInvalid email, phone, IBAN, or bankAccountNumber values will be automatically nullified instead of causing validation errors
\nIf you specify a subsidiary that doesn't exist, returns 400 error with message about subsidiary not being associated
\nUpon a successful request, returns an empty response body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["employee",":personalId"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"58bbcdd4-13ff-4b40-96c1-76d7e0ebcc8c","description":{"content":"Employee document number
\n","type":"text/plain"},"type":"any","value":"","key":"personalId"}]}},"response":[{"id":"6b76199c-da0c-4cd2-9f47-5e6b3a4d8599","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"E02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"iban\": \"ES0000000000000000001111\",\n \"grossSalary\": 1450,\n \"contractEnd\": \"2030-06-01\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-public.payflow.es/employee/:personalId","host":["https://api-public.payflow.es"],"path":["employee",":personalId"],"variable":[{"key":"personalId","value":"12345678Z","description":"Employee document number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"aeb18abc-2e8f-4d54-ab95-9b8658dcc6c6","name":"Employee not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"E02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"iban\": \"ES0000000000000000001111\",\n \"grossSalary\": 1450,\n \"contractEnd\": \"2030-06-01\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-public.payflow.es/employee/:personalId","protocol":"https","host":["api-public","payflow","es"],"path":["employee",":personalId"],"variable":[{"key":"personalId","value":"12345678Y","description":"Employee document number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2fce75dc-f869-4d6f-bdfa-c73fd7bc807b"},{"name":"Employee by Payflow ID","id":"21b68501-0dc1-41d0-9a88-7c1ca6fbfa71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"E02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"iban\": \"ES0000000000000000001111\",\n \"grossSalary\": 1450,\n \"contractEnd\": \"2030-06-01\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee/id/:payflowId","description":"Updates the information of a specific employee by internal Payflow ID. You can update any combination of the fields below - only the fields you include in the request will be modified.
\nIf you want to update the grossSalary or netSalary, remember that if netSalary is provided, grossSalary will be ignored. It is important that if grossSalary is provided, netSalary should not be sent (do not send it as 0€).
\nFor updating multiple employees at once, use POST /employees
firstName [string, null]: Employee complete first name (maximum 100 characters)
lastName [string, null]: Employee complete last name (maximum 100 characters)
payrollId [string, null]: Employee ID in your payroll software (maximum 100 characters)
personalId [string, null]: Identification document number (maximum 100 characters)
documentType [string, null]: Type of identification document. Possible values: DNI, NIE, CODICE_FISCALE, C_CIUDADANIA, C_EXTRANJERIA, PASSPORT, PEP
email [string, null]: Valid employee email address (maximum 100 characters). Invalid emails will be nullified
phone [string, null]: Valid employee phone number (5-25 characters). Invalid phones will be nullified
address [string, null]: Employee home address (maximum 256 characters)
iban [string, null]: Valid employee IBAN for salary payments (will be validated and automatically normalized). Invalid IBANs will be nullified
bankAccountNumber [string, null]: Employee bank account number (5-50 characters). Invalid values will be nullified
bic_swift [string, null]: Bank BIC/SWIFT code (maximum 100 characters)
bankEntity [string, null]: Bank name (maximum 100 characters)
bankAccountType [string, null]: Employee bank account type. Possible values: checking, savings, maestra
netSalary [number, null]: Employee net salary (must be positive number, 0 allowed). If grossSalary is provided, do not send netSalary as 0€
grossSalary [number, null]: Employee salary before taxes (must be positive number, 0 allowed). If grossSalary is lower than €1400, the employee will not be able to use the card and it will be frozen
restrictedAmount [number, null]: Restricted amount (must be positive number)
availableAmount [number, null]: Available amount for withdrawal (must be positive number)
paymentFrequency [string]: Employee salary time unit (defaults to 'monthly'). Possible values: yearly, monthly, twiceAMonth
startDate [string, null]: Employee contract start date in YYYY-MM-DD format
contractEnd [string, null]: Contract end date in YYYY-MM-DD format (can be empty string)
leaveEnd [string, null]: Leave end date in YYYY-MM-DD format (can be empty string)
status [string, null]: Employee status. Possible values: active, inactive, on_leave, deleted
flexflowEnabled [boolean, null]: Whether flexflow is enabled for employee
subsidiary [number|string, null]: Subsidiary ID (positive number) or code
subsidiaryCode [string|number, null]: Subsidiary internal code (maximum 30 characters or positive number)
Important Notes:
\nAll fields are optional - you only need to include the fields you want to update
\nInvalid email, phone, IBAN, or bankAccountNumber values will be automatically nullified instead of causing validation errors
\nIf you specify a subsidiary that doesn't exist, returns 400 error with message about subsidiary not being associated
\nUpon a successful request, returns an empty response body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["employee","id",":payflowId"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"329244b5-f22b-4a69-ac31-75d146a6a6fa","description":{"content":"Employee ID in Payflow
\n","type":"text/plain"},"type":"any","value":"","key":"payflowId"}]}},"response":[{"id":"7d141fa2-002b-4374-97b7-c3d4e8b8cf7b","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"E02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"iban\": \"ES0000000000000000001111\",\n \"grossSalary\": 1450,\n \"contractEnd\": \"2030-06-01\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-public.payflow.es/employee/id/:payflowId","protocol":"https","host":["api-public","payflow","es"],"path":["employee","id",":payflowId"],"variable":[{"key":"payflowId","value":"2","description":"Employee ID in Payflow"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"c230b4d3-63c2-48ac-b43d-3daa7cb67d8f","name":"Employee not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"E02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"iban\": \"ES0000000000000000001111\",\n \"grossSalary\": 1450,\n \"contractEnd\": \"2030-06-01\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-public.payflow.es/employee/id/:payflowId","protocol":"https","host":["api-public","payflow","es"],"path":["employee","id",":payflowId"],"variable":[{"key":"payflowId","value":"10","description":"Employee ID in Payflow"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"21b68501-0dc1-41d0-9a88-7c1ca6fbfa71"},{"name":"Employee by Payroll ID","id":"4e1af59f-6998-4fdc-bba0-f438d0b42c2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"E02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"iban\": \"ES0000000000000000001111\",\n \"grossSalary\": 1450,\n \"contractEnd\": \"2030-06-01\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee/payroll/:payrollId","description":"Updates the information of a specific employee by Payroll ID. You can update any combination of the fields below - only the fields you include in the request will be modified.
\nIf you want to update the grossSalary or netSalary, remember that if netSalary is provided, grossSalary will be ignored. It is important that if grossSalary is provided, netSalary should not be sent (do not send it as 0€).
\nFor updating multiple employees at once, use POST /employees
firstName [string, null]: Employee complete first name (maximum 100 characters)
lastName [string, null]: Employee complete last name (maximum 100 characters)
payrollId [string, null]: Employee ID in your payroll software (maximum 100 characters)
personalId [string, null]: Identification document number (maximum 100 characters)
documentType [string, null]: Type of identification document. Possible values: DNI, NIE, CODICE_FISCALE, C_CIUDADANIA, C_EXTRANJERIA, PASSPORT, PEP
email [string, null]: Valid employee email address (maximum 100 characters). Invalid emails will be nullified
phone [string, null]: Valid employee phone number (5-25 characters). Invalid phones will be nullified
address [string, null]: Employee home address (maximum 256 characters)
iban [string, null]: Valid employee IBAN for salary payments (will be validated and automatically normalized). Invalid IBANs will be nullified
bankAccountNumber [string, null]: Employee bank account number (5-50 characters). Invalid values will be nullified
bic_swift [string, null]: Bank BIC/SWIFT code (maximum 100 characters)
bankEntity [string, null]: Bank name (maximum 100 characters)
bankAccountType [string, null]: Employee bank account type. Possible values: checking, savings, maestra
netSalary [number, null]: Employee net salary (must be positive number, 0 allowed). If grossSalary is provided, do not send netSalary as 0€
grossSalary [number, null]: Employee salary before taxes (must be positive number, 0 allowed). If grossSalary is lower than €1400, the employee will not be able to use the card and it will be frozen
restrictedAmount [number, null]: Restricted amount (must be positive number)
availableAmount [number, null]: Available amount for withdrawal (must be positive number)
paymentFrequency [string]: Employee salary time unit (defaults to 'monthly'). Possible values: yearly, monthly, twiceAMonth
startDate [string, null]: Employee contract start date in YYYY-MM-DD format
contractEnd [string, null]: Contract end date in YYYY-MM-DD format (can be empty string)
leaveEnd [string, null]: Leave end date in YYYY-MM-DD format (can be empty string)
status [string, null]: Employee status. Possible values: active, inactive, on_leave, deleted
flexflowEnabled [boolean, null]: Whether flexflow is enabled for employee
subsidiary [number|string, null]: Subsidiary ID (positive number) or code
subsidiaryCode [string|number, null]: Subsidiary internal code (maximum 30 characters or positive number)
Important Notes:
\nAll fields are optional - you only need to include the fields you want to update
\nInvalid email, phone, IBAN, or bankAccountNumber values will be automatically nullified instead of causing validation errors
\nIf you specify a subsidiary that doesn't exist, returns 400 error with message about subsidiary not being associated
\nUpon a successful request, returns an empty response body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["employee","payroll",":payrollId"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"5203d00e-5542-484e-bfec-dcf7aa871892","description":{"content":"Employee ID in your payroll software
\n","type":"text/plain"},"type":"any","value":"","key":"payrollId"}]}},"response":[{"id":"2edd1d9a-796d-4bce-af64-04defa21f358","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"E02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"iban\": \"ES0000000000000000001111\",\n \"grossSalary\": 1450,\n \"contractEnd\": \"2030-06-01\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-public.payflow.es/employee/payroll/:payrollId","protocol":"https","host":["api-public","payflow","es"],"path":["employee","payroll",":payrollId"],"variable":[{"key":"payrollId","value":"2","description":"Employee ID in your payroll software"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"3c471c30-9051-4635-bdea-e266d845b188","name":"Employee not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"payrollId\": \"E02\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"iban\": \"ES0000000000000000001111\",\n \"grossSalary\": 1450,\n \"contractEnd\": \"2030-06-01\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-public.payflow.es/employee/payroll/:payrollId","protocol":"https","host":["api-public","payflow","es"],"path":["employee","payroll",":payrollId"],"variable":[{"key":"payrollId","value":"10","description":"Employee ID in your payroll software"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4e1af59f-6998-4fdc-bba0-f438d0b42c2f"},{"name":"Employee by Personal ID","id":"4c44a556-b323-4ba7-9671-7caaaf43e553","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api-public.payflow.es/employee/:personalId","description":"Soft delete from our system, aimed to remove employees that have been loaded into the system by mistake.
\nIf the employee is no longer working at the company, please refer to status inactive and use the PUT method here
\nIf the employee is on temporary leave, please refer to the endpoint here
\nNo request body required.
\nUpon successful deletion, returns an empty response body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["employee",":personalId"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"b53abf09-df21-47d5-bcd1-2868b289eaaa","description":{"content":"Employee document number
\n","type":"text/plain"},"type":"any","value":"","key":"personalId"}]}},"response":[{"id":"9e553f48-8e9c-4888-b8f0-07e7f52ae887","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:personalId","protocol":"https","host":["api-public","payflow","es"],"path":["employee",":personalId"],"variable":[{"key":"personalId","value":"12345678A","description":"Employee document number"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"693f2f27-8940-4312-9362-e6e328e4e492","name":"Not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:personalId","protocol":"https","host":["api-public","payflow","es"],"path":["employee",":personalId"],"variable":[{"key":"personalId","value":"12345678Y","description":"Employee document number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4c44a556-b323-4ba7-9671-7caaaf43e553"},{"name":"Employee by Payflow ID","id":"95454cf7-0bcb-4f21-a198-7fd2e4903e31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api-public.payflow.es/employee/id/:payflowId","description":"Soft delete from our system, aimed to remove employees that have been loaded into the system by mistake.
\nIf the employee is no longer working at the company, please refer to status inactive and use the PUT method here
\nIf the employee is on temporary leave, please refer to the endpoint here
\nNo request body required.
\nUpon successful deletion, returns an empty response body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["employee","id",":payflowId"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"7ec1a12d-007f-44b0-8172-c32904b333c1","description":{"content":"Employee ID in Payflow
\n","type":"text/plain"},"type":"any","value":"","key":"payflowId"}]}},"response":[{"id":"33168e21-a05d-43ab-9a1b-6c6d2a6e95a2","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/id/:payflowId","protocol":"https","host":["api-public","payflow","es"],"path":["employee","id",":payflowId"],"variable":[{"key":"payflowId","value":"1","description":"Employee ID in Payflow"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"51940069-a645-40aa-aea4-0dcf209e4d59","name":"Not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/id/:payflowId","protocol":"https","host":["api-public","payflow","es"],"path":["employee","id",":payflowId"],"variable":[{"key":"payflowId","value":"10","description":"Employee ID in Payflow"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"95454cf7-0bcb-4f21-a198-7fd2e4903e31"},{"name":"Employee by Payroll ID","id":"fabf4831-75c4-43b8-b105-f5b9fbce1b68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api-public.payflow.es/employee/payroll/:payrollId","description":"Soft delete from our system, aimed to remove employees that have been loaded into the system by mistake.
\nIf the employee is no longer working at the company, please refer to status inactive and use the PUT method here
\nIf the employee is on temporary leave, please refer to the endpoint here
\nNo request body required.
\nUpon successful deletion, returns an empty response body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["employee","payroll",":payrollId"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"54e8396a-961e-47aa-8f60-4a4493dfbed1","description":{"content":"Employee ID in your payroll software
\n","type":"text/plain"},"type":"any","value":"","key":"payrollId"}]}},"response":[{"id":"a845d5e6-66a2-48a5-b8f2-0a87e677d449","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/payroll/:payrollId","protocol":"https","host":["api-public","payflow","es"],"path":["employee","payroll",":payrollId"],"variable":[{"key":"payrollId","value":"Emp01","description":"Employee ID in your payroll software"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"73b9ce65-2443-4981-811e-a187444b7226","name":"Not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/payroll/:payrollId","protocol":"https","host":["api-public","payflow","es"],"path":["employee","payroll",":payrollId"],"variable":[{"key":"payrollId","value":"Emp10","description":"Employee ID in your payroll software"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fabf4831-75c4-43b8-b105-f5b9fbce1b68"}],"id":"74ee3e97-58d1-4d73-93be-56f985307b2e","description":"Provides complete CRUD operations for employee management.
\nAn employee is the end user of the Payflow platform. Each employee must have a unique personal identifier (e.g., a document number) and basic income-related information.
\nEmployees can be in one of the following statuses, reflecting their current relationship with the company and their access to Payflow:
\nactive: The employee is currently working at the company, has valid data, and is allowed to use Payflow.
Note: This does not necessarily mean they have registered or logged into the platform.
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’s record is missing key information (e.g., 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.
Retrieves all employees currently in the on_leave status.
Upon a successful request, the response will have the following structure:
\nid [number]: Employee's internal ID
personalId [string]: Employee's identification document number
payrollId [string]: Employee's payroll ID
iban [string]: International Bank Account Number
bankAccountNumber [string, null]: Bank account number
documentType [string, null]: Type of identification document
bankAccountType [string, null]: Type of bank account
bic_swift [string, null]: Bank name (derived from BIC/SWIFT code)
bankEntity [string, null]: Bank entity name (derived from BIC/SWIFT code)
firstName [string]: Employee's first name
lastName [string]: Employee's last name
paymentFrequency [string]: Payment frequency (e.g., \"monthly\")
netSalary [number]: Employee's net salary
grossSalary [number]: Employee's gross salary
availableAmount [number, null]: Currently available amount for withdrawal
restrictedAmount [number, null]: Restricted amount
startDate [string]: Employee's start date (YYYY-MM-DD)
contractEnd [string, null]: Contract end date (YYYY-MM-DD)
email [string, null]: Employee's email address
address [string, null]: Employee's address
phone [string, null]: Employee's phone number
status [string]: Employee status
subsidiary [number, null]: Subsidiary ID
subsidiaryTaxId [string, null]: Subsidiary tax identification
subsidiaryCode [string, null]: Subsidiary code
active [boolean]: Whether employee is active
counter [number]: Internal counter
agreedTyC [boolean]: Whether employee agreed to Terms & Conditions
lastLearnflowUse [Date, null]: Last time employee used Learnflow
Creates a temporary leave for a specific employee, starting immediately and lasting until the provided endDate.
You must include one of the following identifiers in the request body: personalId, payrollId, or id(Payflow ID).
Only one identifier should be provided to avoid ambiguity.
\nendDate [string] [required]: End date of the leave (ISO format: YYYY-MM-DD)
id [number] [optional]: Employee's Payflow internal ID
payrollId [string] [optional]: Employee's ID in your payroll software
personalId [string] [optional]: Employee's identification document number
Upon successful creation, returns an empty response body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["employee","leave"],"host":["https://api-public.payflow.es"],"query":[],"variable":[]}},"response":[{"id":"f6e10886-ce83-4179-ba9e-ee987bb8cf69","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalId\": \"12345678A\",\n \"endDate\": \"2025-06-30\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee/leave"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{}"},{"id":"286b181f-5061-4cf3-9cb8-93ca7314b128","name":"Employee Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 10,\n \"endDate\": \"2025-06-30\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee/leave"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"a6b7a873-1783-4067-98dd-f5b22f12512b"},{"name":"Employee Leave","id":"44949278-25aa-44b6-968b-17772a792785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api-public.payflow.es/employee/:personalId/leave","description":"Cancels the leave for the specified employee using their personalId.
The employee will be reactivated immediately.
\nNo request body required.
\nUpon successful deletion, returns an empty response body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["employee",":personalId","leave"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"eb562949-1a80-4eee-b97f-7b6834bea654","description":{"content":"Employee document number
\n","type":"text/plain"},"type":"any","value":"","key":"personalId"}]}},"response":[{"id":"8de93fe3-8bcf-4e5f-a1c0-30275b5905cc","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:personalId/leave","protocol":"https","host":["api-public","payflow","es"],"path":["employee",":personalId","leave"],"variable":[{"key":"personalId","value":"12345678A","description":"Employee document number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"9010ee03-7334-4b5e-9415-f5e257b57162","name":"Employee is not on leave","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:personalId/leave","protocol":"https","host":["api-public","payflow","es"],"path":["employee",":personalId","leave"],"variable":[{"key":"personalId","value":"12345678B","description":"Employee document number"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Employee was not on leave at the moment\"\n}"}],"_postman_id":"44949278-25aa-44b6-968b-17772a792785"}],"id":"49782228-debd-4381-ab42-39fdddef6223","description":"Leave requests are used to manage employees that are temporarily away from work. While on leave, employees cannot access Payflow — they will not be able to make withdrawals.
\nLeaves are a useful way to temporarily disable employee access without permanently inactivating their account.
\nNote: Payflow does not support specifying full leave periods. You may only define a leave end date, which will automatically re-enable the employee once the leave ends.
\n","_postman_id":"49782228-debd-4381-ab42-39fdddef6223","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}}},{"name":"Payments","item":[{"name":"Company payments","id":"dc342b8c-7e97-4009-a0fc-592bc7c4b696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/payments?start=&end=&cycle=&convoluted=&status","description":"Retrieves all salary advance payments (withdrawals of earned salary) requested by employees during a specified period or cycle.
\nBy default, the endpoint will return processing and processed payments. For a specific status or statuses, leverage the status query param – for multiple values, the query should be send as status=A&status=B&status=C
If both startDate/endDate and cycle are provided, the cycle takes precedence.
If the convoluted query parameter is set to true, the response format changes (see example).
Convoluted payments group all payments per employee within the company and include:
\nTotal amount requested during the period
\nFirst payment made and its request timestamp
\nLast payment made and its request timestamp
\nAll related payment IDs
\nNote: The informedToIntegration field in the response can be ignored. As integrations are being migrated to microservices, this value is always false for newer systems.
id [string] : Payment identifier
user [string] : Employee's personal ID
userPayrollId [string] : Employee's payroll ID
amount [number] : Payment amount
fee [number] : Processing fee
status [string] : Payment status (e.g., \"processed\")
paid [boolean] : Whether payment has been processed
requestedAt [string] : When payment was requested (ISO string)
paidAt [string] : When payment was processed (ISO string)
message [string, null] : Optional message
informedToIntegration [boolean] : Whether payment was acknowledged via API
data [array]: List of aggregated payment records per employee
id [string] : Payment identifier
user [string] : Employee's personal ID
userPayrollId [string] : Employee's payroll ID
amount [number] : Total aggregated amount for all payments
fee [number] : Total aggregated fees for all payments
informedToIntegration [boolean] : Whether all payments were acknowledged via API
paid [boolean] : Overall payment status
firstTransactionRequestedAt [string] : Earliest request date among all payments
lastTransactionRequestedAt [string] : Latest request date among all payments
firstTransactionPaidAt [string] : Earliest payment date among all payments
lastTransactionPaidAt [string] : Latest payment date among all payments
Start date for filtering payments (YYYY-MM-DD)
\n","type":"text/plain"},"key":"start","value":""},{"description":{"content":"End date for filtering payments (YYYY-MM-DD)
\n","type":"text/plain"},"key":"end","value":""},{"description":{"content":"Payment cycle to filter results by month (YYYY-MM)
\n","type":"text/plain"},"key":"cycle","value":""},{"description":{"content":"If true, payments are returned in a convoluted format
\n","type":"text/plain"},"key":"convoluted","value":""},{"description":{"content":"Payment status or statuses to include
\n","type":"text/plain"},"key":"status","value":null}],"variable":[]}},"response":[{"id":"1f4fdbfb-23fa-490d-998d-ef384fed1d91","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments?start=2025-06-01&end=2025-06-30","protocol":"https","host":["api-public","payflow","es"],"path":["payments"],"query":[{"key":"start","value":"2025-06-01","description":"Start date for filtering payments (YYYY-MM-DD)"},{"key":"end","value":"2025-06-30","description":"End date for filtering payments (YYYY-MM-DD)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"aAa0AaAaAa\",\n \"user\": \"12345678A\",\n \"userPayrollId\": \"Emp01\",\n \"amount\": 50,\n \"fee\": 0,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-06-01T09:00:00.000Z\",\n \"paidAt\": \"2025-06-01T09:01:00.000Z\",\n \"message\": null,\n \"informedToIntegration\": false\n },\n {\n \"id\": \"A01aaAaaAA\",\n \"user\": \"12345678A\",\n \"userPayrollId\": \"Emp01\",\n \"amount\": 100,\n \"fee\": 0,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-06-02T00:00:00.000Z\",\n \"paidAt\": \"2025-06-02T00:01:00.000Z\",\n \"message\": null,\n \"informedToIntegration\": false\n },\n {\n \"id\": \"aaA0aaaA0a\",\n \"user\": \"12345678B\",\n \"userPayrollId\": \"Emp02\",\n \"amount\": 120,\n \"fee\": 0,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-06-04T00:01:01.000Z\",\n \"paidAt\": \"2025-06-04T00:02:00.000Z\",\n \"message\": null,\n \"informedToIntegration\": false\n }\n ]\n}"},{"id":"1fa1714e-352c-4740-91ad-631341d544bb","name":"Success (Convoluted)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments?start=2025-06-01&end=2025-06-30&convoluted=true","protocol":"https","host":["api-public","payflow","es"],"path":["payments"],"query":[{"key":"start","value":"2025-06-01","description":"Start date for filtering payments (YYYY-MM-DD)"},{"key":"end","value":"2025-06-30","description":"End date for filtering payments (YYYY-MM-DD)"},{"key":"convoluted","value":"true","description":"If true, payments are returned in a convoluted format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ids\": [\n \"aAa0AaAaAa\",\n \"A01aaAaaAA\"\n ],\n \"user\": \"12345678A\",\n \"userPayrollId\": \"Emp01\",\n \"amount\": 150,\n \"fee\": 0,\n \"informedToIntegration\": false,\n \"paid\": true,\n \"firstTransactionRequestedAt\": \"2025-06-01T09:00:00.000Z\",\n \"lastTransactionRequestedAt\": \"2025-06-02T00:00:00.000Z\",\n \"firstTransactionPaidAt\": \"2025-06-01T09:01:00.000Z\",\n \"lastTransactionPaidAt\": \"2025-06-02T00:01:00.000Z\"\n },\n {\n \"ids\": [\n \"aaA0aaaA0a\"\n ],\n \"user\": \"12345678B\",\n \"userPayrollId\": \"Emp02\",\n \"amount\": 120,\n \"fee\": 0,\n \"informedToIntegration\": false,\n \"paid\": true,\n \"firstTransactionRequestedAt\": \"2025-06-04T00:01:01.000Z\",\n \"lastTransactionRequestedAt\": \"2025-06-04T00:01:01.000Z\",\n \"firstTransactionPaidAt\": \"2025-06-04T00:02:00.000Z\",\n \"lastTransactionPaidAt\": \"2025-06-04T00:02:00.000Z\"\n }\n ]\n}"}],"_postman_id":"dc342b8c-7e97-4009-a0fc-592bc7c4b696"},{"name":"Employee payments","id":"dcf9bb57-15fb-48d9-9550-6d84b96f059e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/payments/:personalId?start=&end=&cycle=","description":"Retrieves all salary advance payments (withdrawals of earned salary) requested by a specific employee during a given period or cycle.
\nIf both startDate/endDate and cycle params are provided, the cycle takes precedence.
\n\nNote: The
\ninformedToIntegrationfield in the response can be ignored. As integrations are being migrated to microservices, this value will always befalsefor newer systems.
id [string] : Payment identifier
user [string] : Employee's personal ID
userPayrollId [string] : Employee's payroll ID
amount [number] : Payment amount
fee [number] : Processing fee
status [string] : Payment status (e.g., \"processed\")
paid [boolean] : Whether payment has been processed
requestedAt [string] : When payment was requested (ISO string)
paidAt [string] : When payment was processed (ISO string)
message [string, null] : Optional message
informedToIntegration [boolean] : Whether payment was acknowledged via API
Start date for filtering payments (YYYY-MM-DD)
\n","type":"text/plain"},"key":"start","value":""},{"description":{"content":"End date for filtering payments (YYYY-MM-DD)
\n","type":"text/plain"},"key":"end","value":""},{"description":{"content":"Payment cycle to filter results by month (YYYY-MM)
\n","type":"text/plain"},"key":"cycle","value":""}],"variable":[{"id":"eb444ab1-13a2-4afe-a4d1-2a2f1a412d04","description":{"content":"Employee document number
\n","type":"text/plain"},"type":"any","value":"","key":"personalId"}]}},"response":[{"id":"074fc7a4-52dc-4de3-a328-d338f57509f4","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments/:personalId?start=2025-05-05&end=2025-06-05&status=processed","protocol":"https","host":["api-public","payflow","es"],"path":["payments",":personalId"],"query":[{"key":"start","value":"2025-05-05","description":"Start date for filtering payments (YYYY-MM-DD)"},{"key":"end","value":"2025-06-05","description":"End date for filtering payments (YYYY-MM-DD)"},{"key":"status","value":"processed","description":"Payment status to filter results"}],"variable":[{"key":"personalId","value":"12345678Z","description":"Employee document number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"AaAAAA01aa\",\n \"user\": \"12345678Z\",\n \"userPayrollId\": \"Emp01\",\n \"amount\": 250,\n \"fee\": 0,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-05-05T09:00:00.000Z\",\n \"paidAt\": \"2025-05-05T09:01:00.000Z\",\n \"message\": null,\n \"informedToIntegration\": false\n }\n ]\n}"},{"id":"6a0ba2be-f538-4bbb-b20e-61a4fdf11c39","name":"Employee not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments/:personalId?start=2025-05-05&end=2025-06-05&status=processed","protocol":"https","host":["api-public","payflow","es"],"path":["payments",":personalId"],"query":[{"key":"start","value":"2025-05-05","description":"Start date for filtering payments (YYYY-MM-DD)"},{"key":"end","value":"2025-06-05","description":"End date for filtering payments (YYYY-MM-DD)"},{"key":"status","value":"processed","description":"Payment status to filter results"}],"variable":[{"key":"personalId","value":"12345678Y","description":"Employee document number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"dcf9bb57-15fb-48d9-9550-6d84b96f059e"},{"name":"Payment by Id","id":"c7cc8468-3a1f-4b60-94c2-cb3a1919748c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/payment/:id","description":"Retrieves a payment by specific identifier.
\n\n\nNote: The
\ninformedToIntegrationfield in the response can be ignored. As integrations are being migrated to microservices, this value will always befalsefor newer systems.
id [string] : Payment identifier
user [string] : Employee's personal ID
userPayrollId [string] : Employee's payroll ID
amount [number] : Payment amount
fee [number] : Processing fee
status [string] : Payment status (e.g., \"processed\")
paid [boolean] : Whether payment has been processed
requestedAt [string] : When payment was requested (ISO string)
paidAt [string] : When payment was processed (ISO string)
message [string, null] : Optional message
informedToIntegration [boolean] : Whether payment was acknowledged via API
Payment identifier
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4523cc5b-de6f-46a5-b467-a1e3641ce92f","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payment/:id","protocol":"https","host":["api-public","payflow","es"],"path":["payment",":id"],"variable":[{"key":"id","value":"AaAAAA01aa","description":"Payment identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"AaAAAA01aa\",\n \"user\": \"12345678Z\",\n \"userPayrollId\": \"Emp01\",\n \"amount\": 250,\n \"fee\": 0,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-05-05T09:00:00.000Z\",\n \"paidAt\": \"2025-05-05T09:01:00.000Z\",\n \"message\": null,\n \"informedToIntegration\": false\n }\n}"},{"id":"52abdb48-de00-4a76-9714-b15a5792dbb3","name":"Payment not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payment/:id","protocol":"https","host":["api-public","payflow","es"],"path":["payment",":id"],"variable":[{"key":"id","value":"Bbb0BbBAb0","description":"Payment identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c7cc8468-3a1f-4b60-94c2-cb3a1919748c"},{"name":"Payments File","id":"a75b175c-7be1-4b5c-80fe-f91535a09a68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/payments/file/:paymentCycle?format=","description":"Retrieves all payments requested by employees in the company during a specified period, formatted as a specific payroll file.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["payments","file",":paymentCycle"],"host":["https://api-public.payflow.es"],"query":[{"description":{"content":"Payroll file format
\n","type":"text/plain"},"key":"format","value":""}],"variable":[{"id":"81972f78-9d4b-4a69-8d2e-14d2fcef123f","description":{"content":"Payment cycle month (YYYY-MM)
\n","type":"text/plain"},"type":"any","value":"","key":"paymentCycle"}]}},"response":[{"id":"73f47dbd-4af7-4a2b-90c8-3ebe7d81c68e","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments/file/:paymentCycle?format=payflow","protocol":"https","host":["api-public","payflow","es"],"path":["payments","file",":paymentCycle"],"query":[{"key":"format","value":"payflow","description":"Payroll file format"}],"variable":[{"key":"paymentCycle","value":"2025-06","description":"Payment cycle month (YYYY-MM)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"},{"key":"Content-Length","value":"7588"},{"key":"content-disposition","value":"attachment;filename=\"Payflow Testing-payflow-liquidacion.xlsx\""},{"key":"accept-ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"PK\u0003\u0004\u0014\u0000\b\u0000\b\u0000�\\�Z\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0013\u0000\u0000\u0000xl/theme/theme1.xml�YM��6\u001a�� xOl�x&3B�\"���n2�`�I��k����H��gƷ\"=.�@�\u000f�R��\u001e\u0016�\u0006h�^��&�Y�f���\u0005IQ\u0016m9�|\u0014Ţ�CbI��~�/I��G\u0017\u0005CgD**x�{W�\u0018\u0011����,��&�+{\u0018)\r<\u0005&8��(�э?\\�H� �`\\E\u0010�\\�2�tT��\u0002�UQ\u0012~Q���\u0005huUȬ�J8�<+Xg����\u0014@9F\u001c\n\u0012�Of3�\u001041\"�\r䥏\u0018)\b���I�\n<1�I�q���g1j��L�3`1>�<\u0015�\u0013r�1b����\u0018w�\u001f��@�;\u0010y\u001aӛ�\r���y����[N�̦�����C=��\u0016�h4\u001a�z\u001e�!�$�{�����ޠ�܄��-\u001a�ݝn��`���n��`0���F5a�w�������\n)\u000e�(;����p�\u001bR\u001c�Qv�)�k���\u0015�����u�I�x�u,A3�n�3����^�3\u001a�\u000eDu\tZE3��Ɗ,ࡐc���2Д#�(�\f\u0012\u0012�!\u0014SI�j��@�Qu/Q���B�\u0012IK\u001d�?��q\u0003����^>�\u0019�|��٣'�\u001e����ϟ=���\u00160o\u0003Ϛ�\u0017?|���>C����\u0017_}�����������\rH�D>���<~��_��ׯ��7%L��\t-�B\u001f�st,\n�m��d*ߐ2Ɂ\u0006\u0014�E�\u001f�f��\u0000��\u0002X+p@�\u0018ޗ����['��k��ٝ�\b��B����a�c�5�?��l�~9o\u0002�\u0001�Z�\u000f�\u0007Y\u001e�˜\u0014u�\u0006q\u001a�$0��\u0001א\u0011N42��)!m.>�4��!M�Pb��\u0003�\u0006@�\u00033�Ӡ���۴\u0000\u0006�V�'9\u0004\u0011:��\u0006���~@�B(�\fX�\u0003\u0013hނ���U�\u0004\n�\f�]�y��'\u000b�4�#�%��0�F)Q���\\\u0004&�\u0001F7T�![\u0014M�w@jz�*�.\bф\u001e��a\u000eE�\n>�\nRetrieves all payments requested by employees in the company during a specified period, formatted as a specific payroll file.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}},"urlObject":{"path":["payments","file"],"host":["https://api-public.payflow.es"],"query":[{"description":{"content":"Payroll file format
\n","type":"text/plain"},"key":"format","value":""},{"description":{"content":"Start date for filtering payments (YYYY-MM-DD)
\n","type":"text/plain"},"key":"start","value":""},{"description":{"content":"End date for filtering payments (YYYY-MM-DD)
\n","type":"text/plain"},"key":"end","value":""}],"variable":[]}},"response":[{"id":"d1ae1291-3782-4b0c-a9bc-413739015c95","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments/file?format=payflow&start=2025-06-01&end=2025-06-31","protocol":"https","host":["api-public","payflow","es"],"path":["payments","file"],"query":[{"key":"format","value":"payflow","description":"Payroll file format"},{"key":"start","value":"2025-06-01","description":"Start date for filtering payments (YYYY-MM-DD)"},{"key":"end","value":"2025-06-31","description":"End date for filtering payments (YYYY-MM-DD)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"},{"key":"Content-Length","value":"7588"},{"key":"content-disposition","value":"attachment;filename=\"Payflow Testing-payflow-liquidacion.xlsx\""},{"key":"accept-ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"PK\u0003\u0004\u0014\u0000\b\u0000\b\u0000�\\�Z\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0013\u0000\u0000\u0000xl/theme/theme1.xml�YM��6\u001a�� xOl�x&3B�\"���n2�`�I��k����H��gƷ\"=.�@�\u000f�R��\u001e\u0016�\u0006h�^��&�Y�f���\u0005IQ\u0016m9�|\u0014Ţ�CbI��~�/I��G\u0017\u0005CgD**x�{W�\u0018\u0011����,��&�+{\u0018)\r<\u0005&8��(�э?\\�H� �`\\E\u0010�\\�2�tT��\u0002�UQ\u0012~Q���\u0005huUȬ�J8�<+Xg����\u0014@9F\u001c\n\u0012�Of3�\u001041\"�\r䥏\u0018)\b���I�\n<1�I�q���g1j��L�3`1>�<\u0015�\u0013r�1b����\u0018w�\u001f��@�;\u0010y\u001aӛ�\r���y����[N�̦�����C=��\u0016�h4\u001a�z\u001e�!�$�{�����ޠ�܄��-\u001a�ݝn��`���n��`0���F5a�w�������\n)\u000e�(;����p�\u001bR\u001c�Qv�)�k���\u0015�����u�I�x�u,A3�n�3����^�3\u001a�\u000eDu\tZE3��Ɗ,ࡐc���2Д#�(�\f\u0012\u0012�!\u0014SI�j��@�Qu/Q���B�\u0012IK\u001d�?��q\u0003����^>�\u0019�|��٣'�\u001e����ϟ=���\u00160o\u0003Ϛ�\u0017?|���>C����\u0017_}�����������\rH�D>���<~��_��ׯ��7%L��\t-�B\u001f�st,\n�m��d*ߐ2Ɂ\u0006\u0014�E�\u001f�f��\u0000��\u0002X+p@�\u0018ޗ����['��k��ٝ�\b��B����a�c�5�?��l�~9o\u0002�\u0001�Z�\u000f�\u0007Y\u001e�˜\u0014u�\u0006q\u001a�$0��\u0001א\u0011N42��)!m.>�4��!M�Pb��\u0003�\u0006@�\u00033�Ӡ���۴\u0000\u0006�V�'9\u0004\u0011:��\u0006���~@�B(�\fX�\u0003\u0013hނ���U�\u0004\n�\f�]�y��'\u000b�4�#�%��0�F)Q���\\\u0004&�\u0001F7T�![\u0014M�w@jz�*�.\bф\u001e��a\u000eE�\n>�\nCreates a salary advance payment request for a specific employee.
\nBefore processing the request, the system verifies that:
\nThe employee has enough available balance, based on days worked and company-specific settings.
\nThe company has sufficient balance to cover the transaction.
\nIf any validation fails, the payment will not be created.
\nImportant: This endpoint must be explicitly enabled by Payflow’s integrations team. If not activated, all requests will be rejected.
\npersonalId [string] [required]: Employee's identification document number
amount [number] [required]: Payment amount to request (minimum: 1)
Upon successful creation:
\nid [number] : Internal payment ID (auto-generated)
identifier [string] : Payment unique identifier
amount [number] : Payment amount
fee [number] : Processing fee
requestedAt [string] : When payment was requested (ISO string)
status [string] : Payment status (e.g., \"pending\")
companyId [number] : Company ID
employeeId [number] : Employee ID
provider [string] : Payment provider (e.g., \"unnax\")
employee [object] : Employee information
id [number] : Employee's internal ID
personalId [string] : Employee's identification document number
payrollId [string] : Employee's payroll ID
firstName [string] : Employee's first name
lastName [string] : Employee's last name
iban [string] : Employee's IBAN
subsidiary [object] : Subsidiary information (if applicable)
id [number] : Subsidiary ID
taxId [string] : Subsidiary tax ID
subsidiaryCode [string] : Subsidiary code
name [string] : Subsidiary name
legalName [string] : Subsidiary legal name
Setup callback for processed payments. This endpoint allows you to configure a URL where Payflow will send notifications when payments are successfully processed.
\n[string]: URL where payment success notifications will be sent (required, must be valid URI)Success (HTTP 200):
\nValidation Error (HTTP 400):
\n[string]: Request ID (JSON string format)Use this endpoint to acknowledge that a payment has been informed to your payroll system.
\nWe recommend calling this endpoint so that Payflow is aware of which payments have been reported on your end, helping ensure easier reconciliation between systems.
\nFor more information, feel free to contact us at integrations@payflow.es.
\n[array]: Array of payment identifiers to mark as informed (minimum: 1 payment)[array] : Array of payment identifiers that were successfully marked as informedRetrieves the amount currently available for an employee to withdraw through Payflow.
\nUse this endpoint to check the up-to-date balance an employee can request based on their worked days and company settings.
\navailable [number] : Available amount for withdrawal (floor value)
amountReason [string|null] : Reason why amount is 0 (null if available > 0)
reducedAmountReason [string|null] : Reason why amount might be reduced (null if available = 0)
maximumSavingsRate [number] : Maximum savings rate for the employee
withdrawn [number] : Total amount already withdrawn in current cycle
remainingSalary [number] : Remaining salary after withdrawals
salaryEarnedInfo [object] : Detailed information about salary earned
Employee document number
\n","type":"text/plain"},"key":"personalId","value":""},{"description":{"content":"Employee ID in your payroll software
\n","type":"text/plain"},"key":"payrollId","value":null},{"description":{"content":"Employee ID in Payflow
\n","type":"text/plain"},"key":"id","value":null}],"variable":[]}},"response":[{"id":"12b726bb-cac9-4a4b-b22f-213d4397f4dc","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments/available?personalId=12345678Z","protocol":"https","host":["api-public","payflow","es"],"path":["payments","available"],"query":[{"key":"personalId","value":"12345678Z","description":"Employee document number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"available\": 514,\n \"amountReason\": null,\n \"reducedAmountReason\": null,\n \"maximumSavingsRate\": 0,\n \"withdrawn\": 0,\n \"remainingSalary\": 1928,\n \"salaryEarnedInfo\": {\n \"dayNumberInCycle\": 8,\n \"numberOfDaysInCycle\": 30,\n \"netSalary\": 1928,\n \"totalEarned\": 514.1333333333333\n }\n}"}],"_postman_id":"c77ed6e8-e369-440d-a9b5-7e18d1576141"}],"id":"27fc0fa0-ba70-41cd-9b05-7d592e1df4f5","description":"A payment represents a money transfer made to an employee. While Payflow strives to process payments as quickly as possible, various factors can cause delays or failures.
\nThis entity provides insight into the status of each payment, indicating whether it has been successfully completed, is still in progress, or has failed.
\nEach payment goes through a lifecycle, represented by the status field:
pending: The payment has been requested but not yet submitted to the bank.
processing: The payment has been submitted to the bank and is awaiting confirmation.
processed: The bank has confirmed that the payment was successfully completed.
canceled: The transaction was canceled by a Payflow user. This is a final state — the payment will not be made.
delayed: The payment has been sent to the bank, but more than 5 minutes have passed without confirmation.
error: The bank reported that the payment could not be processed. This is a final state — the payment will not be made. An additional message field will contain the error details from the bank.
Retrieves the total transaction amounts per category for employees who used their Flexflow cards during the cycle specified in the query parameter.
\nFiltering behavior:
\nIf no taxId is provided: Returns data for all employees in the company
If a taxId is provided: Returns data for employees in that specific subsidiary
If the taxId of the main subsidiary is sent, it will include employees who are not assigned to that subsidiary.
personalId [string] : Employee's identification document number
amount_food [number] : Total amount spent on food category
amount_transport [number] : Total amount spent on transport category
amount_education [number] [optional]: Total amount spent on education category
amount_nursery [number] [optional]: Total amount spent on nursery category
Cycle month in YYYY-MM format
\n","type":"text/plain"},"key":"cycle","value":""},{"disabled":true,"description":{"content":"Subsidiary tax ID
\n","type":"text/plain"},"key":"taxId","value":""},{"disabled":true,"description":{"content":"Index of the first record to return
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Maximum number of records to return
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"5d0d98f5-1d4d-437d-bfd6-71a94cef0733","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/flexflow/amounts?cycle=2025-06&taxId=A00000000","host":["https://api-public.payflow.es"],"path":["flexflow","amounts"],"query":[{"key":"cycle","value":"2025-06","description":"Cycle month in YYYY-MM format"},{"key":"taxId","value":"A00000000","description":"Subsidiary tax ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"personalId\": \"12345678A\",\n \"amount_food\": 100,\n \"amount_transport\": 50,\n \"amount_education\": 0,\n \"amount_nursery\": 0\n }\n ],\n \"meta\": {\n \"total\": 1,\n \"perPage\": 50,\n \"currentPage\": 1,\n \"lastPage\": 1,\n \"cycle\": \"2025-06\"\n }\n}"}],"_postman_id":"356aea9d-b77d-410d-958c-b985bee45ae2"},{"name":"Employee Transaction Amounts","id":"c3403435-69cc-4f0b-8418-8cccc7b6bf5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/flexflow/amounts/employee/:personalId?cycle","description":"Retrieves the total transaction amounts per category for a specific employee during a given cycle.
\npersonalId [string] : Employee's identification document number
amount_food [number] : Total amount spent on food category
amount_transport [number] : Total amount spent on transport category
amount_education [number] [optional]: Total amount spent on education category
amount_nursery [number] [optional]: Total amount spent on nursery category
Cycle month in YYYY-MM format
\n","type":"text/plain"},"key":"cycle","value":null}],"variable":[{"id":"50951337-44b2-4f9f-a454-43643738817d","description":{"content":"Employee's identification document number
\n","type":"text/plain"},"type":"any","value":"","key":"personalId"}]}},"response":[{"id":"7b4f4d32-2fa1-4847-a0bd-e557b1c1ae4e","name":"Employee Transaction Amounts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/flexflow/amounts/employee/:personalId?cycle","host":["https://api-public.payflow.es"],"path":["flexflow","amounts","employee",":personalId"],"query":[{"key":"cycle","value":null,"description":"Cycle month in YYYY-MM format"}],"variable":[{"key":"personalId","value":"12345678K","description":"Employee's identification document number\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"personalId\": \"12345678K\",\n \"amount_food\": 150.50,\n \"amount_transport\": 80.00,\n \"amount_education\": 200.00,\n \"amount_nursery\": 300.00\n}"}],"_postman_id":"c3403435-69cc-4f0b-8418-8cccc7b6bf5f"}],"id":"714cd039-09de-4591-80e6-6d12e8a924ba","description":"Flexflow is Payflow’s Retribución Flexible product, which allows employees to allocate part of their salary toward eligible expenses such as food, transportation, education, nursery, and insurance — all within legal limits.
\nThis collection provides endpoints to retrieve information about employee spending through Flexflow, filtered by specific benefit cycles.
\n","_postman_id":"714cd039-09de-4591-80e6-6d12e8a924ba","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"d205a55f-edf5-4d53-94f9-722bfffa8205","id":"d205a55f-edf5-4d53-94f9-722bfffa8205","name":"Payflow API (EN)","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]}},"event":[{"listen":"prerequest","script":{"id":"5d51bece-3f4e-4ecc-a552-2d6518b9e7ac","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"68c585be-09a5-44d1-a835-85b1315094ad","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseURL","value":"https://api-public.payflow.es","type":"string"},{"key":"apiKey","value":"Your-API-key-here","type":"string"}]}