La API Pública de Payflow es una API RESTful integral que permite a las empresas integrarse con la plataforma de acceso a salario bajo demanda (EWA) de Payflow. La API proporciona funcionalidad para gestión de empleados, procesamiento de pagos, cálculos flexibles de anticipos de salario, y operaciones administrativas.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"52263847","collectionId":"0c5cdc83-ea1f-4335-af49-5336d839a289","publishedId":"2sBXcBm26J","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-12T09:29:15.000Z"},"item":[{"name":"Autenticación y Estado del Sistema","item":[{"name":"Verificación de Estado","id":"875bb412-1cf9-43ac-8afa-dfd53f41fdc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api-public.payflow.es/health-check","description":"Realiza una verificación del estado del sistema. No hay cuerpo de solicitud para este endpoint, y se espera que el cuerpo de respuesta esté vacío.
\n","urlObject":{"path":["health-check"],"host":["https://api-public.payflow.es"],"query":[],"variable":[]}},"response":[{"id":"ac1342b4-3160-445c-84a8-761dab5350f0","name":"Servicio disponible","originalRequest":{"method":"GET","header":[],"url":"https://api-public.payflow.es/health-check"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"875bb412-1cf9-43ac-8afa-dfd53f41fdc1"},{"name":"Prueba de API Key","id":"ccb70532-9fa1-474d-adcd-5cb969c8227d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/test","description":"Valida las credenciales de autenticación actuales y devuelve el nombre de la empresa asociada. El cuerpo de la solicitud debe ser un objeto JSON vacío ({}).
En caso de solicitud exitosa, la respuesta tendrá la siguiente estructura:
\ncompany [string]: El nombre de tu empresa
status [string]: Valor fijo para confirmar que la clave es válida
Endpoints esenciales para probar la conectividad y autenticación.
\n","_postman_id":"50963503-2869-42d9-838c-0d1d163f6eb6","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"0c5cdc83-ea1f-4335-af49-5336d839a289","id":"0c5cdc83-ea1f-4335-af49-5336d839a289","name":"Payflow API (CO)","type":"collection"}}},{"name":"Empresa","item":[{"name":"Detalles de Empresa","id":"56f51dcd-1dc7-445a-a763-254203a20595","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/company","description":"Obtiene información de la empresa incluyendo todas las filiales/subsidiarias y configuraciones.
\nid [number]: ID interno de la empresa
createdAt [string]: Fecha de creación de la empresa (cadena ISO)
name [string]: Nombre para mostrar de la empresa
legalName [string]: Razón social de la empresa
taxId [string]: NIT de la empresa
billingAddress [string]: Dirección de facturación de la empresa
settings [object]: Configuraciones de la empresa
[array]: Array de días de corte para ciclos de pagosubsidiaries [array]: Lista de filiales de la empresa
id [number]: ID de la filial
createdAt [string]: Fecha de creación de la filial (cadena ISO)
name [string]: Nombre para mostrar de la filial
legalName [string]: Razón social de la filial
taxId [string]: NIT de la filial
billingAddress [string]: Dirección de facturación de la filial
subsidiaryCode [string]: Código interno de la filial
technicalIssuesEmails [array, opcional]: Direcciones de correo electrónico para notificaciones técnicas
sendSFTPNotifications [boolean]: Si las notificaciones SFTP están habilitadas
Acceso de solo lectura a los detalles y configuración de la empresa.
\nEsta colección obtiene información sobre la empresa asociada con la clave de API, incluyendo sus filiales/subsidiaria, configuraciones y detalles de contacto técnico.
\nLas configuraciones devueltas pueden incluir configuraciones específicas de Payflow como la fecha de corte para períodos salariales, si envia notificaciones SFTP, y la lista de direcciones de correo electrónico para contactos técnicos.
\n","_postman_id":"d3ff59de-03cd-425f-8433-6a014cb6e04a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"0c5cdc83-ea1f-4335-af49-5336d839a289","id":"0c5cdc83-ea1f-4335-af49-5336d839a289","name":"Payflow API (CO)","type":"collection"}}},{"name":"Empleados","item":[{"name":"Empleado","id":"01fca5d3-9377-4faf-a85d-0168506597a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/employee?id=","description":"Busca un empleado por payrollId, personalId (cédula), o ID interno de Payflow.
\nEn caso de solicitud exitosa, la respuesta tendrá la siguiente estructura:
\nid [number]: ID interno en Payflow
personalId [string]: Número de cédula
payrollId [string]: ID en tu sistema de nómina
documentType [string]: Tipo de documento (C_CIUDADANIA, C_EXTRANJERIA, PEP, PASSPORT)
firstName [string]: Nombre
lastName [string]: Apellido
email [string]: Email
phone [string]: Teléfono
bankAccountNumber [string]: Número de cuenta bancaria
bankAccountType [string]: Tipo de cuenta
address [string]: Dirección
netSalary [number]: Salario antes de impuestos
grossSalary [number]: Salario después de impuestos
availableAmount [number]: Monto disponible para retiro
restrictedAmount [number]: Monto restringido
paymentFrequency [string]: Frecuencia de pago
startDate [string]: Fecha de inicio (YYYY-MM-DD)
contractEnd [string, null]: Fecha fin de contrato (YYYY-MM-DD)
status [string]: Estado del empleado
subsidiary [number]: ID de filial
subsidiaryTaxId [string]: NIT
active [boolean]: Cuenta activa
agreedTyC [boolean]: Aceptó términos y condiciones
ID del empleado en Payflow
\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"ID del empleado en tu software de nómina
\n","type":"text/plain"},"key":"payrollId","value":""},{"disabled":true,"description":{"content":"Número de documento del empleado
\n","type":"text/plain"},"key":"personalId","value":""}],"variable":[]}},"response":[{"id":"dd09b3a0-8651-4db3-8a41-34b368d96cd9","name":"Obtener un empleado mediante payflowId","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/employee?payflowId=245","protocol":"https","host":["api-public","payflow","es"],"path":["employee"],"query":[{"key":"payflowId","value":"245","description":"ID del empleado en Payflow"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 245,\n \"personalId\": \"12345678\",\n \"payrollId\": \"001\", \n \"iban\": null,\n \"bankAccountNumber\": \"0123456789\",\n \"documentType\": \"C_CIUDADANIA\",\n \"bankAccountType\": \"checking\",\n \"bic_swift\": null,\n \"bankEntity\": null,\n \"firstName\": \"María\",\n \"lastName\": \"Rodríguez Pérez\",\n \"paymentFrequency\": \"monthly\",\n \"netSalary\": 2800000,\n \"grossSalary\": 3500000,\n \"availableAmount\": 750000,\n \"restrictedAmount\": 0,\n \"startDate\": \"2024-01-15\",\n \"contractEnd\": null,\n \"email\": \"maria.rodriguez@empresa.co\",\n \"address\": \"Carrera 11 #85-32, Apartamento 501, Bogotá D.C.\",\n \"phone\": \"+57301234567\",\n \"status\": \"active\",\n \"subsidiary\": 15,\n \"subsidiaryCode\": \"BOG001\",\n \"subsidiaryTaxId\": \"900123456-7\",\n \"active\": true,\n \"counter\": 0,\n \"agreedTyC\": true,\n \"lastLearnflowUse\": null\n }\n}"},{"id":"e687d077-0fac-4b7d-9451-7722b5b3cc4c","name":"Obtener un empleado mediante personalId","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/employee?personalId=12345678","host":["https://api-public.payflow.es"],"path":["employee"],"query":[{"key":"personalId","value":"12345678","description":"Número de documento del empleado"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 245,\n \"personalId\": \"12345678\",\n \"payrollId\": \"001\", \n \"iban\": null,\n \"bankAccountNumber\": \"0123456789\",\n \"documentType\": \"C_CIUDADANIA\",\n \"bankAccountType\": \"checking\",\n \"bic_swift\": null,\n \"bankEntity\": null,\n \"firstName\": \"María\",\n \"lastName\": \"Rodríguez Pérez\",\n \"paymentFrequency\": \"monthly\",\n \"netSalary\": 2800000,\n \"grossSalary\": 3500000,\n \"availableAmount\": 750000,\n \"restrictedAmount\": 0,\n \"startDate\": \"2024-01-15\",\n \"contractEnd\": null,\n \"email\": \"maria.rodriguez@empresa.co\",\n \"address\": \"Carrera 11 #85-32, Apartamento 501, Bogotá D.C.\",\n \"phone\": \"+57301234567\",\n \"status\": \"active\",\n \"subsidiary\": 15,\n \"subsidiaryCode\": \"BOG001\",\n \"subsidiaryTaxId\": \"900123456-7\",\n \"active\": true,\n \"counter\": 0,\n \"agreedTyC\": true,\n \"lastLearnflowUse\": null\n }\n}"},{"id":"ef32805a-d588-40fa-8f0a-adb8424e01e4","name":"Obtener un empleado mediante payrollId","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Your-API-key-here","type":"text"}],"url":{"raw":"https://api-public.payflow.es/employee?payrollId=00001","host":["https://api-public.payflow.es"],"path":["employee"],"query":[{"key":"payrollId","value":"00001","description":"ID del empleado en tu software de nómina"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 245,\n \"personalId\": \"12345678\",\n \"payrollId\": \"001\", \n \"iban\": null,\n \"bankAccountNumber\": \"0123456789\",\n \"documentType\": \"C_CIUDADANIA\",\n \"bankAccountType\": \"checking\",\n \"bic_swift\": null,\n \"bankEntity\": null,\n \"firstName\": \"María\",\n \"lastName\": \"Rodríguez Pérez\",\n \"paymentFrequency\": \"monthly\",\n \"netSalary\": 2800000,\n \"grossSalary\": 3500000,\n \"availableAmount\": 750000,\n \"restrictedAmount\": 0,\n \"startDate\": \"2024-01-15\",\n \"contractEnd\": null,\n \"email\": \"maria.rodriguez@empresa.co\",\n \"address\": \"Carrera 11 #85-32, Apartamento 501, Bogotá D.C.\",\n \"phone\": \"+57301234567\",\n \"status\": \"active\",\n \"subsidiary\": 15,\n \"subsidiaryCode\": \"BOG001\",\n \"subsidiaryTaxId\": \"900123456-7\",\n \"active\": true,\n \"counter\": 0,\n \"agreedTyC\": true,\n \"lastLearnflowUse\": null\n }\n}"},{"id":"0f5c5cbd-94d6-41ff-9428-21f4ae565633","name":"Intento para obtener un empleado inexistente","originalRequest":{"method":"GET","header":[],"url":"https://api-public.payflow.es/employee"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"01fca5d3-9377-4faf-a85d-0168506597a8"},{"name":"Todos los Empleados","id":"044de41f-77d4-43a8-8d37-ed9aaf1e0a5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/employees","description":"[OBSOLETO – Usa v1.1 en su lugar] Obtiene datos de todos los empleados de la empresa.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"0c5cdc83-ea1f-4335-af49-5336d839a289","id":"0c5cdc83-ea1f-4335-af49-5336d839a289","name":"Payflow API (CO)","type":"collection"}},"urlObject":{"path":["employees"],"host":["https://api-public.payflow.es"],"query":[],"variable":[]}},"response":[{"id":"49db04a4-7f5a-44bc-9b9e-c450193a8845","name":"Retrieve all employees: success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://api-public.payflow.es/employees"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"personalId\": \"1023879512\",\n \"payrollId\": \"001\",\n \"iban\": null,\n \"bankAccountNumber\": \"17469294854\",\n \"documentType\": \"C_CIUDADANIA\",\n \"bankAccountType\": \"savings\",\n \"bic_swift\": \"COMPARTIR\",\n \"firstName\": \"Test\",\n \"paymentFrequency\": \"monthly\",\n \"netSalary\": 920000,\n \"grossSalary\": null,\n \"restrictedAmount\": 0,\n \"startDate\": \"2022-01-01\",\n \"contractEnd\": \"2050-01-01\",\n \"lastName\": \"User Colombia\",\n \"email\": \"test_user_colombia@payflow.co\",\n \"address\": \"Edificio Lievano, Calle 11\",\n \"phone\": \"+573209355775\",\n \"status\": \"active\",\n \"subsidiary\": 1151,\n \"subsidiaryTaxId\": \"B81101373\",\n \"subsidiaryCode\": null,\n \"active\": true,\n \"counter\": 0,\n \"agreedTyC\": false,\n \"lastLearnflowUse\": null\n },\n {\n \"personalId\": \"1023879513\",\n \"payrollId\": \"002\",\n \"iban\": null,\n \"bankAccountNumber\": \"17469294854\",\n \"documentType\": \"C_CIUDADANIA\",\n \"bankAccountType\": \"savings\",\n \"bic_swift\": \"COMPARTIR\",\n \"firstName\": \"Test\",\n \"paymentFrequency\": \"monthly\",\n \"netSalary\": 920000,\n \"grossSalary\": null,\n \"restrictedAmount\": 0,\n \"startDate\": \"2022-01-01\",\n \"contractEnd\": \"2050-01-01\",\n \"lastName\": \"User Colombia\",\n \"email\": \"test_user_colombia2_modified@payflow.co\",\n \"address\": \"Edificio Lievano, Calle 11\",\n \"phone\": \"+573209355775\",\n \"status\": \"active\",\n \"subsidiary\": 1151,\n \"subsidiaryTaxId\": \"B81101373\",\n \"subsidiaryCode\": null,\n \"active\": false,\n \"counter\": 0,\n \"agreedTyC\": false,\n \"lastLearnflowUse\": null\n },\n {\n \"personalId\": \"1023879514\",\n \"payrollId\": \"003\",\n \"iban\": null,\n \"bankAccountNumber\": \"17469294854\",\n \"documentType\": \"C_CIUDADANIA\",\n \"bankAccountType\": \"savings\",\n \"bic_swift\": \"COMPARTIR\",\n \"firstName\": \"Test\",\n \"paymentFrequency\": \"monthly\",\n \"netSalary\": 920000,\n \"grossSalary\": null,\n \"restrictedAmount\": 0,\n \"startDate\": \"2022-01-01\",\n \"contractEnd\": \"2050-01-01\",\n \"lastName\": \"User Colombia\",\n \"email\": \"test_user_colombia10@payflow.co\",\n \"address\": \"Edificio Lievano, Calle 11\",\n \"phone\": \"+573209355775\",\n \"status\": \"active\",\n \"subsidiary\": 1151,\n \"subsidiaryTaxId\": \"B81101373\",\n \"subsidiaryCode\": null,\n \"active\": false,\n \"counter\": 0,\n \"agreedTyC\": false,\n \"lastLearnflowUse\": null\n },\n {\n \"personalId\": \"1023879515\",\n \"payrollId\": \"C04\",\n \"iban\": null,\n \"bankAccountNumber\": \"17469294854\",\n \"documentType\": \"C_CIUDADANIA\",\n \"bankAccountType\": \"savings\",\n \"bic_swift\": \"COMPARTIR\",\n \"firstName\": \"Test\",\n \"paymentFrequency\": \"monthly\",\n \"netSalary\": 920000,\n \"grossSalary\": null,\n \"restrictedAmount\": 0,\n \"startDate\": \"2022-01-01\",\n \"contractEnd\": \"2050-01-01\",\n \"lastName\": \"User Colombia\",\n \"email\": \"test_user_colombia11@payflow.co\",\n \"address\": \"Edificio Lievano, Calle 11\",\n \"phone\": \"+573209355775\",\n \"status\": \"active\",\n \"subsidiary\": 1151,\n \"subsidiaryTaxId\": \"B81101373\",\n \"subsidiaryCode\": null,\n \"active\": false,\n \"counter\": 0,\n \"agreedTyC\": false,\n \"lastLearnflowUse\": null\n }\n ]\n}"}],"_postman_id":"044de41f-77d4-43a8-8d37-ed9aaf1e0a5e"},{"name":"Todos los Empleados [V1.1]","id":"544b0f98-7741-45f8-b607-2c0e6f6c3d85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-version","value":"1.1","description":"API version. Use 1.1 for pagination.
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://api-public.payflow.es/employees?offset=&limit=","description":"Obtiene datos de todos los empleados de la empresa, con soporte de paginación.
\n*Los parámetros offset y limit son obligatorios.
\ndata [array]: Lista de registros de empleados
\nid [number]: ID interno del empleado
payrollId [string]: ID de nómina del empleado
firstName [string]: Nombre del empleado
lastName [string]: Apellido del empleado
documentType [string, null]: Tipo de documento de identificación
personalId [string]: Número de documento de identificación del empleado
bankAccountNumber [string, null]: Número de cuenta bancaria (20 dígitos)
bankAccountType [string, null]: Tipo de cuenta bancaria
iban [null]: Siempre null
bic_swift [string, null]: Código SWIFT del banco del empleado
bankEntity [string, null]: Nombre del banco del empleado (ej., \"Bancolombia\", \"Davivienda\")
grossSalary [number, null]: Salario del empleado antes de impuestos
netSalary [number, null]: Salario del empleado después de impuestos
paymentFrequency [string]: Frecuencia de pago del empleado. Valores posibles: yearly, monthly, twiceAMonth
availableAmount [integer]: Monto de salario disponible para retiro
restrictedAmount [integer]: Monto de salario no disponible para retiro
startDate [string]: Fecha de inicio de contrato del empleado (YYYY-MM-DD)
contractEnd [string, null]: Fecha de fin de contrato del empleado (YYYY-MM-DD)
email [string, null]: Dirección de email del empleado
address [string, null]: Dirección del empleado
phone [string, null]: Número de teléfono del empleado
status [string]: Estado del empleado en Payflow. Valores posibles: active, on_leave, inactive, incomplete, deleted
subsidiary [integer, null]: ID de filial donde pertenece el empleado
subsidiaryTaxId [string, null]: NIT de la filial
subsidiaryCode [string, null]: ID de la filial en tu software de nómina
active [boolean]: Si el empleado tiene una cuenta activa en Payflow
counter [integer]: Intentos fallidos de inicio de sesión del empleado
agreedTyC [boolean]: Si el empleado ha aceptado los Términos y Condiciones de Payflow
flexflowStatus [null]: Siempre null
flexflowEnabled [boolean]: Siempre false
isEligibleFlexflow [boolean]: Siempre false
lastLearnflowUse [null]: Siempre null
Índice del primer registro a devolver
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"Número máximo de registros a devolver
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"b2cf45f4-7dea-4335-bbad-a88a6d7425c5","name":"Retrieve all employees: 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","description":"Índice del primer registro a devolver"},{"key":"limit","value":"50","description":"Número máximo de registros a devolver"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 12345,\n \"payrollId\": \"EMP001\",\n \"firstName\": \"Carlos\",\n \"lastName\": \"Rodríguez\",\n \"documentType\": \"CC\",\n \"personalId\": \"1234567890\",\n \"bankAccountNumber\": \"12345678901234567890\",\n \"bankAccountType\": \"ahorros\",\n \"iban\": null,\n \"bic_swift\": \"COLOCOBMXXX\",\n \"bankEntity\": \"Bancolombia\",\n \"grossSalary\": 3500000,\n \"netSalary\": 2800000,\n \"paymentFrequency\": \"monthly\",\n \"availableAmount\": 450000,\n \"restrictedAmount\": 0,\n \"startDate\": \"2024-01-15\",\n \"contractEnd\": null,\n \"email\": \"carlos.rodriguez@empresa.com.co\",\n \"address\": \"Calle 123 #45-67, Bogotá\",\n \"phone\": \"+573001234567\",\n \"status\": \"active\",\n \"subsidiary\": 5,\n \"subsidiaryTaxId\": \"900123456-7\",\n \"subsidiaryCode\": \"01\",\n \"active\": true,\n \"counter\": 0,\n \"agreedTyC\": true,\n \"flexflowStatus\": null,\n \"flexflowEnabled\": false,\n \"isEligibleFlexflow\": false,\n \"lastLearnflowUse\": null\n },\n {\n \"id\": 12346,\n \"payrollId\": \"EMP002\",\n \"firstName\": \"María\",\n \"lastName\": \"González\",\n \"documentType\": \"CC\",\n \"personalId\": \"9876543210\",\n \"bankAccountNumber\": \"09876543210987654321\",\n \"bankAccountType\": \"corriente\",\n \"iban\": null,\n \"bic_swift\": \"DAVICOBBXXX\",\n \"bankEntity\": \"Davivienda\",\n \"grossSalary\": 2800000,\n \"netSalary\": 2240000,\n \"paymentFrequency\": \"monthly\",\n \"availableAmount\": 280000,\n \"restrictedAmount\": 50000,\n \"startDate\": \"2025-02-01\",\n \"contractEnd\": null,\n \"email\": \"maria.gonzalez@empresa.com.co\",\n \"address\": null,\n \"phone\": \"+573019876543\",\n \"status\": \"active\",\n \"subsidiary\": null,\n \"subsidiaryTaxId\": null,\n \"subsidiaryCode\": null,\n \"active\": true,\n \"counter\": 2,\n \"agreedTyC\": true,\n \"flexflowStatus\": null,\n \"flexflowEnabled\": false,\n \"isEligibleFlexflow\": false,\n \"lastLearnflowUse\": null\n },\n {\n \"id\": 12347,\n \"payrollId\": \"EMP003\",\n \"firstName\": \"Andrés\",\n \"lastName\": \"Martínez\",\n \"documentType\": \"CC\",\n \"personalId\": \"5555444433\",\n \"bankAccountNumber\": \"55554444332211009988\",\n \"bankAccountType\": \"ahorros\",\n \"iban\": null,\n \"bic_swift\": \"BBVACOBMXXX\",\n \"bankEntity\": \"BBVA Colombia\",\n \"grossSalary\": 4200000,\n \"netSalary\": 3360000,\n \"paymentFrequency\": \"monthly\",\n \"availableAmount\": 0,\n \"restrictedAmount\": 0,\n \"startDate\": \"2023-11-20\",\n \"contractEnd\": \"2025-11-20\",\n \"email\": \"andres.martinez@empresa.com.co\",\n \"address\": \"Carrera 45 #23-89, Medellín\",\n \"phone\": \"+573025554444\",\n \"status\": \"on_leave\",\n \"subsidiary\": 7,\n \"subsidiaryTaxId\": \"800987654-3\",\n \"subsidiaryCode\": \"01\",\n \"active\": true,\n \"counter\": 0,\n \"agreedTyC\": false,\n \"flexflowStatus\": null,\n \"flexflowEnabled\": false,\n \"isEligibleFlexflow\": false,\n \"lastLearnflowUse\": null\n }\n ],\n \"total\": 3\n}"}],"_postman_id":"544b0f98-7741-45f8-b607-2c0e6f6c3d85"},{"name":"Empleado","id":"28c05877-e9f7-4939-8226-91b294c53e2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Test\",\n \"lastName\": \"User Colombia\",\n \"payrollId\": \"C02\",\n \"personalId\": \"1023879513\",\n \"documentType\": \"C_CIUDADANIA\",\n \"paymentFrequency\": \"monthly\",\n \"email\": \"test_user_colombia2@payflow.co\",\n \"phone\": \"+573209355775\",\n \"bankAccountNumber\": \"17469294854\",\n \"bankAccountType\": \"checking\",\n \"bankEntity\": \"BANCOLOMBIA\",\n \"address\": \"Edificio Lievano, Calle 11\",\n \"grossSalary\": 920000,\n \"startDate\": \"2022-01-01\",\n \"contractEnd\": \"2050-01-01\",\n \"subsidiary\": \"900123456-7\",\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee","description":"Agrega un nuevo empleado a la empresa asociada con la clave de API.
\n\n\n⚠️ MEJOR PRÁCTICA
\n\n
\n- Usa POST /employees para la creación/actualización de empleados en lote.
\n- Es más eficiente, coherente y reduce errores de validación.
\n- Usa este endpoint solo para casos puntuales.
\n
Es obligatorio especificar a qué filial pertenece el empleado. Esto se puede hacer proporcionando la subsidiary (NIT).
Debes especificar grossSalary o netSalary, pero no ambos. Si solo se proporciona grossSalary, se calculará netSalary. Si se proporciona netSalary, se ignorará grossSalary.
Es importante que si se proporciona grossSalary, no se debe enviar netSalary (no lo envíes como 0).
Si no quieres usar/actualizar un campo, no lo envíes en el payload.
\nnull, \"\" o 0 para “desactivar” un campo. Eso suele provocar validaciones inesperadas.Nota: El sistema normalizará automáticamente cualquiera de las variaciones listadas al nombre estándar de la entidad bancaria.
\nCampos obligatorios*
\npersonalId* [string]: Número de documento de identificación válido (será validado)
firstName* [string, null]: Nombre completo del empleado (máximo 100 caracteres)
lastName* [string, null]: Apellido completo del empleado (máximo 100 caracteres)
payrollId [string, null]: ID del empleado en tu software de nómina
email* [string, null] [requerido si no hay número de teléfono]: Dirección de email válida del empleado (máximo 100 caracteres, no puede ser genérico, debe ser único). Emails inválidos serán anulados
phone* [string, null] [requerido si no hay email]: Número de teléfono válido del empleado (no puede ser genérico, debe ser único). Teléfonos inválidos serán anulados
bankAccountNumber* [string, null]: Número de cuenta bancaria del empleado. Valores inválidos serán anulados
documentType* [string, null]: Tipo de documento de identificación. Valores posibles: C_CIUDADANIA, C_EXTRANJERIA, PASSPORT ,PEP
address* [string, null]: Dirección del empleado
grossSalary* [number, null]: Salario del empleado antes de impuestos (debe ser número positivo)
netSalary* [number, null]: Salario neto del empleado (debe ser número positivo, por defecto null).
grossSalary, no envíes netSalary como 0subsidiary* [number|string, null]: Código NIT/fiscal de filial
subsidiaryCode [string|number, null]: Código interno de filial (por defecto null)
bic_swift [string, null]: Código BIC/SWIFT del banco (máximo 100 caracteres)
bankEntity [string, null]: Nombre del banco (ver entidades bancarias soportadas arriba)
bankAccountType [string, null]: Tipo de cuenta bancaria del empleado. Valores posibles: checking (corriente), savings (ahorro)
restrictedAmount [number, null]: Monto restringido (debe ser número positivo, se permite 0, por defecto null)
availableAmount [number, null]: Monto disponible (debe ser número positivo, se permite 0, por defecto null)
paymentFrequency [string]: Frecuencia de pago del empleado (por defecto 'monthly'). Valores posibles: yearly, monthly, twiceAMonth
startDate [string, null]: Fecha de inicio de contrato del empleado en formato YYYY-MM-DD (por defecto inicio del mes actual)
status [string]: Estado del empleado (por defecto 'active'). Valores posibles: active, inactive, on_leave
contractEnd [string, null]: Fecha de fin de contrato en formato YYYY-MM-DD (puede ser cadena vacía, por defecto null).
statusleaveEnd [string, null]: Fecha de fin de licencia en formato YYYY-MM-DD (por defecto null)
Los valores inválidos de email, phone, o bankAccountNumber serán automáticamente anulados
Al menos un método de contacto (email O phone) debe ser válido y proporcionado
Las fechas deben estar en formato YYYY-MM-DD
Datos duplicados de empleado resultarán en un error 409 Conflict
En caso de solicitud exitosa, la respuesta tendrá la siguiente estructura:
\nVersión de API. Usa 1.1 para mejor rendimiento.
\n","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"User Colombia\",\r\n \"payrollId\": \"C08\",\r\n \"personalId\": \"1023879518\",\r\n \"documentType\": \"C_CIUDADANIA\",\r\n \"paymentFrequency\": \"monthly\",\r\n \"email\": \"test_user_colombia8@payflow.co\",\r\n \"phone\": \"+573209355775\",\r\n \"bankAccountNumber\": \"17469294858\",\r\n \"bankAccountType\": \"checking\",\r\n \"address\": \"Edificio Lievano, Calle 11\",\r\n \"grossSalary\": 920000,\r\n \"startDate\": \"2022-01-01\",\r\n \"contractEnd\": \"2050-01-01\",\r\n \"subsidiary\": \"15867674022\",\r\n \"status\": \"active\"\r\n },\r\n {\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"User Colombia\",\r\n \"payrollId\": \"C07\",\r\n \"personalId\": \"1023879519\",\r\n \"documentType\": \"C_EXTRANJERIA\",\r\n \"paymentFrequency\": \"monthly\",\r\n \"email\": \"test_user_colombia9@payflow.co\",\r\n \"phone\": \"+573209355775\",\r\n \"bankAccountNumber\": \"17469294859\",\r\n \"bankAccountType\": \"savings\",\r\n \"address\": \"Edificio Lievano, Calle 11\",\r\n \"grossSalary\": 920000,\r\n \"startDate\": \"2022-01-01\",\r\n \"contractEnd\": \"2050-01-01\",\r\n \"subsidiary\": \"15867674022\",\r\n \"status\": \"active\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employees","description":"Crea o actualiza empleados en lotes.
\nTodas las validaciones de POST /employee se aplican a cada empleado en el payload — por ejemplo, debes especificar grossSalary o netSalary, pero no ambos.
Los registros inválidos no generarán un error 4xx — en su lugar, se incluirá un elemento error en la respuesta. Un array vacío significa que todos los empleados fueron procesados exitosamente.
\nEstablece el header api-version en v1.1 para mejor rendimiento y estabilidad
\nUsa este endpoint para todas las creaciones y actualizaciones de empleados en lote
\nEnvía empleados en lotes de hasta 50 para rendimiento óptimo
\nEl tamaño máximo de lote es de 500 empleados. Para sincronizar más, haz multiples llamadas secuenciales.
\nSi no quieres usar/actualizar un campo, no lo envíes en el payload.
\nnull, \"\" o 0 para “desactivar” un campo. Eso suele provocar validaciones inesperadas.Nota: El sistema normalizará automáticamente cualquiera de las variaciones listadas al nombre estándar de la entidad bancaria.
\nCampos obligatorios*
\nArray de objetos de empleado con la siguiente estructura (máx 500, recomendado 50 por lote):
\npersonalId* [string, null]: Número de documento de identificación válido (máximo 100 caracteres, será validado)
firstName* [string, null]: Nombre completo del empleado (máximo 100 caracteres)
lastName*[string, null]: Apellido completo del empleado (máximo 100 caracteres)
payrollId [string, null]: ID del empleado en tu software de nómina
documentType* [string, null]: Tipo de documento de identificación. Valores posibles: C_CIUDADANIA, C_EXTRANJERIA, PASSPORT, PEP
grossSalary* [number|string, null]: Salario del empleado antes de impuestos (debe ser número positivo, por defecto null)
netSalary* [number|string, null]: Salario neto del empleado (debe ser número positivo, por defecto null). Si se proporciona grossSalary, no envíes netSalary como 0
restrictedAmount [number, null]: Monto restringido (debe ser número positivo, se permite 0, por defecto null)
availableAmount [number|string, null]: Monto disponible para retiro
paymentFrequency [string, null]: Frecuencia de pago del empleado. Valores posibles: yearly, monthly, twiceAMonth
email* [string, null] [requerido si no hay número de teléfono]: Dirección de email válida del empleado (no puede ser genérico, debe ser único). Emails inválidos serán anulados
phone* [string, null][requerido si no hay email]: Número de teléfono válido del empleado (no puede ser genérico, debe ser único). Números de teléfono inválidos serán anulados
bankAccountNumber* [string, null]: Número de cuenta bancaria del empleado. Valores inválidos serán anulados
bankAccountType [string, null]: Tipo de cuenta bancaria del empleado. Valores posibles: checking (corriente), savings (ahorro)
bic_swift [string, null]: Código BIC/SWIFT del banco
bankEntity [string, null]: Nombre del banco (ver entidades bancarias soportadas arriba)
address* [string, null]: Dirección del empleado
startDate [string, null]: Fecha de inicio de contrato del empleado en formato YYYY-MM-DD
status* [string, null]: Estado del empleado. Valores posibles: active, inactive, on_leave
contractEnd [string, null]: Fecha de fin de contrato en formato YYYY-MM-DD (puede ser cadena vacía, por defecto null).
statusleaveEnd [string, null]: Fecha de fin de licencia en formato YYYY-MM-DD
subsidiary* [number|string, null]: NIT de filial
subsidiaryCode* [string, null]: Código de filial
Al menos un método de contacto (email O phone) debe ser proporcionado y válido para cada empleado
Todos los datos de empleado deben ser únicos (sin duplicados dentro de la solicitud o con empleados existentes)
\npersonalId es requerido para cada empleado
Los valores inválidos de email, phone, o bankAccountNumber serán automáticamente anulados
La filial/subsidiaria debe ser proporcionada en formato NIT para validación adecuada
\nEn caso de procesamiento exitoso, la respuesta tendrá la siguiente estructura:
\ncreated [array]: Empleados creados exitosamente
\nupdated [array]: Empleados actualizados exitosamente
\nid [number]: ID del empleado en Payflow
\npersonalId [string]: ID personal del empleado
\nerror [array]: Empleados que fallaron en el procesamiento
\npersonalId [string]: ID personal del empleado
\nmessage [string, opcional]: Descripción del error
\nImporta un archivo desde un software de nómina a Payflow.
\nLos empleados en el archivo se procesan de la misma manera que en POST /employees: los registros existentes se actualizan, se crean nuevos, y se aplican todas las reglas de validación estándar.
En caso de solicitud exitosa, la respuesta tendrá la siguiente estructura:
\nrowsProcessed [number]: Número total de empleados creados o actualizados exitosamente
warningRows[array]: Filas que fueron procesadas pero tuvieron problemas no críticos
rowNumber [number]: Número de fila en el archivo original
message [string]: Descripción de la advertencia
data [object]: Datos originales de la fila que causaron la advertencia
\nTipo de formato de archivo de nómina
\n","type":"text/plain"},"type":"any","value":"","key":"type"}]}},"response":[{"id":"8cc70ea0-bdd3-4a91-9ddb-35f9522dc7fc","name":"Envio exitoso","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","type":"text"}],"body":{"mode":"file","file":{"src":"/Users/msevillano/Desktop/PAY_EMPLEADOS.xlsx"}},"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":"Tipo de formato de archivo de nómina"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"rowsProcessed\": 1,\n \"warningRows\": [],\n \"invalidRows\": []\n}"},{"id":"e655df05-014a-418f-9402-5e5313e010a8","name":"Archivo con filas invalidas","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","type":"text"}],"body":{"mode":"file","file":{"src":"/Users/msevillano/Desktop/PAY_EMPLEADOS.xlsx"}},"url":{"raw":"https://api-public.payflow.es/employees/file/:type","host":["https://api-public.payflow.es"],"path":["employees","file",":type"],"variable":[{"key":"type","value":"payflow","description":"Tipo de formato de archivo de nómina"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"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":"64166567-7c58-421a-b576-14aac3e6cd1b"},{"name":"Empleado por Personal ID","id":"c5383a80-9d22-4e17-bb05-c672ca31fe6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Test\",\n \"lastName\": \"User\",\n \"personalId\": \"1023879513\",\n \"documentType\": \"C_CIUDADANIA\",\n \"paymentFrequency\": \"monthly\",\n \"email\": \"test_user_modified@payflow.co\",\n \"grossSalary\": 1930000,\n \"contractEnd\": \"2050-01-01\",\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee/:personalId","description":"Edita la información del empleado mediante tu personalId.
Todos los campos son opcionales - solo envía los campos que quieres actualizar.
\nPuedes especificar grossSalary o netSalary, pero no ambos. Si solo se proporciona grossSalary, se calculará netSalary. Si se proporciona netSalary, se ignorará grossSalary.
Es importante que si se proporciona grossSalary, no se debe enviar netSalary (no lo envíes como 0).
firstName [string, null]: Nombre completo del empleado (máximo 100 caracteres)
lastName [string, null]: Apellido completo del empleado (máximo 100 caracteres)
payrollId [string, null]: ID del empleado en tu software de nómina (máximo 100 caracteres)
personalId [string, null]: Número de documento de identificación (máximo 100 caracteres)
documentType [string, null]: Tipo de documento de identificación. Valores posibles: C_CIUDADANIA, C_EXTRANJERIA, PASSPORT, PEP
email [string, null]: Dirección de email válida del empleado (máximo 100 caracteres, no puede ser genérico, debe ser único). Emails inválidos serán anulados
phone [string, null]: Número de teléfono válido del empleado (no puede ser genérico, debe ser único). Teléfonos inválidos serán anulados
bankAccountNumber [string, null]: Número de cuenta bancaria del empleado. Valores inválidos serán anulados
bic_swift [string, null]: Código BIC/SWIFT del banco (máximo 100 caracteres)
bankEntity [string, null]: Nombre del banco (ver entidades bancarias soportadas arriba)
bankAccountType [string, null]: Tipo de cuenta bancaria del empleado. Valores posibles: checking (corriente), savings (ahorro)
address [string, null]: Dirección del empleado (máximo 256 caracteres)
netSalary [number, null]: Salario neto del empleado (debe ser número positivo). Si se proporciona grossSalary, no envíes netSalary como 0
restrictedAmount [number, null]: Monto restringido (debe ser número positivo, se permite 0)
availableAmount [number, null]: Monto disponible (debe ser número positivo, se permite 0)
grossSalary [number, null]: Salario del empleado antes de impuestos (debe ser número positivo, se permite 0)
paymentFrequency [string]: Frecuencia de pago del empleado (por defecto 'monthly'). Valores posibles: yearly, monthly, twiceAMonth
startDate [string, null]: Fecha de inicio de contrato del empleado en formato YYYY-MM-DD
status [string, null]: Estado del empleado. Valores posibles: active, inactive, on_leave
contractEnd [string, null]: Fecha de fin de contrato en formato YYYY-MM-DD (puede ser cadena vacía, por defecto null).
statusleaveEnd [string, null]: Fecha de fin de licencia en formato YYYY-MM-DD
subsidiary [number|string, null]: ID de filial o código NIT/fiscal
subsidiaryCode [string|number, null]: Código interno de filial
Los valores inválidos de email, teléfono, o bankAccountNumber serán automáticamente anulados
\nTodos los campos son opcionales - solo incluye los campos que quieres actualizar
\nLas fechas deben estar en formato YYYY-MM-DD
El empleado debe existir en la empresa para ser actualizado
\n200 OK: Empleado actualizado exitosamente (cuerpo de respuesta vacío)
\n400 Bad Request: Error de validación
\n404 Not Found: El empleado con el personalId especificado no existe
\nNúmero de documento de identificación
\n","type":"text/plain"},"type":"any","value":"","key":"personalId"}]}},"response":[{"id":"d88d2420-485d-4d45-b822-9817ef90ec21","name":"Actualización exitosa","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Test\",\n \"lastName\": \"User\",\n \"personalId\": \"1011122213\",\n \"documentType\": \"C_CIUDADANIA\",\n \"paymentFrequency\": \"monthly\",\n \"email\": \"test_user_modified@payflow.co\",\n \"grossSalary\": 1930000,\n \"contractEnd\": \"2050-01-01\",\n \"status\": \"active\"\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":"1011122213","description":"Número de documento de identificación"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e400218a-73d3-4410-a930-9d99be73103d","name":"Empleado no encontrado","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Test\",\n \"lastName\": \"User\",\n \"personalId\": \"1023879513\",\n \"documentType\": \"C_CIUDADANIA\",\n \"paymentFrequency\": \"monthly\",\n \"email\": \"test_user_modified@payflow.co\",\n \"grossSalary\": 1930000,\n \"contractEnd\": \"2050-01-01\",\n \"status\": \"active\"\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":"1011119511","description":"Employee document number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c5383a80-9d22-4e17-bb05-c672ca31fe6d"},{"name":"Empleado por Payflow ID","id":"29ca1ac0-23b2-4e96-8d9d-a7d9a4766dbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Joe\",\n \"lastName\": \"Doe\",\n \"status\": \"on_leave\",\n \"leaveEnd\": \"2025-06-15\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee/:payflowId","description":"Edita la información del empleado mediante su id en Payflow.
\nTodos los campos son opcionales - solo envía los campos que quieres actualizar.
\nPuedes especificar grossSalary o netSalary, pero no ambos. Si solo se proporciona grossSalary, se calculará netSalary. Si se proporciona netSalary, se ignorará grossSalary.
Es importante que si se proporciona grossSalary, no se debe enviar netSalary (no lo envíes como 0).
firstName [string, null]: Nombre completo del empleado (máximo 100 caracteres)
lastName [string, null]: Apellido completo del empleado (máximo 100 caracteres)
payrollId [string, null]: ID del empleado en tu software de nómina (máximo 100 caracteres)
personalId [string, null]: Número de documento de identificación (máximo 100 caracteres)
documentType [string, null]: Tipo de documento de identificación. Valores posibles: C_CIUDADANIA, C_EXTRANJERIA, PASSPORT, PEP
email [string, null]: Dirección de email válida del empleado (máximo 100 caracteres, no puede ser genérico, debe ser único). Emails inválidos serán anulados
phone [string, null]: Número de teléfono válido del empleado (no puede ser genérico, debe ser único). Teléfonos inválidos serán anulados
bankAccountNumber [string, null]: Número de cuenta bancaria del empleado. Valores inválidos serán anulados
bic_swift [string, null]: Código BIC/SWIFT del banco (máximo 100 caracteres)
bankEntity [string, null]: Nombre del banco (ver entidades bancarias soportadas arriba)
bankAccountType [string, null]: Tipo de cuenta bancaria del empleado. Valores posibles: checking (corriente), savings (ahorro)
address [string, null]: Dirección del empleado (máximo 256 caracteres)
netSalary [number, null]: Salario neto del empleado (debe ser número positivo). Si se proporciona grossSalary, no envíes netSalary como 0
restrictedAmount [number, null]: Monto restringido (debe ser número positivo, se permite 0)
availableAmount [number, null]: Monto disponible (debe ser número positivo, se permite 0)
grossSalary [number, null]: Salario del empleado antes de impuestos (debe ser número positivo, se permite 0)
paymentFrequency [string]: Frecuencia de pago del empleado (por defecto 'monthly'). Valores posibles: yearly, monthly, twiceAMonth
startDate [string, null]: Fecha de inicio de contrato del empleado en formato YYYY-MM-DD
status [string, null]: Estado del empleado. Valores posibles: active, inactive, on_leave
contractEnd [string, null]: Fecha de fin de contrato en formato YYYY-MM-DD (puede ser cadena vacía, por defecto null).
statusleaveEnd [string, null]: Fecha de fin de licencia en formato YYYY-MM-DD
subsidiary [number|string, null]: ID de filial o código NIT/fiscal
subsidiaryCode [string|number, null]: Código interno de filial
Los valores inválidos de email, teléfono, o bankAccountNumber serán automáticamente anulados
\nTodos los campos son opcionales - solo incluye los campos que quieres actualizar
\nLas fechas deben estar en formato YYYY-MM-DD
El empleado debe existir en la empresa para ser actualizado
\n200 OK: Empleado actualizado exitosamente (cuerpo de respuesta vacío)
\n400 Bad Request: Error de validación
\n404 Not Found: El empleado con el personalId especificado no existe
\nIdentificador en Payflow
\n","type":"text/plain"},"type":"any","value":"","key":"payflowId"}]}},"response":[{"id":"ee5d55b3-e966-48e7-b2bc-302083ba7ca5","name":"Actualización exitosa","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Test\",\n \"lastName\": \"User Colombia\",\n \"payrollId\": \"20\",\n \"personalId\": \"1023879513\",\n \"documentType\": \"C_CIUDADANIA\",\n \"paymentFrequency\": \"monthly\",\n \"email\": \"test_user_colombia2_modified@payflow.co\",\n \"phone\": \"+573209355775\",\n \"bankAccountNumber\": \"17469294854\",\n \"bankAccountType\": \"savings\",\n \"address\": \"Edificio Lievano, Calle 11\",\n \"grossSalary\": \"1930000\",\n \"startDate\": \"2022-01-01\",\n \"contractEnd\": \"2050-01-01\",\n \"subsidiary\": \"B81101373\",\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-public.payflow.es/employee/:payflowId","host":["https://api-public.payflow.es"],"path":["employee",":payflowId"],"variable":[{"key":"payflowId","value":"23","description":"Identificador en Payflow"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"7586a251-9deb-45aa-8048-4c3d81110833","name":"Empleado no encontrado","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Test\",\n \"lastName\": \"User\",\n \"personalId\": \"1023879513\",\n \"documentType\": \"C_CIUDADANIA\",\n \"paymentFrequency\": \"monthly\",\n \"email\": \"test_user_modified@payflow.co\",\n \"grossSalary\": 1930000,\n \"contractEnd\": \"2050-01-01\",\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-public.payflow.es/employee/:payflowId","host":["https://api-public.payflow.es"],"path":["employee",":payflowId"],"variable":[{"key":"payflowId","value":"3","description":"Identificador en Payflow"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"29ca1ac0-23b2-4e96-8d9d-a7d9a4766dbb"},{"name":"Empleado por Payroll ID","id":"1593b70f-ada7-41fa-8061-405cf3066b4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Test\",\n \"lastName\": \"User\",\n \"personalId\": \"1023879513\",\n \"documentType\": \"C_CIUDADANIA\",\n \"paymentFrequency\": \"monthly\",\n \"email\": \"test_user_modified@payflow.co\",\n \"grossSalary\": 1930000,\n \"contractEnd\": \"2050-01-01\",\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-public.payflow.es/employee/:payrollId","description":"Edita la información del empleado mediante tu payrollId.
Todos los campos son opcionales - solo envía los campos que quieres actualizar.
\nPuedes especificar grossSalary o netSalary, pero no ambos. Si solo se proporciona grossSalary, se calculará netSalary. Si se proporciona netSalary, se ignorará grossSalary.
Es importante que si se proporciona grossSalary, no se debe enviar netSalary (no lo envíes como 0).
firstName [string, null]: Nombre completo del empleado (máximo 100 caracteres)
lastName [string, null]: Apellido completo del empleado (máximo 100 caracteres)
payrollId [string, null]: ID del empleado en tu software de nómina (máximo 100 caracteres)
personalId [string, null]: Número de documento de identificación (máximo 100 caracteres)
documentType [string, null]: Tipo de documento de identificación. Valores posibles: C_CIUDADANIA, C_EXTRANJERIA, PASSPORT, PEP
email [string, null]: Dirección de email válida del empleado (máximo 100 caracteres, no puede ser genérico, debe ser único). Emails inválidos serán anulados
phone [string, null]: Número de teléfono válido del empleado (no puede ser genérico, debe ser único). Teléfonos inválidos serán anulados
bankAccountNumber [string, null]: Número de cuenta bancaria del empleado. Valores inválidos serán anulados
bic_swift [string, null]: Código BIC/SWIFT del banco (máximo 100 caracteres)
bankEntity [string, null]: Nombre del banco (ver entidades bancarias soportadas arriba)
bankAccountType [string, null]: Tipo de cuenta bancaria del empleado. Valores posibles: checking (corriente), savings (ahorro)
address [string, null]: Dirección del empleado (máximo 256 caracteres)
netSalary [number, null]: Salario neto del empleado (debe ser número positivo). Si se proporciona grossSalary, no envíes netSalary como 0
restrictedAmount [number, null]: Monto restringido (debe ser número positivo, se permite 0)
availableAmount [number, null]: Monto disponible (debe ser número positivo, se permite 0)
grossSalary [number, null]: Salario del empleado antes de impuestos (debe ser número positivo, se permite 0)
paymentFrequency [string]: Frecuencia de pago del empleado (por defecto 'monthly'). Valores posibles: yearly, monthly, twiceAMonth
startDate [string, null]: Fecha de inicio de contrato del empleado en formato YYYY-MM-DD
status [string, null]: Estado del empleado. Valores posibles: active, inactive, on_leave
contractEnd [string, null]: Fecha de fin de contrato en formato YYYY-MM-DD (puede ser cadena vacía, por defecto null).
statusleaveEnd [string, null]: Fecha de fin de licencia en formato YYYY-MM-DD
subsidiary [number|string, null]: ID de filial o código NIT/fiscal
subsidiaryCode [string|number, null]: Código interno de filial
Los valores inválidos de email, teléfono, o bankAccountNumber serán automáticamente anulados
\nTodos los campos son opcionales - solo incluye los campos que quieres actualizar
\nLas fechas deben estar en formato YYYY-MM-DD
El empleado debe existir en la empresa para ser actualizado
\n200 OK: Empleado actualizado exitosamente (cuerpo de respuesta vacío)
\n400 Bad Request: Error de validación
\n404 Not Found: El empleado con el personalId especificado no existe
\nElimina del sistema un empleado mediante su personalId
Destinado a remover empleados que fueron cargados por error.
\nSi el empleado ya no trabaja en la empresa, por favor usa status inactive y el método PUT.
No se requiere cuerpo de solicitud.
\nEn caso de eliminación exitosa, devuelve un cuerpo de respuesta vacío.
\n","urlObject":{"path":["employee",":personalId"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"8b04cda3-43e6-4736-b6b5-7ab61a5992a8","description":{"content":"Employee document number
\n","type":"text/plain"},"type":"any","value":"","key":"personalId"}]}},"response":[{"id":"897f82ce-04f7-4275-ba2f-ffab4c025bb3","name":"Delete an employee","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:personalId","host":["https://api-public.payflow.es"],"path":["employee",":personalId"],"variable":[{"key":"personalId","value":"1011122211","description":"Employee document number"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7e9eb0ad-9a04-498f-91e7-f5c377e14c61","name":"Attempt to delete a non-existent employee","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Your-API-key-here","type":"text"}],"body":{"mode":"raw","raw":"","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":"101233211"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"60"},{"key":"Date","value":"Wed, 23 Sep 2020 10:15:55 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Not Found\"\n}"}],"_postman_id":"aed6c994-cd69-4690-909c-4eb201a5c40f"},{"name":"Empleado por Payflow ID","id":"b8bbc010-99e1-4052-b119-10e614fd2a79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Your-API-key-here","type":"text"}],"url":"https://api-public.payflow.es/employee/:payflowID","description":"Elimina del sistema un empleado mediante su id en Payflow
\nDestinado a remover empleados que fueron cargados por error.
\nSi el empleado ya no trabaja en la empresa, por favor usa status inactive y el método PUT.
No se requiere cuerpo de solicitud.
\nEn caso de eliminación exitosa, devuelve un cuerpo de respuesta vacío.
\n","urlObject":{"path":["employee",":payflowID"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"5294d13b-532a-4f12-84bc-bddd00c5f28b","description":{"content":"Employee ID in Payflow
\n","type":"text/plain"},"type":"any","value":"","key":"payflowID"}]}},"response":[{"id":"7b5b373f-5f22-4ed5-abbb-a4339ebe5b34","name":"Delete an employee","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:payflowId","host":["https://api-public.payflow.es"],"path":["employee",":payflowId"],"variable":[{"key":"payflowId","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"cache-control","value":"no-cache"},{"key":"Date","value":"Wed, 23 Sep 2020 10:15:26 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":""},{"id":"519328f7-e2e3-44b1-942d-d8c58e436854","name":"Attempt to delete a non-existent employee","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:payflowId","host":["https://api-public.payflow.es"],"path":["employee",":payflowId"],"variable":[{"key":"payflowId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"60"},{"key":"Date","value":"Wed, 23 Sep 2020 10:15:55 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Not Found\"\n}"}],"_postman_id":"b8bbc010-99e1-4052-b119-10e614fd2a79"},{"name":"Empleado por Payroll ID","id":"da303357-6246-4e05-b426-b14b5346b785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Your-API-key-here","type":"text"}],"url":"https://api-public.payflow.es/employee/:payrollId","description":"Elimina del sistema un empleado mediante su payrollId(ID del empleado en tu software de nómina)
Destinado a remover empleados que fueron cargados por error.
\nSi el empleado ya no trabaja en la empresa, por favor usa status inactive y el método PUT.
No se requiere cuerpo de solicitud.
\nEn caso de eliminación exitosa, devuelve un cuerpo de respuesta vacío.
\n","urlObject":{"path":["employee",":payrollId"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"31d7cfe2-8fdb-4204-9b49-78e25d3901d7","description":{"content":"Employee ID in your payroll software
\n","type":"text/plain"},"type":"any","value":"","key":"payrollId"}]}},"response":[{"id":"d51c6a05-fb34-4534-b248-edf8af393b07","name":"Delete an employee","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:payrollId","host":["https://api-public.payflow.es"],"path":["employee",":payrollId"],"variable":[{"key":"payrollId","value":"E02"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a55eae41-13df-4285-8935-43b45ecff7e4","name":"Attempt to delete a non-existent employee","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Your-API-key-here","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-public.payflow.es/employee/:payrollId","host":["https://api-public.payflow.es"],"path":["employee",":payrollId"],"variable":[{"key":"payrollId","value":"E10"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"60"},{"key":"Date","value":"Wed, 23 Sep 2020 10:15:55 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Not Found\"\n}"}],"_postman_id":"da303357-6246-4e05-b426-b14b5346b785"}],"id":"06e20460-e7ad-49dc-b11f-e94824cceb40","description":"Operaciones completas para gestionar empleados.
\nUn empleado es el usuario final de Payflow. Cada empleado necesita un documento de identidad único (cédula de ciudadanía, cédula de extranjería, o PEP) e información básica de salario.
\nLos empleados deben tener uno de estos documentos:
\nC_CIUDADANIA (Cédula de Ciudadanía) - También acepta: CC, C
C_EXTRANJERIA (Cédula de Extranjería) - También acepta: CE, E, CARNE_DE_EXTRANJERIA
PEP (Permiso Especial de Permanencia) - También acepta: PERMISO_ESPECIAL_DE_PERMANENCIA
PASSPORT - También acepta: PASAPORTE, P
Los empleados pueden estar en uno de los siguientes estados, reflejando su relación actual con la empresa y su acceso a Payflow:
\nactive: El empleado está trabajando actualmente en la empresa, tiene datos válidos, y está autorizado para usar Payflow. Nota: Esto no significa necesariamente que se haya registrado o iniciado sesión en la plataforma.
inactive: El empleado ya no trabaja en la empresa y no está autorizado para usar Payflow.
on_leave: El empleado está temporalmente con licencia. Sigue en la empresa pero no puede usar Payflow hasta regresar.
incomplete: El registro del empleado le falta información importante (salario, email, teléfono) y no se puede procesar.
Obtiene todos los empleados que están actualmente en estado on_leave
En caso de solicitud exitosa, la respuesta tendrá la siguiente estructura:
\ndata [array]: Lista de empleados con licencia
id [number]: ID interno del empleado
personalId [string]: Número de cédula del empleado
payrollId [string]: ID de nómina del empleado
iban [null]: Siempre null
bankAccountNumber [string, null]: Número de cuenta bancaria
documentType [string, null]: Tipo de documento de identificación
bankAccountType [string, null]: Tipo de cuenta bancaria
bic_swift [string, null]: Código BIC/SWIFT del banco
bankEntity [string, null]: Nombre de la entidad bancaria
firstName [string]: Nombre del empleado
lastName [string]: Apellido del empleado
paymentFrequency [string]: Frecuencia de pago (ej., \"monthly\")
netSalary [number]: Salario neto del empleado
grossSalary [number]: Salario bruto del empleado
availableAmount [number]: Monto actualmente disponible para retiro (siempre 0 para empleados con licencia)
restrictedAmount [number, null]: Monto restringido
startDate [string]: Fecha de inicio del empleado (YYYY-MM-DD)
contractEnd [string, null]: Fecha de fin de contrato (YYYY-MM-DD)
email [string, null]: Dirección de email del empleado
address [string, null]: Dirección del empleado
phone [string, null]: Número de teléfono del empleado
status [string]: Estado del empleado (siempre on_leave para este endpoint)
subsidiary [number, null]: ID de filial/subsidiaria
subsidiaryTaxId [string, null]: NIT de la filial/subsidiaria
subsidiaryCode [string, null]: Código de filial/subsidiaria
active [boolean]: Si el empleado está activo
counter [number]: Contador de intentos fallidos de inicio de sesión
agreedTyC [boolean]: Si el empleado aceptó los Términos y Condiciones
flexflowStatus [null]: Siempre null
flexflowEnabled [boolean]: Siempre false
isEligibleFlexflow [boolean]: Siempre false
lastLearnflowUse [null]: Siempre null
Crea una licencia temporal para un empleado específico, comenzando inmediatamente y durando hasta la endDate proporcionada.
Debes incluir uno de los siguientes identificadores en el cuerpo de solicitud: personalId, payrollId, o id (ID de Payflow).
Solo se debe proporcionar un identificador para evitar ambigüedad.
\nendDate [string] [requerido]: Fecha de fin de la licencia (formato: YYYY-MM-DD)
id [number] [opcional]: ID interno del empleado en Payflow
payrollId [string] [opcional]: ID del empleado en tu software de nómina
personalId [string] [opcional]: Número de documento de identificación del empleado
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":"0c5cdc83-ea1f-4335-af49-5336d839a289","id":"0c5cdc83-ea1f-4335-af49-5336d839a289","name":"Payflow API (CO)","type":"collection"}},"urlObject":{"path":["employee","leave"],"host":["https://api-public.payflow.es"],"query":[],"variable":[]}},"response":[{"id":"c2eeab70-127d-49ad-89e1-d5b63ab4e0af","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalId\": \"123456789\",\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":"581cfda5-78d0-4c53-b369-1ea86372ab1d","name":"Employee Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 0,\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":"88fe51a7-11c7-42a5-87ca-5e1cc89fef2b"},{"name":"Employee Leave","id":"d4d1297d-51e1-4c80-b5c1-f24de1d5cbd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api-public.payflow.es/employee/:personalId/leave","description":"Cancela la licencia del empleado especificado usando su personalId.
El empleado será reactivado inmediatamente.
\nNo se requiere cuerpo de solicitud.
\nEn caso de eliminación exitosa, devuelve un cuerpo de respuesta vacío.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"0c5cdc83-ea1f-4335-af49-5336d839a289","id":"0c5cdc83-ea1f-4335-af49-5336d839a289","name":"Payflow API (CO)","type":"collection"}},"urlObject":{"path":["employee",":personalId","leave"],"host":["https://api-public.payflow.es"],"query":[],"variable":[{"id":"1e6b5592-c734-4ff2-8c92-3ab14afb7767","description":{"content":"Employee document number
\n","type":"text/plain"},"type":"any","value":"","key":"personalId"}]}},"response":[{"id":"88351594-b8ab-44ab-b216-e6c088303434","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:personalId/leave","host":["https://api-public.payflow.es"],"path":["employee",":personalId","leave"],"variable":[{"key":"personalId","value":"123456789","description":"Employee document number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"e8c5cacc-8687-47c2-8727-22205654b7ac","name":"Employee is not on leave","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api-public.payflow.es/employee/:personalId/leave","host":["https://api-public.payflow.es"],"path":["employee",":personalId","leave"],"variable":[{"key":"personalId","value":"123458901","description":"Employee document number"}]}},"status":"Not Found","code":404,"_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":"d4d1297d-51e1-4c80-b5c1-f24de1d5cbd9"}],"id":"02d275b8-6f51-4776-92fe-eb627932cd0d","description":"Las solicitudes de licencia se usan para gestionar empleados que están temporalmente ausentes del trabajo. Mientras están con licencia, los empleados no pueden acceder a Payflow — no podrán hacer retiros.
\nLas licencias son una forma útil de desactivar temporalmente el acceso del empleado sin inactivar permanentemente su cuenta.
\nNota: Payflow no soporta especificar períodos completos de licencia. Solo puedes definir una fecha de fin de licencia, que reactivará automáticamente al empleado una vez que termine la licencia.
\n","_postman_id":"02d275b8-6f51-4776-92fe-eb627932cd0d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"0c5cdc83-ea1f-4335-af49-5336d839a289","id":"0c5cdc83-ea1f-4335-af49-5336d839a289","name":"Payflow API (CO)","type":"collection"}}},{"name":"Pagos","item":[{"name":"Pagos de la Empresa","id":"a52f86f6-f670-4135-ad28-823b75b3cc40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/payments?start=&end=&cycle=&convoluted","description":"Obtiene todos los pagos de anticipo de salario (retiros de salario devengado) solicitados por empleados durante un período o ciclo específico.
\nSi se proporcionan tanto startDate/endDate como cycle, el cycle tiene precedencia.
Si el parámetro de consulta convoluted se establece en true, el formato de respuesta cambia (ver ejemplos).
Los pagos convoluted agrupan todos los pagos por empleado dentro de la empresa e incluyen:
\nMonto total solicitado durante el período
\nPrimer pago realizado y su timestamp de solicitud
\nÚltimo pago realizado y su timestamp de solicitud
\nTodos los IDs de pago relacionados
\nNota: El campo informedToIntegration en la respuesta puede ser ignorado. Como las integraciones están siendo migradas a microservicios, este valor siempre es false para sistemas más nuevos.
data [array]: Lista de registros de pago
id [string]: Identificador del pago
user [string]: Cédula del empleado
userPayrollId [string]: ID de nómina del empleado
amount [number]: Monto del pago
fee [number]: Comisión de procesamiento
status [string]: Estado del pago (ej., \"processed\", \"processing\", \"pending\")
paid [boolean]: Si el pago ha sido procesado
requestedAt [string]: Cuándo fue solicitado el pago (cadena ISO)
paidAt [string]: Cuándo fue procesado el pago (cadena ISO)
message [string, null]: Mensaje opcional
informedToIntegration [boolean]: Si el pago fue confirmado vía API
data [array]: Lista de registros de pago agregados por empleado
ids [array]: Array de todos los identificadores de pago para este empleado
user [string]: Cédula del empleado
userPayrollId [string]: ID de nómina del empleado
amount [number]: Monto total agregado para todos los pagos
fee [number]: Comisiones totales agregadas para todos los pagos
informedToIntegration [boolean]: Si todos los pagos fueron confirmados vía API
paid [boolean]: Estado general del pago
firstTransactionRequestedAt [string]: Fecha de solicitud más temprana entre todos los pagos
lastTransactionRequestedAt [string]: Fecha de solicitud más tardía entre todos los pagos
TransactionPaidAt [string]: Fecha de pago más temprana entre todos los pagos
lastTransactionPaidAt [string]: Fecha de pago más tardía entre todos los pagos
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":null}],"variable":[]}},"response":[{"id":"7b4ac6d0-0cac-499b-b8b7-de306331a227","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments/?start=2025-07-01&end=2025-07-11","host":["https://api-public.payflow.es"],"path":["payments",""],"query":[{"key":"start","value":"2025-07-01","description":"Start date for filtering payments (YYYY-MM-DD)"},{"key":"end","value":"2025-07-11","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\": \"UOrBt6ZcM\",\n \"user\": \"1234567890\",\n \"userPayrollId\": \"001\",\n \"amount\": 150000,\n \"fee\": 2500,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-07-11T08:30:15.000Z\",\n \"paidAt\": \"2025-07-11T10:45:22.000Z\",\n \"message\": null,\n \"informedToIntegration\": true\n },\n {\n \"id\": \"yrwtcoOk\",\n \"user\": \"9876543210\",\n \"userPayrollId\": \"002\",\n \"amount\": 85000,\n \"fee\": 1500,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-07-11T10:20:30.000Z\",\n \"paidAt\": \"2025-07-11T10:15:45.000Z\",\n \"message\": null,\n \"informedToIntegration\": true\n },\n {\n \"id\": \"I2TvsKmf3\",\n \"user\": \"5555444433\",\n \"userPayrollId\": \"003\",\n \"amount\": 200000,\n \"fee\": 3000,\n \"status\": \"processing\",\n \"paid\": false,\n \"requestedAt\": \"2025-07-11T11:45:00.000Z\",\n \"paidAt\": \"2025-07-11T11:45:00.000Z\",\n \"message\": null,\n \"informedToIntegration\": false\n }\n ]\n}"},{"id":"7a4556ac-425d-42b6-a43f-fd88c15a135a","name":"Success (Convoluted)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments?start=2025-07-01&end=2025-07-31&convoluted=true","host":["https://api-public.payflow.es"],"path":["payments"],"query":[{"key":"start","value":"2025-07-01","description":"Start date for filtering payments (YYYY-MM-DD)"},{"key":"end","value":"2025-07-31","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\": [\"hZHzegeW\", \"s0lJ3k9LE\", \"wd3nfuHIz\"],\n \"user\": \"1234567890\",\n \"userPayrollId\": \"001\",\n \"amount\": 485000,\n \"fee\": 7500,\n \"informedToIntegration\": true,\n \"paid\": true,\n \"firstTransactionRequestedAt\": \"2025-07-09T08:30:15.000Z\",\n \"lastTransactionRequestedAt\": \"2025-07-11T14:20:30.000Z\",\n \"TransactionPaidAt\": \"2025-07-09T10:45:22.000Z\",\n \"lastTransactionPaidAt\": \"2025-07-11T16:15:45.000Z\"\n },\n {\n \"ids\": [\"yrwtcoOk\", \"qcxl3T6G\"],\n \"user\": \"9876543210\",\n \"userPayrollId\": \"002\",\n \"amount\": 235000,\n \"fee\": 4000,\n \"informedToIntegration\": false,\n \"paid\": false,\n \"firstTransactionRequestedAt\": \"2025-07-10T11:15:00.000Z\",\n \"lastTransactionRequestedAt\": \"2025-07-12T09:30:45.000Z\",\n \"TransactionPaidAt\": \"2025-07-10T11:15:00.000Z\",\n \"lastTransactionPaidAt\": \"2025-07-12T09:30:45.000Z\"\n },\n {\n \"ids\": [\"I2TvsKmf3\"],\n \"user\": \"5555444433\",\n \"userPayrollId\": \"003\",\n \"amount\": 120000,\n \"fee\": 2000,\n \"informedToIntegration\": true,\n \"paid\": true,\n \"firstTransactionRequestedAt\": \"2025-07-11T16:45:10.000Z\",\n \"lastTransactionRequestedAt\": \"2025-07-11T16:45:10.000Z\",\n \"TransactionPaidAt\": \"2025-07-11T18:20:30.000Z\",\n \"lastTransactionPaidAt\": \"2025-07-11T18:20:30.000Z\"\n }\n ]\n}"}],"_postman_id":"a52f86f6-f670-4135-ad28-823b75b3cc40"},{"name":"Pagos del Empleado","id":"495e122e-e333-4124-b966-fcbdf424036e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/payments/:personalId?start=&end=&cycle=","description":"Obtiene todos los pagos de anticipo de salario (retiros de salario devengado) solicitados por un empleado específico durante un período o ciclo determinado.
\nstartDate/endDate como cycle, el cycle tiene precedencia.\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"0c5cdc83-ea1f-4335-af49-5336d839a289","id":"0c5cdc83-ea1f-4335-af49-5336d839a289","name":"Payflow API (CO)","type":"collection"}},"urlObject":{"path":["payments",":personalId"],"host":["https://api-public.payflow.es"],"query":[{"description":{"content":"Nota: El campo
\ninformedToIntegrationen la respuesta puede ser ignorado. Como las integraciones están siendo migradas a microservicios, este valor siempre seráfalsepara sistemas más nuevos.
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":"9e5c57c8-a5fc-476b-9544-0bfd57e2ec15","description":{"content":"Documento de identidad del empleado
\n","type":"text/plain"},"type":"any","value":"","key":"personalId"}]}},"response":[{"id":"3da7a55e-cc6a-40c5-88db-7d95ac391ba2","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"}],"variable":[{"key":"personalId","value":"1234567890","description":"Employee document number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"hZHzegeW\",\n \"user\": \"1234567890\",\n \"userPayrollId\": \"001\",\n \"amount\": 150000,\n \"fee\": 2500,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-05-11T08:30:15.000Z\",\n \"paidAt\": \"2025-05-11T10:45:22.000Z\",\n \"message\": null,\n \"informedToIntegration\": true\n },\n {\n \"id\": \"s0lJ3k9LE\",\n \"user\": \"1234567890\",\n \"userPayrollId\": \"001\",\n \"amount\": 85000,\n \"fee\": 1500,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-07-09T14:20:30.000Z\",\n \"paidAt\": \"2025-07-09T16:15:45.000Z\",\n \"message\": null,\n \"informedToIntegration\": true\n },\n {\n \"id\": \"PUrIa56bH\",\n \"user\": \"1234567890\",\n \"userPayrollId\": \"001\",\n \"amount\": 200000,\n \"fee\": 3000,\n \"status\": \"processing\",\n \"paid\": false,\n \"requestedAt\": \"2025-05-08T11:45:00.000Z\",\n \"paidAt\": \"2025-05-08T11:45:00.000Z\",\n \"message\": null,\n \"informedToIntegration\": false\n },\n {\n \"id\": \"wd3nfuHIz\",\n \"user\": \"1234567890\",\n \"userPayrollId\": \"001\",\n \"amount\": 120000,\n \"fee\": 2000,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-06-05T09:15:10.000Z\",\n \"paidAt\": \"2025-06-05T11:30:25.000Z\",\n \"message\": \"Pago quincenal\",\n \"informedToIntegration\": true\n }\n ]\n}"},{"id":"9fb96b39-29fc-42d4-8f54-66e00c29bf7f","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":"cycle","value":"","description":"Payment cycle to filter results by month (YYYY-MM)","disabled":true},{"key":"status","value":"processed","description":"Payment status to filter results"}],"variable":[{"key":"personalId","value":"1235555890","description":"Employee document number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"495e122e-e333-4124-b966-fcbdf424036e"},{"name":"Pagos por ID","id":"7c42c8cd-f7e0-4d95-8edb-c2bd61baa1c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-public.payflow.es/payment/:id","description":"Obtiene un pago por identificador específico.
\n\n\nNota: El campo
\ninformedToIntegrationen la respuesta puede ser ignorado. Como las integraciones están siendo migradas a microservicios, este valor siempre seráfalsepara sistemas más nuevos.
id [string]: Identificador del pago
user [string]: ID personal del empleado
userPayrollId [string]: ID de nómina del empleado
amount [number]: Monto del pago
fee [number]: Comisión de procesamiento
status [string]: Estado del pago (ej., \"processed\")
paid [boolean]: Si el pago ha sido procesado
requestedAt [string]: Cuándo fue solicitado el pago (cadena ISO)
paidAt [string]: Cuándo fue procesado el pago (cadena ISO)
message [string, null]: Mensaje opcional
informedToIntegration [boolean]: Si el pago fue confirmado vía API
Identificardor del pago
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"14b27b7f-4df5-4b57-a5cd-5814da9dfe11","name":"payment","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":"hZHzegeW"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 31 May 2021 08:09:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"178"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"no-cache"},{"key":"accept-ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"hZHzegeW\",\n \"user\": \"1234567890\",\n \"userPayrollId\": \"001\",\n \"amount\": 150000,\n \"fee\": 2500,\n \"status\": \"processed\",\n \"paid\": true,\n \"requestedAt\": \"2025-07-11T08:30:15.000Z\",\n \"paidAt\": \"2025-07-11T10:45:22.000Z\",\n \"message\": null,\n \"informedToIntegration\": true\n }\n}"},{"id":"37c8d246-7038-4484-917b-723c86a18f86","name":"error payment","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":"asdbfDs","description":"Payment identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7c42c8cd-f7e0-4d95-8edb-c2bd61baa1c9"},{"name":"Archivo de Pagos","id":"f2250b73-abbb-4e49-8781-d116a0e8ccff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api-public.payflow.es/payments/:paymentCycle?format","description":"Obtiene todos los pagos solicitados en la empresa.
\nA través de este endpoint se puede solicitar un archivo de reembolsos para el período especificado (año-mes).
\nEl formato del archivo es:
\npayflowPayroll file format
\n","type":"text/plain"},"key":"format","value":null}],"variable":[{"id":"20a2dd1f-9dc3-484f-8e9f-eef4eefade1f","description":{"content":"Payment cycle month (YYYY-MM)
\n","type":"text/plain"},"type":"any","value":"","key":"paymentCycle"}]}},"response":[{"id":"10806007-a378-4a94-89b8-f1f281c34519","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"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":"8980"},{"key":"content-disposition","value":"attachment;filename=\"Meta 4 Cloud Demo-payflow-liquidacion.xlsx\""},{"key":"accept-ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"PK\u0003\u0004\u0014\u0000\b\u0000\b\u0000���R\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0013\u0000\u0000\u0000xl/theme/theme1.xml�YOo\u0013G\u0014��S��\u000e�\u0013;$\u0011\u0006ŎMZ\bD���8^��CfwV3�$�Up�T�*�z��[\u000fU[$�z��&-UK%�B���w�upR\u0010���dw�������^�~\u00123tD��\nObtiene todos los pagos solicitados por empleados de la empresa durante un período específico, formateado como un archivo de nómina específico.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Your-API-key-here"}]},"isInherited":true,"source":{"_postman_id":"0c5cdc83-ea1f-4335-af49-5336d839a289","id":"0c5cdc83-ea1f-4335-af49-5336d839a289","name":"Payflow API (CO)","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":null},{"description":{"content":"End date for filtering payments (YYYY-MM-DD)
\n","type":"text/plain"},"key":"end","value":null}],"variable":[]}},"response":[{"id":"939b59ea-05e8-4793-8782-3e016c39ac60","name":"payments File(with boundary dates)","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"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":"7938"},{"key":"content-disposition","value":"attachment;filename=\"asd-payflow-liquidacion.xlsx\""},{"key":"accept-ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"PK\u0003\u0004\u0014\u0000\b\u0000\b\u0000�]1T\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0013\u0000\u0000\u0000xl/theme/theme1.xml�YOo\u0013G\u0014��S��\u000e�\u0013;$\u0011\u0006ŎMZ\bD���8^��CfwV3�$�Up�T�*�z��[\u000fU[$�z��&-UK%�B���w�upR\u0010���dw�������^�~\u00123tD��\nCrea una solicitud de pago de anticipo de salario para un empleado específico.
\nAntes de procesar la solicitud, el sistema verifica que:
\nEl empleado tenga suficiente saldo disponible, basado en los días trabajados y configuraciones específicas de la empresa.
\nLa empresa tenga saldo suficiente para cubrir la transacción.
\nSi alguna validación falla, el pago no será creado.
\nImportante: Este endpoint debe ser explícitamente habilitado por el equipo de integraciones de Payflow. Si no está activado, todas las solicitudes serán rechazadas.
\npersonalId [string] [requerido]: Número de documento de identificación del empleado
amount [number] [requerido]: Monto del pago a solicitar en COP (mínimo: 1)
Upon successful creation:
\ndata [object]: Información del pago
id [number]: ID interno del pago (auto-generado)
identifier [string]: Identificador único del pago
amount [number]: Monto del pago (en COP)
fee [number]: Comisión de procesamiento (en COP)
requestedAt [string]: Cuándo fue solicitado el pago (cadena ISO)
status [string]: Estado del pago (ej., pending)
companyId [number]: ID de la empresa
employeeId [number]: ID del empleado
provider [string]: Proveedor de pago (ej., bancolombia)
employee [object]: Información del empleado
id [number]: ID interno del empleado
personalId [string]: Número de cédula del empleado
payrollId [string]: ID de nómina del empleado
firstName [string]: Nombre del empleado
lastName [string]: Apellido del empleado
iban [null]: null
subsidiary [object, null]: Información de la filial (si aplica)
id [number]: ID de la filial
taxId [string]: NIT de la filial
subsidiaryCode [string]: Código de la filial
name [string]: Nombre de la filial
legalName [string]: Razón social de la filial
400 Bad Request: Validación fallida (saldo insuficiente, monto inválido, etc.)
\n404 Not Found: Empleado no encontrado o pagos deshabilitados para la empresa
\n500 Internal Server Error: Error de procesamiento del servidor
\nConfigura callback para pagos procesados. Este endpoint permite configurar una URL donde Payflow enviará notificaciones cuando los pagos se procesen exitosamente.
\n[string]: URL donde se enviarán las notificaciones de pagos exitosos (requerido, debe ser una URI válida)Éxito (HTTP 200):
\nError de Validación (HTTP 400):
\n[string]: ID de la solicitud (formato JSON string)Usa este endpoint para confirmar que un pago ha sido informado a tu sistema de nómina.
\nRecomendamos llamar a este endpoint para que Payflow sepa qué pagos han sido reportados de tu lado, ayudando a asegurar una reconciliación más fácil entre sistemas.
\nPara más información, no dudes en contactarnos en integrations@payflow.es.
\n[array]: Array de identificadores de pago para marcar como informados (mínimo: 1 pago)[array]: Array de identificadores de pago que fueron marcados exitosamente como informadosObtiene el monto actualmente disponible para que un empleado retire a través de Payflow.
\nUsa este endpoint para consultar el saldo actualizado que un empleado puede solicitar basado en sus días trabajados y configuraciones de la empresa.
\navailable [number]: Monto disponible para retiro (valor redondeado hacia abajo)
amountReason [string|null]: Razón por la cual el monto es 0 (null si available > 0)
reducedAmountReason [string|null]: Razón por la cual el monto podría estar reducido (null si available = 0)
maximumSavingsRate [number]: Tasa máxima de ahorro para el empleado
withdrawn [number]: Monto total ya retirado en el ciclo actual
remainingSalary [number]: Salario restante después de los retiros
salaryEarnedInfo [object]: Información detallada sobre el salario devengado
Employee ID in your payroll software
\n","type":"text/plain"},"key":"payrollId","value":""},{"description":{"content":"Employee document number
\n","type":"text/plain"},"key":"personalId","value":""},{"description":{"content":"Employee ID in Payflow
\n","type":"text/plain"},"key":"Id","value":""}],"variable":[]}},"response":[{"id":"bbd45680-e387-4c25-8dbe-34527e07f18b","name":"Get info about amont available for a given employee","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api-public.payflow.es/payments/available?personalId=1023987123","protocol":"https","host":["api-public","payflow","es"],"path":["payments","available"],"query":[{"key":"personalId","value":"1023987123","description":"Employee document number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"available\": 450000,\n \"amountReason\": null,\n \"reducedAmountReason\": null,\n \"maximumSavingsRate\": 0.15,\n \"withdrawn\": 150000,\n \"remainingSalary\": 2200000,\n \"salaryEarnedInfo\": {\n \"totalEarned\": 1850000,\n \"earnedPercentage\": 0.52,\n \"cycleStartDate\": \"2025-07-01T00:00:00.000Z\",\n \"cycleEndDate\": \"2025-07-31T23:59:59.000Z\",\n \"daysWorked\": 10,\n \"totalDaysInCycle\": 31\n }\n}"}],"_postman_id":"422d9850-c384-47e5-b329-499dfcab57e7"}],"id":"95ed84ba-b64b-42d0-8497-37847f17cdc7","description":"Un pago representa una transferencia de dinero hecha a un empleado. Aunque Payflow se esfuerza por procesar los pagos tan rápido como sea posible, varios factores pueden causar retrasos o fallas.
Esta entidad proporciona información sobre el estado de cada pago, indicando si ha sido completado exitosamente, aún está en progreso, o ha fallado.
Cada pago pasa por un ciclo de vida, representado por el campo status:
pending: El pago ha sido solicitado pero aún no se ha enviado al banco.
processing: El pago ha sido enviado al banco y está esperando confirmación.
processed: El banco ha confirmado que el pago fue completado exitosamente.
canceled: La transacción fue cancelada por un usuario de Payflow. Este es un estado final — el pago no se realizará.
delayed: El pago ha sido enviado al banco, pero han pasado más de 5 minutos sin confirmación.
error: El banco reportó que el pago no pudo ser procesado. Este es un estado final — el pago no se realizará. Un campo adicional message contendrá los detalles del error del banco.