Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
remoteId |
15615145-9 |
ID del Cliente con origen en la plataforma del cliente. TipoDato: Alfanumérico Formato: Largo máximo de 64 caracteres. Requerido. |
Name |
Felipe Godoy |
Nombre del Cliente. Tipo Dato: Alfanumérico Formato: Largo máximo de 100 caracteres. Requerido |
nationalId |
15615145-9 |
Identificador Nacional del Cliente. Por ej. una identificación nacional, un número de pasaporte o en su defecto un identificador con origen en la plataforma del cliente. Tipo Dato: Alfanumérico Formato: Largo máximo de 30 caracteres. Requerido. |
email |
example1@gmail.com |
Email del Cliente. Tipo Dato: Alfanumérico Formato: Largo máximo de 100 caracteres. Opcional. |
mobile |
56956751239 |
Número telefónico móvil del Cliente. Tipo Dato: Alfanumérico Formato: Largo máximo de 100 caracteres. Opcional. |
consumptions |
ver tabla 2 |
Arreglo de objetos del tipo Consumo de Cliente. Ver sus detalles en tabla 2. Requerido. |
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
remoteId |
C-1 |
ID del Consumo de Cliente con origen en la plataforma del cliente. Tipo Dato: Alfanumérico Formato: Largo máximo de 64 caracteres. Requerido |
description |
Crédito Hipotecario #456234 |
Descripción del Consumo de Cliente. Tipo Dato: Alfanumérico Formato: Largo máximo de 255 caracteres. Requerido |
currency |
CLP |
Tipo de Moneda de la cuenta de cobro Tipo Dato: Alfanumérico Formato: Largo máximo de 3 caracteres Posibles valores: CLP (Peso Chileno), UF (Unidad de Fomento en Chile), USD (Dólar Americano). Requerido |
items |
ver tabla 3 |
Arreglo de objetos del tipo Ítem de Consumo. Ver sus detalles en tabla 3. Requerido |
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
remoteId |
DEBT-1789 |
ID del Ítem de Consumo con origen en la plataforma del cliente. Tipo Dato: Alfanumérico Formato: Largo máximo de 64 caracteres. Requerido |
description |
Cuota mes Enero 2020 |
Descripción del Ítem de Consumo. Tipo Dato: Alfanumérico Formato: Largo máximo de 255 caracteres. Requerido |
amount |
320000.00 |
Monto total de deuda capital del Ítem de Consumo.Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Valor máximo de 99999999.99 Requerido |
penaltyAmount |
32000.0 |
Monto total de intereses de mora aplicada por atraso de pago de la deuda (deuda vencida). Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Valor máximo de 99999999.99. Requerido (0.00 si no existe penalidad aplicada) |
penaltyDays |
30 |
Los días de intereses de mora aplicada por atraso de pago de la deuda (deuda vencida). Tipo Dato: Numérico sin decimales Formato: Número entero. Valor máximo de 9999. Requerido (0 si no existe penalidad aplicada) |
penaltyType |
Interés mensual x% |
El detalle de los intereses de mora aplicada por atraso de pago de la deuda (deuda vencida).Tipo Dato: Alfanumérico Formato: Largo máximo de 255 caracteres. Opcional |
prejudicialCollectionAmount |
4700.00 |
Monto total por gastos de cobranza de la deuda (deuda vencida). Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Valor máximo de 99999999.99 Requerido (0.00 si no existe gastos de cobranza) |
balance |
356700.00 |
Monto total del saldo no pagado de la deuda. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Valor máximo de 99999999.99 Requerido |
issueDate |
2020-01-01 |
Fecha de la emisión de la deuda. Tipo Dato: Fecha Formato: yyyy-MM-dd (año 4 dígitos – mes 2 dígitos – día 2 dígitos) Requerido |
valuationAt |
2020-02-10 |
Fecha en que se valorizaron todos los montos asociados a la deuda. Puede ser entendida también como la fecha de última actualización de la deuda.Tipo Dato: Fecha Formato: yyyy-MM-dd (año 4 dígitos – mes 2 dígitos – día 2 dígitos) Opcional |
expirationAt |
2020-01-10 |
Fecha de vencimiento de la deuda (si la fecha es pasada entonces refiere a una deuda vencida). Tipo Dato: Fecha Formato: yyyy-MM-dd (año 4 dígitos – mes 2 dígitos – día 2 dígitos) Requerido |
minimumPay |
200000.00 |
Monto mínimo de pago posible, si es que se permite que usuarios pagadores puedan hacer pagos parciales a la deuda. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Valor máximo de 99999999.99. Opcional |
maximumPayt |
500000.00 |
Monto máximo de pago posible, si es que se permite que usuarios pagadores puedan hacer pagos mayores al monto total de la deuda. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Valor máximo de 99999999.99. Opcional |
details |
ver tabla 15 |
Arreglo de objetos del tipo Detalles de Ítem de Consumo. Ver sus detalles en tabla 15. Opcional |
Representa a la respuesta a la Solicitud de Carga Masiva de Deudas informadas
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
result |
OK |
Indica el resultado del proceso de carga masiva.Tipo Dato: Alfanumérico Formato: Largo máximo de 5 caracteres Posibles valores: OK (proceso fue realizado correctamente), error (existió un error en el proceso de los datos informados) Requerido |
detail |
Atributo XXX de Entidad YYY no fue informado |
Detalla los posibles problemas encontrados del proceso de carga masiva. Tipo Dato: Alfanumérico Formato: Largo máximo de 2.048 caracteres Opcional (sólo informado en result == error) |
Representa a un pago recibido por una transacción de pago exitoso en el proceso de pago de una o más deudas
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
transactionId |
20190225141000520C4 |
ID de transacción de pago con origen en la plataforma de UPago. El valor a enviar es único por transacción. Tipo Dato: alfanumérico Formato: Largo máximo de 64 caracteres Requerido |
token |
3C469E9D6C5875D37A43F353 D4F88 E61FCF812C66EEE3457465A4 0 B0DA4153E0 |
Token que UPago asigna para la transacción. Siempre es un valor único por transacción. Tipo Dato: Alfanumérico Formato: Si el cliente lo requiere, se recomienda almacenar esta información en un campo del tipo TEXT en base de datos para efectos de compatibilidad futura. Requerido |
paymentAt |
2019-02-25T20:10:00.000Z |
Fecha y hora en que se cursó el pago. Tipo Dato: Fecha con hora y zona Formato: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. Su valor siempre es devuelto en UTC 0 hora global. Requerido |
paymentLocalDateAt |
2019-02-25T06:10:00.000-04:00 |
Fecha y hora Local en que se cursó el pago. Tipo Dato: Fecha con hora y zona Formato: yyyy-MMdd'T'HH:mm:ss.SSSXXX. Requerido |
paymentAccountingDate |
2019-02-26 |
Fecha contable del pago. Similar a una fecha contable bancaria de una transacción. Tipo Dato: Fecha Formato: yyyy-MM-dd Requerido |
amount |
235000.00 |
Monto pagado por usuario en la transacción. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Requerido |
currency |
CLP |
Moneda de pago utilizada en la transacción. Posibles valores: CLP (peso chileno). UF (unidad de fomento - Chile). USD (dólar estadounidense). Tipo Dato: Alfanumérico Formato: Largo máximo de 3 caracteres Requerido |
paymentGateway |
PASARELA_DE_PAGO |
Pasarela de pago utilizada en la transacción. Posibles valores según los medios de pago habilitados por UPago para el cliente. Tipo Dato: Alfanumérico Formato: Largo máximo de 50 caracteres Requerido |
status |
PAID |
Estado del pago en la transacción. Posibles valores: PAID (pagorecibido). Tipo Dato: Alfanumérico Formato: Largo máximo de 50 caracteres Requerido |
customer |
ver tabla 1 |
Corresponde a un objeto del tipo Cliente que realizó el pago. Ver sus detalles en tabla 1. Requerido |
itemsPaid |
ver tabla 6 |
Corresponde a un arreglo de objetos del tipo Ítem de Consumo que fueron pagados y/o abonados en esta transacción. Ver sus detalles en tabla 3. Requerido |
gatewayResponse |
ver tabla 7 |
Corresponde a un objeto del tipo Respuesta de Pasarela de Pago donde se procesó efectivamente el pago. Ver sus detalles en tabla 6. Requerido |
Representa a un ítem pagado en la transacción de pago con sus detalles
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
item |
ver tabla 3 |
Corresponde a un objeto del tipo Ítem de Consumo que fue pagado y/o abonado en esta transacción. Ver sus detalles en tabla 3. Requerido |
paymentAmount |
356700.00 |
Monto total que fue pagado en esta deuda. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Requerido |
Representa a un ítem pagado en la transacción de pago con sus detalles
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
transactionId |
ecfcb13fb7fd390def245531b48 a6380e10a82d17ebff5b4afdf2f0d444554et |
ID de transacción de pago con origen en la plataforma de la Pasarela de Pago donde se procesó efectivamente el pago. El valor a enviar es único por transacción. Tipo Dato: Alfanumérico Formato: Si el cliente lo requiere, se recomienda almacenar esta información en un campo del tipo TEXT en base de datos para efectos de compatibilidad futura. Opcional |
paymentMethodCode |
VN |
Corresponde al código del método de pago con origen en la plataforma de la Pasarela de Pago. Tipo Dato: Alfanumérico Formato: Largo máximo de 50 caracteres Opcional |
accountingDate |
0226 |
MCorresponde a la fecha contable del pago con origen en la plataforma de la Pasarela de Pago. Tipo Dato: Alfanumérico Formato: Largo máximo de 15 caracteres Opcional |
Representa a una rendición diaria de recaudación con el detalle de sus pagos recibidos confirmados y reversados
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
accountingDate |
2020-02-26 |
Fecha contable de la rendición diaria de recaudación. Tipo Dato: Fecha Formato: yyyy-MM-dd Requerido |
businessPaymentDate |
2020-02-28 |
Fecha de abono de dinero a cuenta bancaria de cliente correspondiente al monto total de cliente en rendición diaria de recaudación. Tipo Dato: Fecha Formato: yyyy-MM-dd Requerido |
confirmedTotalAmount |
1214000.00 |
Monto total de los pagos recibidos que fueron confirmados en el cierre de rendición diaria de recaudación. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Requerido |
confirmedServiceFeeTotalAmount |
11533.00 |
Monto total de cliente según los pagos recibidos que fueron confirmados en el cierre de rendición diaria de ecaudación descontando la comisión por servicio UPago. Este monto es la diferencia entre confirmedTotalAmount y confirmedServiceFeeTotalAmount. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Requerido |
confirmedBusinessTotalAmount |
1202467.00 |
Fecha contable del pago. Similar a una fecha contable bancaria de una transacción. Tipo Dato: Fecha Formato: yyyy-MM-dd Requerido |
confirmedTransactions |
ver tabla 5 |
Corresponde a un arreglo de objetos del tipo Pago Recibido que fueron confirmados en el cierre de esta rendición diaria de recaudación. Ver sus detalles en tabla 5. Requerido |
reversedTotalAmount |
290000.00 |
Monto total de los pagos recibidos que fueron reversados en el cierre de rendición diaria de recaudación. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Requerido |
reversedServiceFeeTotalAmount |
2755.00 |
Monto total de comisión por servicio UPago según los pagos recibidos que fueron reversados en el cierre de rendición diaria de recaudación. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Requerido |
reversedBusinessTotalAmount |
287245.00 |
Monto total de cliente según los pagos recibidos que fueron reversados en el cierre de rendición diaria de recaudación descontando la comisión por servicio UPago. Este monto es la diferencia entre reversedTotalAmount y reversedServiceFeeTotalAmount. Tipo Dato: Numérico con 2 decimales Formato: División decimal indicado por un punto. Sin carácter separador de miles. Requerido |
reversedTransactions |
ver tabla 5 |
Corresponde a un arreglo de objetos del tipo Pago Recibido que fueron reversados en el cierre de esta rendición diaria de recaudación. Ver sus detalles en tabla 5. Requerido |
Lista todos los estados que pueden tener los pagos recibidos confirmados y reversados
Estado |
Descripción |
PAID |
El pago recibido fue confirmado exitosamente por el medio de pago empleado por el usuario. |
REVERSED_BY_PAYMENTPROCESSOR |
El pago fue reversado por la pasarela de pago empleada por el usuario en el proceso de pago. |
PAID |
El pago fue reversado por solicitud del Negocio asociado al pago (1). |
(1) Soportado sólo en algunos negocios o rubros comerciales.
Representa a la lista de identificadores remotos (lista de remoteId) de Ítems Pagados de forma externa y que pertenecen a un mismo Cliente
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
itemsPaid |
ver tabla 10 |
Corresponde a un arreglo de objetos del tipo remoteId de Ítem de Consumo que fueron pagados y/o abonados de forma externa. Ver sus detalles en tabla 10. Requerido |
Representa al identificador remoto (remoteId) de un Ítem Pagado de forma externa
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
remoteId |
DEBT-2123 |
ID del Ítem de Consumo con origen en la plataforma del cliente. Requerido |
UPago envía al cliente un ejemplo de esta estructura de JSON en correo oficial de inicio de habilitación.
Representa a la lista de identificadores remotos (lista de remoteId) y sus resultados de procesamiento de los Ítems Pagados de forma externa previamente informados
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
itemsProcessed |
ver tabla 12 |
Corresponde a un arreglo de objetos del tipo remoteId de Ítem de Consumo y sus resultados de procesamiento. Ver sus detalles en tabla 12. Requerido |
Representa a la respuesta a resultado de procesamiento de Ítem Pagado de forma externa
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
remoteId |
DEBT-2123 |
ID del Ítem de Consumo procesado con origen en la plataforma del cliente. |
result |
OK |
Indica el resultado del proceso de notificación de Ítems Pagados de forma externa. Tipo Dato: Alfanumérico formato: Largo máximo de 5 caracteres Posibles valores: OK (proceso fue realizado correctamente), error (existió un error en el proceso de los datos informados) Requerido |
detail |
Item not found or not associated to Customer |
Detalla los posibles problemas encontrados del proceso de registro. Tipo Dato: Alfanumérico Formato: Largo máximo de 2.048 caracteres Opcional (sólo informado en result == error) |
Representa a la respuesta a la Solicitud de Carga de un Cliente con sus Deudas informadas
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
result |
OK |
Indica el resultado del proceso de registro. Tipo Dato: Alfanumérico Formato: Largo máximo de 5 caracteres Posibles valores: OK (proceso fue realizado correctamente), error (existió un error en el proceso de los datos informados) Requerido |
detail |
Atributo XXX de Entidad YYY no fue informado |
Detalla los posibles problemas encontrados del proceso de registro. Tipo Dato: Alfanumérico Formato: Largo máximo de 2.048 caracteres Opcional (sólo informado en result == error) |
Representa al conjunto de detalles (descriptivos o de contenido) asociados a un ítem de un Consumo.
Nombre Atributo |
Valor de Ejemplo |
Descripción / Tipo Dato / Formato |
remoteId |
DEBT-1789-1 |
ID del Descriptor. Origen en la plataforma del cliente. Tipo Dato: Alfanumérico Formato: Largo máximo de 64 caracteres. Requerido |
name |
Ver Sitio |
Nombre del campo a incluir en detalle. En caso de ser LINK, corresponderá al descriptor del enlace. Tipo Dato: Alfanumérico Formato: Largo máximo de 50 caracteres. Requerido |
value |
https://www.upago.cl/ |
Valor del campo a incluir en detalle. En caso de ser LINK, corresponderá a la dirección del enlace. Tipo Dato: Alfanumérico Formato: Largo máximo de 255 caracteres. Requerido |
type |
1 |
Tipo del contenido a mostrar del detalle 0: Texto; 1: Link Tipo Dato: Binario Formato: 0 ó 1 Requerido |