Conexión a ERP

Con recauda erp podrás proporcionar un endpoint de tipo get por el cual consultaremos la información de pagos que desees realizar a un cliente a partir de un número de identificación, de tal manera que cada vez que tu cliente ingrese al portal de recaudo e ingrese su numero de identificación, nosotros consultaremos el endpoint proporcionado y poder mostrarle los pagos pendientes.

Documentación de la Estructura de Datos

Método Uri Query Params
Get https://your.domain.com/... id_number

ejemplo

Get https://your.domain.com/get-recaudas?id_number=12345678

Al realizar el consumo del api, se espera el body en formato json y con un array de objetos "payments".

Nota: Se recomienda llevar seguimiento de los recauda pendientes enviados para no volver a enviarlos y así hacer mas rápida la consulta.

estructura body

  • payments (array, requerido): Array de objetos con los recauda a ser consultados.
  • payments.[].recaudarecauda_information (Object, requerido): Objeto con la información del cobro de cada recauda.
  • payments.[].recaudarecauda_information.description (string, requerido, min:4, max:191): Descripción de la recaudación ERP por API Success.
  • payments.[].recaudarecauda_information.amount (string, requerido, min:4, max:191): Monto de la recaudación.
  • payments.[].recaudarecauda_information.currency_type (string, enum:COP,USD,EUR requerido, min:4, max:191): Tipo de moneda del monto.
  • payments.[].recaudarecauda_information.id_number (string, numero, min_digitos:5): Número de identificación del cliente.
  • payments.[].recaudarecauda_information.payer_name (string, requerido, min:5, max:191): Nombre del pagador.
  • payments.[].recaudarecauda_information.advance (string, opcional, max:191): para indicar si permite adelantos.
  • payments.[].recaudarecauda_information.advance.type (string, enum:Valor Minimo,Porcentaje Minimo): Indica el tipo de adelanto.
  • payments.[].recaudarecauda_information.advance.value (numero, requerido): Indicar el monto minimo permitido para el adelanto.
  • payments.[].recaudarecauda_information.ref_payment (string, requerido, único): Referencia de pago, debe ser un valor único y se usara para prevenir duplicar los recauda.
  • payments.[].recaudarecauda_information.metadata (array, opcional,): Agregar data adicional que el comercio requiera.
  • payments.[].advanced_options (object, opcional): Descripción de la recaudación ERP por API Success.
  • payments.[].advanded_options.picture (string, opcional, max:250): Imagen relacionada.
  • payments.[].advanded_options.limit_date (string, fecha:Y-m-d mayor o igual a hoy): Fecha límite para realizar el pago.
  • payments.[].advanded_options.references (array, opcional, max:3): Contenedor de las referencias.
  • payments.[].advanded_options.references.3 (string, requerido, max:50): Referencias a agregar.
  • payments.[].advanded_options.result_urls (object, opcional): Contenedor para las url de respuesta.
  • payments.[].advanded_options.result_urls.webhook (string, requerido, url): url para recibir actualizaciones via webhook.
  • payments.[].advanded_options.delivery_service (object, opcional): para indicar si tiene servicio a domicilio.
  • payments.[].advanded_options.delivery_service.type (enum:Gratis,Con Valor, requerido): tipo de entrega.
  • payments.[].advanded_options.delivery_service.value (decimal:2): Valor de la entrega.
  • payments.[].advanded_options.request_address_delivery (bool, opcional): Indica si se solicita la dirección de entrega.
  • payments.[].advanded_options.discount (object, opcional): Indicar si se realiza algun descuento al pago.
  • payments.[].advanded_options.discount.before_on (string, fecha:Y-m-d igual o despues de hoy): Indicar fecha maxima para aplicar el descuento.
  • payments.[].advanded_options.discount.type (enum:Porcentaje,Valor): Tipo de descuento a aplicar.
  • payments.[].advanded_options.discount.value (decimal:2): Valor del descuento a aplicar.
  • payments.[].advanded_options.has_comments (bool, requerido): Indica si permite comentarios.

  • payments.[].advanded_options.comments_label (string, opcional, max:100): Personalizar el campo para adicionar comentarios.

Ejemplo de body esperado

{
    "payments": [
        {
            "recauda_information": {
                "description": "prueba fill out all",
                "amount": 20000,
                "selected_taxes": null,
                "currency_type": "COP",
                "id_number": "12345678",
                "payer_name": "efipay",
                "ref_payment": "1234567",
                "advance": {
                    "type": "Valor Minimo",
                    "value": 5000
                },
                "metadata": {
                    "data": "Your additional data here"
                }
            },
            "advanced_options": {
                "picture": "https://efipay.co/images/logo.svg",
                "limit_date": "2025-03-15",
                "references": [
                    "123456",
                    "323432",
                    "6546456"
                ],
                "result_urls": {
                    "webhook": "https://webhook-test.com/310b715b9704556033c7fe260915cdfd"
                },
                "delivery_service": {
                    "type": "Con Valor",
                    "value": 5000
                },
                "has_comments": false,
                "comments_label": "Deja tus comentarios"
            }
        },
        {
            "recauda_information": {
                "description": "prueba fill out recauda only",
                "amount": 20000,
                "selected_taxes": null,
                "currency_type": "COP",
                "id_number": "12345678",
                "payer_name": "efipay",
                "ref_payment": "7654321",
                "advance": {
                    "type": "Valor Minimo",
                    "value": 5000
                }
            },
            "advanced_options": null
        },
        {
            "recauda_information": {
                "description": "prueba fill out errors",
                "amount": 20000,
                "selected_taxes": null,
                "currency_type": "COP",
                "id_number": "12345678",
                "payer_name": "efipay",
                "ref_payment": "7654322",
                "advance": {
                    "type": "Valor Minimo",
                    "value": 5000
                }
            },
            "advanced_options": null
        }
    ]
}