Servicios

Metodos API para responsables

Consultar factura

GET /apiConsultaFacturas/v1/facturas

Servicio expuesto, cuyo criterio de consulta es el número de factura del cliente que desea pagar y cuya respuesta consiste en la información relativa a la factura (fecha de pago, valor de pago, etc.).

Query Parameters

Name	Type	Description
referencia*	String	Corresponde a la referencia de pago de la factura
tipoPago*	String	Corresponde al servicio que se desea consultar. Ver tabla 1.
valor*	int	Numérico: Corresponde al valor de la factura
fechaVencimiento*	int	Corresponde al valor de la fecha de vencimiento formato yyyymmdd sin separador (/) o (-)
operador	String	Operador del servicio ejemplo 0001 Banco de Bogota

Headers

Name	Type	Description
Content-type*	String
Authorization*	String	Bearer token

200: OK

//respuesta par a predial
{
"data": {
        "codigocatastral": "0100000001870903900000262",
        "digControl": "1096023",
        "nroFactura": "2023076728",
        "direccion": "C 20 2B BIS 13 Mz E Cs 72 SAN SEBA",
        "valor": "129508.00",
        "identificacion": "8300545390",
        "nombre": "FIDEICOMISO P A VILLAS DE OCCIDEN",
        "codigoRespuesta": "000"
    },
    "mensaje": "Factura correcta",
    "status": 200
}

//respuensta para ica o reteica
{
    "data": {
        "ano": "2022",
        "nroFactura": "202213009961",
        "periodo": "13",
        "fechaVencimiento": "2023-04-05",
        "comercio": "009961",
        "valor": "919000.00",
        "tipoPago": "ica",
        "codigoRespuesta": "000"
    },
    "mensaje": "Factura correcta",
    "status": 200
}
```

401: Unauthorized

{
    "mensajeError": "Err1: El usuario no se encuentra autenticado",
    "status": 401
}

406: Not Acceptable

{
    "mensajeError": "Err1: El usuario no se encuentra autenticado",
    "status": 406
}

Registro de pago

POST /apiConsultaFacturas/v1/facturas

Servicio expuesto, cuyo criterio de notificación es un número de factura seleccionado por cliente que desea pagar y cuya respuesta consiste en una confirmación del pago.

Headers

Name	Type	Description
Content-type*	String
Authorization*	String	Bearer token

Request Body

Name	Type	Description
referencia*	String	Corresponde a la referencia de pago de la factura
tipoPago*	String	Corresponde al servicio que se desea consultar. Ver tabla 1.
valor*	int	Numérico: Corresponde al valor de la factura
operador*	String	Operador del servicio ejemplo 0001 Banco de Bogota
fechaVencimiento*	int	Corresponde al valor de la fecha de vencimiento formato yyyymmdd sin separador (/) o (-)
fechaPago*	int	Corresponde al valor de la fecha de pago formato yyyymmdd sin separador (/) o (-)

200: OK

{
    "data": {
        "codigocatastral": "0100000001870903900000262",
        "digControl": "1096023",
        "nroFactura": "2023076728",
        "direccion": "C 20 2B BIS 13 Mz E Cs 72 SAN SEBA",
        "valor": "129508.00",
        "identificacion": "8300545390",
        "nombre": "FIDEICOMISO P A VILLAS DE OCCIDEN",
        "codigoRespuesta": "000"
    },
    "mensaje": "Factura correcta",
    "status": 200
}

401: Unauthorized

{
    "mensajeError": "Err1: El usuario no se encuentra autenticado",
    "status": 401
}

406: Not Acceptable

{
    "mensajeError": "Err1: El usuario no se encuentra autenticado",
    "status": 406
}

Reverso de pago

PUT /apiConsultaFacturas/v1/facturas/anularPago

Servicio expuesto, cuyo criterio de identificación es el Identificador único del Pago Original (UID) y número de factura ingresado en el pago original.

Headers

Name	Type	Description
Content-type*	String
Authorization*	String	Bearer token

Request Body

Name	Type	Description
referencia*	String	Corresponde a la referencia de pago de la factura
tipoPago*	String	Corresponde al servicio que se desea consultar. Ver tabla 1.
valor*	int	Numérico: Corresponde al valor de la factura
operador*	String	Operador del servicio ejemplo 0001 Banco de Bogota
fechaPago*	int	Corresponde al valor de la fecha de pago formato yyyymmdd sin separador (/) o (-)

200: OK

{
    "data": {
        "nroFactura": "2023076728",
        "valor": "129508.00",
        "codigoRespuesta": "000"
    },
    "mensaje": "La facactura se anuló correctamente",
    "status": 200
}