- Portal comercial de Localpayment: Interfaz fácil de usar para la gestión manual de transacciones.
- Integración de API: Acceso programático para el procesamiento automatizado de pagos.
Antes de comenzar
Asegúrate de tener:- Credenciales API válidas (token de acceso).
- Información completa del beneficiario.
- Configuración adecuada de la cuenta para el país de destino.
- Comprensión de los requisitos específicos de cada país (véase Requisitos por país a continuación).
Paso 1: Inicializar la transacción de pago
Para crear un payout mediante transferencia bancaria, envía una solicitudPOST al endpoint Create a Payout con paymentMethod.type establecido en "BankTransfer".
Endpoint
Encabezados obligatorios
Parámetros clave de la solicitud
La solicitud requiere varios objetos clave:Ejemplo de solicitud (Argentina)
curl
Paso 2: Gestionar la respuesta
Respuesta exitosa
Una respuesta exitosa incluye información detallada de la transacción e identificadores de seguimiento:Campos de respuesta clave
Respuesta de error
Cuando una solicitud falla, recibirás información detallada sobre el error:Paso 3: Seguimiento del estado de la transacción
Después de realizar un pago, supervisa su progreso mediante estos métodos:Webhooks (recomendado)
Recibe notificaciones en tiempo real cuando cambie el estado de la transacción. Más eficiente para entornos de producción.
Endpoint de la API de estado
Consulta el estado de las transacciones mediante programación. Útil para sondear o recuperar notificaciones de webhook perdidas.
Vista del Business Portal
Interfaz visual para el seguimiento de transacciones. Ideal para la supervisión manual y el análisis detallado de las transacciones.
Códigos de estado comunes
Referencia completaConsulta todos los códigos de estado en nuestra documentación sobre el estado de las transacciones.
Paso 4: Aprobación de la transacción
Para mayor seguridad, ciertas transacciones requieren la aprobación de dos personas:- Iniciador: Envía la solicitud de pago.
- Aprobador: Revisa y confirma la transacción.
Nota de seguridadLos requisitos de aprobación ayudan a prevenir transacciones no autorizadas y a garantizar el cumplimiento de las normativas locales.
Requisitos específicos de cada país
Los detalles de implementación varían según el país. Cualquier país no mencionado explícitamente se rige por el procedimiento estándar sin requisitos especiales. Revisa estos requisitos antes de la integración:- Brasil
- Chile
- Colombia
- República Dominicana
- México
- Perú
Requisitos especiales:
beneficiary.bank.branches obligatorio cuando envías el payout con un número de cuenta (beneficiary.bank.account.number). Esto se aplica tanto a las transferencias TED como a las Pix realizadas a una cuenta. Si lo omites, el payout se rechaza con el error 300 (beneficiary.bank.branchmust not be null) y el error 701 (Invalid bank branch code).code: Obligatorio. El código de la sucursal en el formato exigido por el banco.name: Opcional. El nombre completo de la sucursal bancaria.
- Cuando envías el payout con una clave Pix (
beneficiary.bank.account.alias),beneficiary.bank.branches opcional. merchant.addresses obligatorio y debe incluircountry.country: Obligatorio. El código de país ISO de 3 letras de la dirección del comercio (por ejemplo,BRA).- Los demás campos de
merchant.addressson opcionales.
- El destinatario debe tener una clave Pix registrada.
-
Debes proporcionar esta clave en la propiedad
beneficiary.bank.account.alias. Nota: Las propiedades beneficiary.bank.account.type y beneficiary.bank.account.number deben excluirse de la solicitud.
- CPF (Registro Individual de Contribuyentes)
- CNPJ (Registro Nacional de Personas Jurídicas)
- Número de teléfono celular
- Dirección de correo electrónico
- Clave aleatoria: Un código único de 32 caracteres generado por el Banco Central. Esta opción permite a los beneficiarios recibir pagos sin compartir información personal.
Probando tu integración
Entorno de pruebas
Utiliza el entorno de prueba para realizar las pruebas:Escenarios de prueba
Verifica que tu integración gestione estos escenarios:- Transacción exitosa: Flujo de pago estándar
- Errores de validación: Cuenta bancaria no válida, campos faltantes
- Retrasos en el procesamiento: Transacciones que requieren tiempo para procesarse.
- Transacciones fallidas: Fondos insuficientes, beneficiarios bloqueados
- Actualizaciones de estado: Gestión de webhooks y sondeo de estado
Recursos y próximos pasos
Maximiza el éxito de tu integración con estos recursos esenciales.Integración de webhooks
Configura notificaciones en tiempo real para las actualizaciones del estado de las transacciones.
Portal de informes empresariales
Accede a análisis detallados, herramientas de generación de informes y funciones de conciliación.
Monitoreo de transacciones
Aprende a consultar el estado de las transacciones e implementar un seguimiento exhaustivo.
Referencia de la API
Documentación completa del endpoint con ejemplos interactivos.
Consejo profesionalSiempre prueba tu flujo de trabajo en nuestro entorno de pruebas antes de implementarlo en producción. Esto garantiza que el manejo de errores, el procesamiento de webhooks y el seguimiento del estado funcionen correctamente en todos los escenarios.
¿Necesitas ayuda?Ponte en contacto con nuestro equipo de soporte si experimentas algún problema o necesitas ayuda con la integración.

