Actualizar dispersión
Modifica o habilita una dispersión previamente creada. Únicamente aplica para dispersiones que se encuentre en un estado de programadas scheduled o que estén en created sin que hayan sido confirmadas.
Ruta
PATCH /v1/merchant/payout/{external_reference}
Encabezado
Content-Type
application/json
x-auth-token*
{token}
Cuerpo
Al actualizar esta dispersión, puedes completar o cambiar únicamente los siguientes campos. Ten en cuenta que los nuevos valores reemplazarán los anteriores, por lo que se perderá la información anterior.
Es importante destacar que los bloques dereceiver y bank_account deben ser modificados en su totalidad. Es decir, que si quieres cambiar
currency
Código que identifica la divisa del pago en formato ISO 4217.
COP | USD
amount
Valor de la dispersión. No incluir decimales (comas o puntos).
Ejemplo: 54000
description
Hace referencia a la descripción de la dispersión. Máximo 200 caracteres.
Ejemplo: Caja de chocolates x12 unidades, sabores variados.
reference_one
reference_two
reference_three
reference_four
Información adicional de la dispersión (número de factura, ordenes de compra, categoría), visible para los usuarios.
Ejemplo: FT-2034
channel
Es la forma como se notifica al usuario de la dispersión.
whatsapp | email | none
additional_channel
Es un canal adicional para notificar al usuario de la dispersión.
whatsapp | email | none
additional_channel_value
El número de celular o correo electrónico según el additional_channel que se haya escogido.
Obligatorio si existe additional_channel.
type
Es el método que se usará para la dispersión.
normal | instant | scheduled
send_date
Es la fecha en la que se debe realizar la dispersión programada al destinatario.
Formato: AAAA/MM/DD
Ejemplo: 2025/01/30
Obligatorio si el status es scheduled
attachment
Adjunto que funciona como soporte de la dispersión.
Información cliente/receptor
El objeto receiver es opcional. Cuenta con los siguientes campos:
receiver.phone
Número de celular del destinatario (incluir el código de área del país)
Ejemplo: 573112223333
Obligatorio si channel es whatsapp o none.
receiver.email
Correo del destinatario al que se enviarán las notificaciones.
Ejemplo: [email protected]
Obligatorio si channel es email o si no existe receiver.phone.
receiver.first_name*
Nombres del destinatario.
Ejemplo: Andrés
receiver.last_name
Apellidos del destinatario.
Ejemplo: Ramírez
receiver.id_type*
Tipo de documento de identificación del destinatario.
CC | CE | NIT | PASAPORTE | DNI | EIN
receiver.id_number*
Número del documento de identificación del destinatario.
Ejemplo: 11119999
Información del aprovador
El objeto approval es opcional. Cuenta con los siguientes campos:
approval.type*
Tipo de autorización definida para la dispersión.
none | message | otp
approval.phone
Número de celular del usuario que va a aprobar la dispersión (incluir el código de área del país). El usuario debe tener rol admin o coordinator.
Ejemplo: 573112223333
Obligatorio si el approval.type es message. Solo se debe suministrar el approval.phone o el approval.email.
approval.email
Correo del destinatario que va a aprobar la dispersión. El usuario debe tener rol admin o coordinator.
Ejemplo: [email protected]
Obligatorio si el approval.type es message. Solo se debe suministrar el approval.phone o el approval.email.
Información del banco receptor
El objeto bank_account es opcional. Cuenta con los siguientes campos:
bank_account.entity*
Código que identifica a la entidad bancaria del destinatario. Ver cómo consultar códigos.
Ejemplo: 1007
bank_account.type*
Tipo de cuenta a la que se va realizar la dispersión.
savings | checking | agreement
[savings = ahorros checking = corriente agreement = convenio]
bank_account.number*
Número de cuenta a la que se va realizar la dispersión.
Ejemplo: 123456789
bank_account.reference
Referencia adicional para el pago en la entidad bancaria. Aplica únicamente para agreement.
Respuesta
Ejemplo
Última actualización