Documentación Collectar

Documentación Collectar

Documentación técnica de integración

Retirar facturas

Estimated reading: 2 minutes 188 views

Este método nos permitirá cancelar facturas ya creadas.

Parámetros de entrada necesarios

El servicio recibe los siguientes parámetros en formado JSON

Parámetros de salida

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

– Estado: Código de los posibles estados del pago de la factura:

estadoFactura

– Error: Código de resultado de que devolverá uno de los valores indicados en la siguiente tabla: 

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

idCliente

tokenFactura

Clave Privada

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

firma = upper(hex(sha256(cadena de firma)))
El resultado de esta función es el valor a enviar en el campo firma
Ejemplo de petición

Ejecutamos el método cancel mediante una invocación POST al servicio en el entorno de test

Con el siguiente cuerpo:

				
					{ 
 "idCliente": "bb9e34635fb7", 
 "tokenFactura": "5A127216B9CB4DC29839", 
 "firma": "7BB2C19942D468BD2CA67A2FA5219EA293151AB4FFD067F12D39CCDFF79392F3"
}
				
			

El campo firma se ha compuesto de la siguiente manera:



Creamos la cadena de firma:
BB9E34635FB75A127216B9CB4DC29839C35C7EE710D3
234567890



Generamos el hash para esa cadena, lo convertimos a una cadena hexadecimal y lo ponemos
en mayúsculas:

7BB2C19942D468BD2CA67A2FA5219EA293151AB4FFD067F12D39CCDFF79392F3

Respuesta a una petición
La petición anterior devolverá una respuesta JSON con el siguiente contenido:

Correcta
				
					{ 
 "idFactura": "F0125", 
 "tokenFactura": "5A127216B9CB4DC298399C0BFF5A83201A3B713099F7458593FE1B6E42B84E7B", 
 "estado": "3", 
 "fechaUltimoCambio": "2020-01-12 01:10:58", 
 "error": 0 
}
				
			
Con error
				
					{ 
 "error": 4 (Código de error correspondiente) 
 "idFactura": "F0125", 
 "tokenFactura": "5A127216B9CB4DC298399C0BFF5A83201A3B713099F7458593FE1B6E42B84E7B"
}
				
			
CONTENTS
es_ESEspañol