Documentación Collectar

Documentación Collectar

Documentación técnica de integración

Nuevo pago

Estimated reading: 4 minutes 173 views

Nuevo pago

Permite insertar un pago independiente de cualquier factura junto con un documento que podrá ser firmado; este método sólo devuelve una URL de pago que puede es ser embebida en una web redireccionando a la pasarela de pago.

Parámetro de entrada necesarios

El servicio recibe los siguientes parámetros:

Si la fecha de vencimiento no se especifica se le sumarán 7 días a la fecha en la que se reciba el pago.

Si se realiza un pago parcial, este cobro queda finalizado habiéndose cobrado solo una parte de la deuda exigida. Para terminar de cobrar el pago total, se deberá de generar un pago diferente con el importe que queda pendiente, por lo tanto la URL generada para el pago original solo podrá ser usada una vez.

El formato del idioma debe ser el iso-639-1. Si no se especifica el lenguaje, se establecerá el español por defecto.
Valores permitidos para el lenguaje de la pantalla de pago

Lenguajes

Parámetros de salida

El servicio devolverá un mensaje JSON con los siguientes campos:
Dónde:
  •  Error: Código de resultado de error que devolverá los valores indicados en la siguiente tabla:

Métodos de pago

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

idCliente
idPago
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)
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 New mediante una invocación POST al servicio en el entorno de test:

Con el siguiente cuerpo:

				
					{ 
 "idCliente": "bb9e34635fb7", 
 "idPago": "P14657", 
 "importe": 50.5, 
 "pagoParcial": false,
 "moneda": "EUR", 
 "fechaVencimiento": "2020-09-12", 
 "descripcionPago": "Cuota mensualidad", 
 "lenguaje": "es", 
 "metodosPago": "0;3",
}, 
 "firma": "68688BAFCCD5381669E219430B11519EAA4665F0099F08A239A7906682316A55" 
}
				
			

El campo firma se ha compuesto de la siguiente manera:



Creamos la cadena de firma:

– BB9E34635FB7P146572020-09-12CUOTA MENSUALIDADC35C7EE710D3

 


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


– 68688BAFCCD5381669E219430B11519EAA4665F0099F08A239A7906682316A55

Respuesta a una petición

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

Correcta

				
					{ 
 "resultado":"OK", 
 "error":0, 
 "idPago":"P14657", 
 "urlPago":"HTTPS://kxl.es/aAGA6pMGU",
 "tokenPago":
 "6ACB5DEC831A476B90D74C0622A8AFC2459A0DD5C66246B6B576439BE8E5D920"
}

				
			

Con error:

				
					{ 
 "resultado":"KO", 
 "error":0, 
 "idPago":null, 
 "urlPago":null, 
 "tokenPago":null 
} 
				
			

Respuesta de pago realizado



Al recibir la notificación de un pago realizado, se enviará un JSON con la información a la URL de callback que se haya especificado por cliente. La respuesta tendrá los siguientes datos:

Dónde:
  • Estado: Código de los posibles estados del pago

estadoFactura

Posibles valores para el campo:

tipoEvento

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

idCliente
CIF
responseTime

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
CONTENTS
en_GBEnglish (UK)