Cargos recurrentes

En esta sección se describen los métodos disponibles en la sección de EnlacePagoRecurrente.

Este servicio puede ser utilizado para que los clientes se puedan suscribir y se les cargue mes a mes un monto definido por el comercio.

Posterior a creada la suscripción se les debe compartir a los clientes la urlEnlace para que puedan afiliarse al servicio. Esta afiliación debe ser aceptada manualmente por el usuario ya que está sujeta a términos y condiciones del servicio.

Creación de la suscripción/ enlace cargo recurrente

Este método permite la creación de una suscripción a cargo recurrente que luego podrá ser compartida a los clientes finales que desean suscribirse.

POST /EnlacePagoRecurrente

Objeto de petición

{
  "diaDePago": 0,
  "nombre": "string",
  "idAplicativo": "string",
  "monto": 0,
  "descripcionProducto": "string"
}

Definición de campos

Campo	Requerido	Tipo Dato	Descripción
diaDePago	Si	Entero	Día del mes en el cual se realizará el cargo a los clientes
nombre	Si	String	Nombre de la suscripción (servicio) a cobrarle a los clientes
idAplicativo	Si	String	Id del aplicativo/ comercio asociado al cargo recurrente. (APP ID dentro del panel, en el detalle de un comercio/ aplicativo)
monto	Si	Decimal	Monto del pago recurrente
descripcionProducto	Si	String	Descripción del producto o servicio a brindarle al cliente.

Respuesta de endpoint

JSON de ejemplo

{
  "idEnlace": "string",
  "urlEnlaceLargo": "string",
  "urlEnlace": "string",
  "estaProductivo": true,
  "urlQrCodeEnlace": "string"
}

Descripción de campos de respuesta

Campo	Tipo Dato	Descripción
idEnlace	String	Identificador único de la suscripción
urlEnlaceLargo	String	Url larga del cargo recurrentepara que los clientes puedan suscribirse
urlEnlace	String	Url corta del cargo recurrente para que los clientes puedan suscribirse
estaProductivo	Boolean	Indicativo si se encuentra activo o no la suscripción del cargo recurrente
urlQrCodeEnlace	String	URL con la imagen del código QR para poderla compartir como comercio a sus clientes

Otros endpoints disponibles

Endpoint	Descripción
GET /EnlacePagoRecurrente/id	Endpoint para obtener la información de un enlace recurrente (suscripción)
POST /EnlacePagoRecurrente/id	Permite desactivar un enlace recurrente (suscripción)
PUT /EnlacePagoRecurrente/id	Permite editar un enlace recurrente (suscripción)
GET /EnlacePagoRecurrente	Obtiene la lista de enlaces recurrentes de la cuenta
DELETE /EnlacePagoRecurrente/id/imagen	Elimina la imagen del enlace recurrente
POST /EnlacePagoRecurrente/id/imagen	Permite agregar una imagen (bytes) a un enlace recurrente
GET /EnlacePagoRecurrente/id/suscrpciones	Obtiene todos los suscritos a un enlace recurrente