Este servicio permite notificar a la plataforma Mi Vereda que se ha generado un pago a través de recaudo en puntos físicos Efecty o SURED.
Headers
Name
Type
Description
Content-Type
string
application/json
Authentication
string
Api key de autenticación. Llave de autenticación enviada vía correo electrónico.
Request Body
Name
Type
Description
subscriberId
integer
Id que representa el suscriptor que ha realizado el pago.
businessId
integer
Id que representa el acueducto al que pertenece el suscriptor que realiza el pago
value
string
String que representa el valor cancelado por el suscriptor
status
string
Estado de la transacción
net
string
Nombre de la red usada para realizar el pago. EFECTY o SU RED.
pin
string
String que representa el pin de pagos usado para el recaudo.
apiKey
string
Llave de autenticación, enviada vía correo electrónico.
successUpdateMeasur
El valor apiKey es generado de manera automática y enviado vía correo electrónico.
Recuerda enviarlo tanto en el Headers como Authentication, como en el JSON en el campo apiKey
Posibles Notificaciones de Error
El servicio puede retornar los siguientes mensajes de error
JSON Incompleto
Cuando el Json es enviado con alguno de los datos nulos o no incluido, el servicio retornará el error Not Found - Empty Fields.
API Key Inválida
Cuando la llave de autenticación no coincide con la llave guardada en el sistema, el servicio retornará el error Not Found - API Key Invalid.
Id de Suscriptor Inválido
Cuando el id del suscriptor no se encuentra en la base de datos del sistema, el servicio retornará el error Not Found - Invalid SubscriberId
Pin o Id de acueducto Inválido
Cuando el PIN de pago enviado o el Id del acueducto enviados no se encuentran en la base de datos del sistema, el servicio retornará el error Not Found - Invalid Pin or BusinessId.
Error General
Cuando los datos enviados están correctos, pero el proceso de notificación del recaudo ha fallado, el servicio retornará el error errorUpdateMeasur
