Payouts express
Para acceder a la funcionalidad de Payouts exprés, abra su consola de Comercios y seleccione Payout, luego Payouts exprés.
Beneficios
- Configuración instantánea sin necesidad de integrarse mediante API.
- Rapidez y flexibilidad gracias a la carga por lotes.
- Centralice sus Payouts con mínimo esfuerzo.
¿Cómo utilizar Payouts exprés?
Payouts exprés le brinda una secuencia fácil de llevar que le permite crear uno o más Payouts de forma simultánea. Una vez completado un paso, la secuencia activa el siguiente para evitar errores.
A continuación, describimos cada paso y le damos instrucciones.
1. Descargar la plantilla
El primer paso es descargar la Plantilla de Payouts exprés. Este archivo de Excel tiene toda la información relacionada a un Payout y da ejemplos de cómo diligenciarlo.
Haga clic en el botón Descargar plantilla para obtener el archivo de Excel.
Una vez tenga el archivo de Excel, puede diligenciarlo con la información de los Payouts. Cada fila representa una solicitud de Payout y tiene las siguientes columnas.
| Campo | ¿Obligatorio? | Descripción | |
|---|---|---|---|
| Country | Sí | Código ISO del país en formato ISO 3166-2.Listado de países disponibles de Payouts. | |
| Amount | Sí | Monto del Payout, el formato tiene dos dígitos decimales. Ejemplo 100 => $ 1,00. | |
| Currency | Sí | Código ISO de la moneda de su cuenta, que corresponde a la moneda de origen. Consulte aquí la lista de monedas. | |
| destinationCurrency | Sí | Código ISO de la moneda en la que el beneficiario recibirá el pago. Esta moneda debe corresponder al modelo de su cuenta. Por ejemplo:
Consulte aquí la lista de monedas. | |
| Reason | No | Descripción del Payout. | |
| Reference | Sí | Identificador único del Payout definido por usted. Esta referencia no debe aparecer más de una vez en el archivo ni existir en Payouts anteriores. | |
| Type | Sí | Tipo de transferencia del Payout. Lista de tipos de transferencia para Payouts. | |
| Payee.FirstName | Sí2 | Nombre del Beneficiario. | |
| Payee.LastName | Sí2 | Apellido del Beneficiario. | |
| Payee.CompanyName | Sí2 | Nombre de la persona jurídica (empresa). | |
| Payee.Email | No | Dirección de correo electrónico del Beneficiario. | |
| Payee.Phone | No | Número de teléfono del Beneficiario. | |
| Payee.Address | No | Dirección del Beneficiario. | |
| Payee.Document.Type | Sí | Tipo de documento del Beneficiario. Encuentre la lista de documentos aquí. | |
| Payee.Document.Number | Sí | Número de documento del Beneficiario. | |
| Payee.BankAccount.Number | Sí1 | Número de cuenta del Beneficiario. Tenga en cuenta las siguientes consideraciones:
| |
| Payee.BankAccount.Type | Sí1 | Tipo de cuenta del Beneficiario. Asigne 1 para Cuenta corriente y 2 para Cuenta de ahorros. | |
| Payee.BankAccount.CodeBank | Sí1 | Código del banco del Beneficiario. | |
| Payee.BankAccount.Branch | No | Código de la sucursal del banco del Beneficiario. Este campo solo aplica para Brasil y es obligatorio cuando utilice transferencia bancaria como tipo de Payout. | |
| Notification_Url | No | Webhook para notificar el resultado del Payout. Para más información sobre la configuración de este webhook, consulte este artículo. |
1 Cuando utilice Transferencias Bancarias, estos parámetros son obligatorios para TODOS los países. Para Transferencias Bancarias Instantáneas en Brasil, las columnas Payee.BankAccount.Type, Payee.BankAccount.CodeBank y Payee.BankAccount.Branch no deben estar presentes en el request.
2 Son mandatorios los campos firstName y lastName para persona física y companyName para persona jurídica (empresa). Si se envía un payout para empresa solo se tiene que completar el campo companyName, y si se envía un payout a una persona física solo se tienen que completar los campos firstName y lastName.
Importante sobre Payouts exprés
- No modifique el archivo descargado agregando nuevas columnas, hojas o cambiando el nombre de las columnas.
- La funcionalidad soporta un máximo de 100 registros por archivo. Si necesita incluir más, repita el procedimiento para los Payouts restantes.
- Si ya tiene la plantilla descargada, no es necesario descargarla de nuevo.
- Puede guardar el archivo utilizando cualquier nombre.
- Cuando se utiliza PIX, es necesario configurar la clave PIX del beneficiario como se explica en la sección Campos adicionales para PIX.
Columnas adicionales para PIX
Al configurar PIX como tipo de pago del Payout (columna Type con el valor 4), debe incluir una columna adicional de aqcuerdo con la clave PIX del beneficiario. Puede configurar cualquiera de las siguientes columnas, agregándolas junto a la columna Notification_Url, es decir, la columna U del archivo Excel:
PixDocument: agregue esta columna para configurar el número CPF/CNPJ del beneficiario. El número de dígitos para CPF debe ser 11, y CNPJ debe ser 14.PixEmail: agregue esta columna para configurar la dirección de correo electrónico del beneficiario.PixPhone: agregue esta columna para configurar el número de teléfono del beneficiario. El número debe empezar por+55, y la celda debe estar configurada con formato de texto para permitir el uso del signo más.PixRandom: agregue esta columna para configurar la clave aleatoria que genera el beneficiario.
Debe agregar una columna por cada clave diferente en sus pagos. Por ejemplo, si tiene cinco beneficiarios, uno utiliza la dirección de correo electrónico, uno utiliza el número de teléfono, dos utilizan el número CPF/CNPJ y uno utiliza la clave aleatoria, debe incluir las columnas de la siguiente manera:
No incluya una columna si no tiene un valor.
2. Seleccionar la cuenta
El segundo paso involucra escoger la cuenta de la que se debitarán los montos de los Payouts. Asegúrese de que la cuenta seleccionada tenga saldo suficiente para procesarlos todos.
Abra la lista desplegable Selecciona la cuenta y seleccione la cuenta que desea utilizar.
3. Cargar la plantilla
Una vez seleccione la cuenta en el paso 2, el proceso activa este paso. Haga clic en el botón Cargar plantilla para cargar el archivo creado en el paso 1.
4. Resultados de la carga
Si todos los payouts fueron correctos y no hubo errores en el archivo, el sistema informa el número de Payouts creados.
En caso contrario, la funcionalidad de Payouts exprés informa el número de Payouts exitosos y fallidos. Puede consultar los Payouts fallidos en el archivo de Excel que generamos utilizando el enlace disponible.
Consulte la última columna en el archivo para saber el error del Payout.
Luego de corregir el error, guarde el archivo y cárguelo nuevamente utilizando la opción en el paso 3.
Independiente de si el Payout fue exitoso, puede consultarlo en el Reporte de Payouts. Los Payouts exitosos tienen el estado Pendiente mientras que los fallidos, tienen el estado Declinado.
