Skip to main content

Solicitud de cobro

Conceptos Generales​

Las solicitudes de cobro son una de las formas más simples de cobrar a un cliente dentro de Zenrise. Toma como parámetro los datos del cliente, montos y fechas de vencimiento y genera 2 links principales:

  • Link de pago con tarjeta
  • Cupón de pago para rapipago y pagofacil

Estos links pueden ser enviados al email del cliente en este mismo proceso.

Crear una solicitud de cobro​

URL: /v1/requests/simple

Método: POST

Requiere Auth: Sí, ver Autenticación

Request Payload:

{
  "amount": 0,
  "contact": {
    "email": "string",
    "externalReference": "string",
    "firstName": "string",
    "lastName": "string",
    "holderDocumentNumber":"string", //opcional
    "documentType":"string" // opcional CUIT o DNI
  },
  "description": "string",
  "externalReference": "string",
  "firstDueDate": "2020-06-25",
  "percentageAfterFirstDueDate": 0,
  "percentageAfterSecondDueDate": 0,
  "amountAfterFirstDueDate": 0,
  "amountAfterSecondDueDate": 0,
  "secondDueDate": "2020-06-25",
  "sendPerEmail": true,
  "paymentMethods": [ 1, 2, 9, 21, 25 ], // OPCIONAL por defecto están todos
  "qrEnabled": true, // OPCIONAL, default true
  "debinEnabled": true, // OPCIONAL, default true
  "backUrl":{ // OPCIONAL
    "success":"https://url-de-exito.com",
    "failure":"https://url-de-fallo.com"
  }
}

Detalles importantes del Payload:

paymentMethods

  • 1 -> Pago Facil
  • 2 -> Rapipago
  • 9 -> Tridi (Transferencia identificada)
  • 21 -> Pago Mis Cuentas
  • 25 -> Link Pagos
  • 34 -> QR
  • 98 -> Solo tarjeta de débito
  • 99 -> Solo tarjeta de crédito
  • 100 -> Tarjetas

Importante — los códigos no funcionan todos igual:

  • Medios aditivos (1, 2, 9, 21, 25, 34): no son excluyentes. Indican de qué medios querés obtener la referencia de pago en la respuesta (código de barras de Pago Fácil/Rapipago, referencia de Pago Mis Cuentas, Link y la cadena de QR). No deshabilitan ningún otro medio, y el pago con tarjeta (checkoutLink) se genera siempre. Por ejemplo, enviar [34] (QR) agrega qrString a la respuesta, pero no impide pagar con tarjeta ni oculta los demás medios.
  • Pseudo-medios de tarjeta (98, 99, 100): sí restringen lo que ve el pagador en el checkout:
    • 98 (solo tarjeta de débito): limita la tarjeta a débito (oculta la tarjeta de crédito). No afecta al DEBIN ni al QR.
    • 99 (solo tarjeta de crédito): deja únicamente la tarjeta de crédito (oculta la tarjeta de débito, el DEBIN y el QR).
    • 100 (solo tarjetas): habilita tarjeta de débito y de crédito, y oculta el DEBIN y el QR.

No se recomienda combinar un pseudo-medio (98/99/100) con medios aditivos, ni enviar más de un pseudo-medio a la vez (son configuraciones de tarjeta contradictorias entre sí). Enviá, como máximo, uno de 98/99/100, o una lista de medios aditivos.

El DEBIN no se solicita a través de paymentMethods. Se controla con el campo opcional debinEnabled del body (true/false, por defecto true). De forma análoga, qrEnabled (por defecto true) controla la opción de pago con QR en el checkout.

contact: La entidad contact es la persona pagadora, siendo obligatoria una de estas opciones:

  • email
  • externalReference
  • firstName y lastName

Además se pueden enviar los datos de identificación del contacto para matcheo de pagos por TRI-DI.

holderDocumentNumber El número de documento identificatorio del contacto. Si es enviado, se debe enviar también documentType. documentType El tipo de documento del contacto, admite dos valores posibles: DNI o CUIT.

El campo externalReference dentro de contacto se usa para identificar inequívocamente al mismo y sincronizar con el sistema de origen de esta operación. La API de Zenrise buscará si ya existe un contacto con ese externalReference para la empresa, si existe usará el mismo, si no lo creará. Valores comunes que se utilizan son: ID, DNI, CUIT, etc.

externalReference Este campo es el ID de la solicitud es lo que identifica inequívocamente esta transacción para la empresa. Valores comunes son: ID, Nro. de Factura, Nro. de Transacción.

sendPerEmail Puede ser true o false, dependiendo de ese valor Zenrise enviará por email al cliente los links de cobro.

backUrl De manera opcional puede configurar nuestra pantalla de checkout para que luego de éxito o falla redirija a una URL que usted nos pase.

percentageAfterFirstDueDate y percentageAfterSecondDueDate son los porcentajes de recargo que se aplicarán a la deuda si el pago es realizado después de la fecha de vencimiento.

amountAfterFirstDueDate y amountAfterSecondDueDate son los montos fijos de recargo que se aplicarán a la deuda si el pago es realizado después de la fecha de vencimiento.

Request Response:

{
    "amount": 550.0,
    "couponLink": "https://render.zenrise.io/zen/requests-pdf/d/1ovQlA6pRZ",
    "pmcPaymentReference": "00534849",
    "requestId": 1994023,
    "contact": {
        "id": 534849,
        "username": "pp.534849",
        "fullName": "pp, Nicolas",
        "password": "pp.534849",
        "chash": "nVRNV3pGRX",
        "externalReference": "PRUEBA",
        "email": "nicolas@zenrise.io"
    },
    "invoiceId": 2393949,
    "barcodePagoFacil": "265400115500230195348491239394900000000021",
    "checkoutLink": "http://dev.checkout.zenrise.io?token=e0c9cc59-1abd-402a-a45f-e19541b1e112",
    "barcodeRapipago": "11100534849122211100023939490011550023019000000002",
    "qrString": "eysqkwjednsjqueaoqlwksnwjsiiqkkwlakkskhhwuuwooqppwllwksjdnjhehwuwio",
    "linkPagoPaymentReference": "0000534849",
    "cardTransactionRequestId": "e0c9cc59-1abd-402a-a45f-e19541b1e112"
}

Detalles importantes del Response:

couponLink y checkoutLink son los dos campos más importantes de esta response ya que representan el pdf con los datos de pago (para rapipago, pagofácil) y el link para pago con tarjeta.

barcodePagoFacil y barcodeRapipago son los links para generar el código de barras para rapipago y pagofacil.

pmcPaymentReference y linkPagoPaymentReference son los campos que identifican inequívocamente la solicitud de cobro para los medios de pago Pago Mis Cuentas y Link Pagos.

invoiceId es el ID de la factura generada para esta solicitud de cobro.

cardTransactionRequestId es el identificador de la sesión de pago con tarjeta; se devuelve siempre, junto con checkoutLink.

Tener en cuenta: La respuesta de barcodePagoFacil, barcodeRapipago, pmcPaymentReference y linkPagoPaymentReference solo se genera si el medio de pago está incluido en la lista de paymentMethods o si la misma viene vacía. El campo qrString solo se incluye si paymentMethods contiene el 34 (QR); si no, no aparece en la respuesta.