Documentación Collectar

Documentación Collectar

Documentación técnica de integración

Nueva factura

Estimated reading: 5 minutes 811 views

Todos los mensajes intercambiarán información, Ej formato JSON codificado en UTF-8

Nueva factura

Insertar una nueva factura le envía al deudor un mensaje, ya sea por email o por SMS, con la descripción de la factura, el enlace de pago y el importe.

Parámetros de entrada

El servicio recibe los siguientes parámetros:

Se debe indicar al menos el campo teléfono o el campo email.
La urlCallBack deberá ser siempre ‘https’.
Si se realiza un pago parcial de una factura, esta queda en estado ConPagoParcial, habiéndose cobrado solo una parte de importe exigido.
El idioma debe ser especificado según la norma ISO-639-1. Si no se especifica el lenguaje, se establecerá el español por defecto.

Para terminar de cobrar el pago total, el cliente podrá acceder a la misma url que se le facilitó para el primer pago, con los importes pendientes actualizados.

Una vez que se haya cobrado el total de la deuda exigida, esta factura pasará al estado Cobrado y la URL quedará inválida.

Valores válidos para el campo:
tipoFactura

Valores válidos para el campo:

tipoComunicación

Valores válidos para el campo:

tipoPlantilla

El contenido del documento se enviará codificado en Base64

Valores válidos para el campo:

dataDocument

Valores válidos para el campo:

metodosPago

Valores válidos para el campo:

lenguaje

Parámetros de salida

El servicio devolverá un mensaje JSON con los siguientes campos:

El tokenFactura que se devuelve en la respuesta, se utilizará para comprobar el estado de esa factura y para añadir documentos

Dónde:

Error: Código de resultado de error que podrá devolver uno de los valores de la siguiente tabla:

Posibles valores de respuesta de campo:

errorPago

El campo firma se compondrá mediante el siguiente proceso.
Para ellos se generará una cadena concatenandos los siguientes valores

idCliente

cifDeudor

numFactura

fechaVencimiento

descripciónPago

Clave privada

Sobre esta cadena, aplicaremos una función SHA 256 y el resultado será codificado en una cadena hexadecimal (en mayúsculas)
Ejemplo de petición

				
					{ 
 "idCliente": "bb9e34635fb7", 
 "cifDeudor": "12345678X", 
 "nombreDeudor": "Prueba", 
 "razonSocial": "", 
 "telefono": "911555555", 
 "email": "deudor@email.com", 
 "numFactura": "F0125", 
 "importe": 88.65, 
 "fechaVencimiento": "2019-12-31", 
 "descripcionPago": "Cuota correspondiente a mes Enero", 
 "tipoFactura": 1, 
 "numeroVencimiento": 1, 
 "totalVencimiento": 1, 
 "sobrescribirFactura": false, 
 "pagoParcial": true,
 "importeMinimo": 10.00,
 "importeMaximo": 88.65,
 "enviarComunicacion": true, 
 "tipoComunicacion": 1, 
 "urlCallBack": "https://test/api/respuestaPago", 
 "lenguaje": "es", 
 "metodosPago": "0;1;3", 
 "documentsList": [ 
{ 
    "nombreDoc":"test.pdf", 
    "contenidoDoc":"JVBERi0……", 
    "mimeType":"application/pdf" 
} 
 ], 
    "firma" "9134DBF13F7C0BE99EEB0D5F428684DB711D376D33A44CE32CEDA3476FC2C2DF"
}
				
			
El campo firma se ha compuesto de la siguiente manera:

Creamos la cadena de firma: KNX12345678XF01252019-12-31Factura por la compra del vehículo1234567890
Generamos el hash para esa cadena, lo convertimos a una cadena hexadecimal y lo ponemos en mayúsculas: 425A0D13536095FBCE816B6C369295D1D594E194066F1375AD0E7C43D5CE1C62
Respuesta a una petición

La petición anterior devolverá una respuesta JSON con el siguiente contenido.

Correcta:
				
					{ 
 "resultado": "OK", 
 "sobrescrita": false,
 "error": 0,
 "idFactura": "F0125", 
 "urlPago":"HTTPS://kxl.es/aAGA6pMGU",
 "tokenFactura":"A19E6E9C1C80400DA802A3E4FF74923148620EE6068A41BAA13FAC674A6B458E",
 "mensaje": "" 
}
				
			

Con error:

				
					{ 
 "resultado": "KO", 
 "sobrescrita": false, 
 "error": 4 (Código de error correspondiente), 
 "idFactura":"", 
 "tokenFactura":"", 
 "mensaje": "" 
}

				
			
CONTENTS
es_ESEspañol