Pix

Descripción detallada

Pix Operaciones dirigidas al SPI (Sistema de Pagos Instantáneos).

Consulte la documentación técnica del HSM.

Buenas prácticas

General

1. Reutilice las sesiones (benefíciese de la caché de sesión). Utilice la caché de sesiones del HSM y gane rendimiento reutilizando las sesiones HSM y HTTP. En este caso se recomienda abrir una sesión, realizar las operaciones que se deseen y luego cerrarla, lo que permite reutilizar la sesión rápidamente, reduciendo así el tiempo de inactividad.
2. Garantizar el cierre de las sesiones. El cierre de sesiones garantiza la liberación del recurso, tanto en el HSM como en el cliente. Asegúrese de que las sesiones se cierran incluso para operaciones con un código de retorno distinto de éxito.
3. Utilice sesiones concurrentes. El uso de sesiones concurrentes/paralelas con el HSM ayuda a extraer el máximo rendimiento. Debe prestarse atención al uso de demasiadas sesiones con HSM, para no provocar un uso innecesario de recursos. La curva de rendimiento tiende a subir y a encontrar una meseta.

Peticiones HTTP Pix

1. Definir un intervalo de recarga de objetos de conexión. Puede optimizar el número de veces que se cargan las claves y objetos HSM definiendo un intervalo de recarga para los objetos HSM. Dado que la actualización de claves/certificados/cadenas de la institución se realiza con poca frecuencia y de forma programada, resulta ventajoso definir un intervalo de recarga para estos objetos. Preste atención a los tiempos de espera de los activos de red que sean inferiores a este valor para evitar desconexiones prematuras y errores innecesarios. Vea más detalles y cómo configurarlo aquí.

Ajustes importantes

General

1. Configure los tiempos de espera de conexión del HSM. Si no se establece el tiempo de espera del HSM, el valor predeterminado es el del sistema operativo. En caso de fallo de la conexión, la aplicación puede esperar demasiado tiempo. Es importante configurar SIEMPRE los tiempos de espera de envío y recepción de HSM. Aquí encontrará otros parámetros de conexión.

Peticiones HTTP Pix

1. Define los tiempos de espera de las operaciones HTTP. Si no se define, el tiempo de espera de la operación HTTP por defecto es ilimitado. En caso de fallo de la conexión HTTP, la aplicación puede quedar en espera indefinidamente. Es importante definir SIEMPRE el tiempo de espera en las llamadas a peticiones HTTP.

Funciones
byte[]	signPIX (String strKeyId, String strCertId, int nFlags, byte[] baUnsignedPIXEnvelope) throws TacException
	PIX Firma digitalmente un XML en formato ISO 20.022 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
byte[]	signPIX (String strKeyId, String strCertId, byte[] baUnsignedPIXEnvelope) throws TacException
	PIX Firma digitalmente un XML en formato ISO 20.022 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
byte[]	signPIXDict (String strKeyId, String strCertId, int nFlags, byte[] baUnsignedDictEnvelope) throws TacException
	Firma digitalmente un XML en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).
byte[]	signPIXDict (String strKeyId, String strCertId, byte[] baUnsignedDictEnvelope) throws TacException
	Firma digitalmente un XML en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).
booleano	verifyPIX (String strChainId, String strCRLId, int nFlags, byte[] baSignedPIXEnvelope) throws TacException
	PIX Comprueba la firma de un documento XML firmado digitalmente en formato ISO 20.022 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
booleano	verifyPIX (String strChainId, String strCRLId, byte[] baSignedPIXEnvelope) throws TacException
	PIX Comprueba la firma de un documento XML firmado digitalmente en formato ISO 20.022 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
booleano	verifyPIXDict (String strChainId, String strCRLId, int nFlags, byte[] baSignedDictEnvelope) throws TacException
	Comprueba la firma de un documento XML firmado digitalmente en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).
booleano	verifyPIXDict (String strChainId, String strCRLId, byte[] baSignedDictEnvelope) throws TacException
	Comprueba la firma de un documento XML firmado digitalmente en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).
byte[]	signPIXJWS (String strKeyId, byte[] baHeader, byte[] baPayload) throws TacException
	PIX Realiza una firma JWS RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
Cadena	signPIXJWS (String strKeyId, String strHeader, String strPayload) throws TacException
	PIX Realiza una firma JWS RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
JwsComponents	checkPIXJWS (String strChainId, String strCRLId, byte[] baJWS, int nFlags) throws TacException
	PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
JwsComponents	checkPIXJWS (String strChainId, String strCRLId, String strJWS, int nFlags) throws TacException
	PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
booleano	checkPIXJWS (String strChainId, String strCRLId, byte[] baJWS) throws TacException
	PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
booleano	checkPIXJWS (String strChainId, String strCRLId, String strJWS) throws TacException
	PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
PIXResponse	postPIX (String strKeyId, String strCertId, String strPIXCertChainId, String strURL, String[] straRequestHeaderList, byte[] baRequestData, int nTimeOut, boolean bUseGzip, boolean bVerifyHostName) throws TacException
	PIX Realiza una petición HTTP POST segura siguiendo el estándar definido en SPI (Sistema de Pago Instantáneo).
PIXResponse	postPIX (String strKeyId, String strCertId, String strPIXCertChainId, String strURL, String[] straRequestHeaderList, byte[] baRequestData, int nTimeOut, int nParam) throws TacException
	PIX Realiza una petición HTTP POST segura siguiendo el estándar definido en SPI (Sistema de Pago Instantáneo).
PIXResponse	putPIX (String strKeyId, String strCertId, String strPIXCertChainId, String strURL, String[] straRequestHeaderList, byte[] baRequestData, int nTimeOut, boolean bUseGzip, boolean bVerifyHostName) throws TacException
	PIX Realiza una petición HTTP PUT segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
PIXResponse	putPIX (String strKeyId, String strCertId, String strPIXCertChainId, String strURL, String[] straRequestHeaderList, byte[] baRequestData, int nTimeOut, int nParam) throws TacException
	PIX Realiza una petición HTTP PUT segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
PIXResponse	getPIX (String strKeyId, String strCertId, String strPIXCertChainId, String strURL, String[] straRequestHeaderList, int nTimeOut, boolean bUseGzip, boolean bVerifyHostName) throws TacException
	PIX Realiza una petición HTTP GET segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
PIXResponse	getPIX (String strKeyId, String strCertId, String strPIXCertChainId, String strURL, String[] straRequestHeaderList, int nTimeOut, int nParam) throws TacException
	PIX Realiza una petición HTTP GET segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
PIXResponse	deletePIX (String strKeyId, String strCertId, String strPIXCertChainId, String strURL, String[] straRequestHeaderList, int nTimeOut, boolean bUseGzip, boolean bVerifyHostName) throws TacException
	PIX Realiza una petición segura HTTP DELETE siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
PIXResponse	deletePIX (String strKeyId, String strCertId, String strPIXCertChainId, String strURL, String[] straRequestHeaderList, int nTimeOut, int nParam) throws TacException
	PIX Realiza una petición segura HTTP DELETE siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).
PIXHTTPReqDetails	getPIXHTTPReqDetails () throws TacException
	PIX Recupera los detalles de la última petición HTTP (POST, GET...) realizada en esta sesión.
largo	getPIXHTTPReqCode () throws TacException
	PIX Recupera el código de retorno de la última petición HTTP (POST, GET...) realizada en esta sesión.

Funciones

signPIX() [1/2]

byte[] signPIX	(	String	strKeyId,
		String	strCertId,
		int	nFlags,
		byte[]	baUnsignedPIXEnvelope ) throws TacException

PIX Firma digitalmente un XML en formato ISO 20.022 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strKeyId	Nombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.
strCertId	Nombre del certificado digital utilizado para la firma. Certificado digital del PSP registrado en SPI para la firma, también conocido como CPIA o CERTPIA.
nFlags	Opciones de suscripción. Pase 0. Si necesita opciones adicionales, se aceptan los siguientes valores. Valor Significado PIXTacNDJavaLib. _SIGN_RNS Permite el uso de espacios de nombres relativos.
baUnsignedPIXEnvelope	XML a firmar.

Devolución

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

Recomendamos utilizar la etiqueta de firma con el cierre completo, como se ve a continuación, por razones de rendimiento.

<Sgntr></Sgntr>

También se acepta la etiqueta con un cierre simple, véase más abajo.

<Sgntr/>

signPIX() [2/2]

byte[] signPIX	(	String	strKeyId,
		String	strCertId,
		byte[]	baUnsignedPIXEnvelope ) throws TacException

PIX Firma digitalmente un XML en formato ISO 20.022 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strKeyId	Nombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.
strCertId	Nombre del certificado digital utilizado para la firma. Certificado digital del PSP registrado en SPI para la firma, también conocido como CPIA o CERTPIA.
baUnsignedPIXEnvelope	XML a firmar.

Devolución

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

Recomendamos utilizar la etiqueta de firma con el cierre completo, como se ve a continuación, por razones de rendimiento.

<Sgntr></Sgntr>

También se acepta la etiqueta con un cierre simple, véase más abajo.

<Sgntr/>

signPIXDict() [1/2]

byte[] signPIXDict	(	String	strKeyId,
		String	strCertId,
		int	nFlags,
		byte[]	baUnsignedDictEnvelope ) throws TacException

Firma digitalmente un XML en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strKeyId	Nombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.
strCertId	Nombre del certificado digital utilizado para la firma. Certificado digital del PSP registrado en SPI para la firma, también conocido como CPIA o CERTPIA.
nFlags	Reservado para uso futuro (debe ser 0).
baUnsignedDictEnvelope	XML a firmar.

Devolución

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

No incluya la etiqueta de firma, se añadirá automáticamente.

signPIXDict() [2/2]

byte[] signPIXDict	(	String	strKeyId,
		String	strCertId,
		byte[]	baUnsignedDictEnvelope ) throws TacException

Firma digitalmente un XML en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strKeyId	Nombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.
strCertId	Nombre del certificado digital utilizado para la firma. Certificado digital del PSP registrado en SPI para la firma, también conocido como CPIA o CERTPIA.
baUnsignedDictEnvelope	XML a firmar.

Devolución

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

No incluya la etiqueta de firma, se añadirá automáticamente.

verifyPIX() [1/2]

boolean verifyPIX	(	String	strChainId,
		String	strCRLId,
		int	nFlags,
		byte[]	baSignedPIXEnvelope ) throws TacException

PIX Comprueba la firma de un documento XML firmado digitalmente en formato ISO 20.022 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strChainId	Nombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Pix Este formato es necesario porque el mensaje XML de no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para firmar en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
strCRLId	Nombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
nFlags	Reservado para uso futuro (debe ser 0).
baSignedPIXEnvelope	XML firmado.

Devolución

true si la firma es válida y false si no lo es.

Excepciones

TacException

verifyPIX() [2/2]

boolean verifyPIX	(	String	strChainId,
		String	strCRLId,
		byte[]	baSignedPIXEnvelope ) throws TacException

PIX Comprueba la firma de un documento XML firmado digitalmente en formato ISO 20.022 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strChainId	Nombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Pix Este formato es necesario porque el mensaje XML de no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para firmar en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
strCRLId	Nombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
baSignedPIXEnvelope	XML firmado.

Devolución

true si la firma es válida y false si no lo es.

Excepciones

TacException

verifyPIXDict() [1/2]

boolean verifyPIXDict	(	String	strChainId,
		String	strCRLId,
		int	nFlags,
		byte[]	baSignedDictEnvelope ) throws TacException

Comprueba la firma de un documento XML firmado digitalmente en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strChainId	Nombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Pix Este formato es necesario porque el mensaje XML de no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para firmar en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
strCRLId	Nombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
nFlags	Reservado para uso futuro (debe ser 0).
baSignedDictEnvelope	XML firmado.

Devolución

true si la firma es válida y false si no lo es.

Excepciones

TacException

verifyPIXDict() [2/2]

boolean verifyPIXDict	(	String	strChainId,
		String	strCRLId,
		byte[]	baSignedDictEnvelope ) throws TacException

Comprueba la firma de un documento XML firmado digitalmente en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strChainId	Nombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Pix Este formato es necesario porque el mensaje XML de no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para firmar en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
strCRLId	Nombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
baSignedDictEnvelope	XML firmado.

Devolución

true si la firma es válida y false si no lo es.

Excepciones

TacException

signPIXJWS() [1/2]

byte[] signPIXJWS	(	String	strKeyId,
		byte[]	baHeader,
		byte[]	baPayload ) throws TacException

PIX Realiza una firma JWS RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strKeyId	Nombre de la clave privada utilizada para firmar. Tal como se define en el PIX
baHeader	Cabecera JWS para la firma. Al menos el parámetro de cabecera alg debe ser informado. Valores aceptados para alg. Valor Significado RS256 RSA 2048 PKCS#1v5 RS384 RSA 3072 PKCS#1v5 RS512 RSA 4096 PKCS#1v5 PS256 RSA 2048 PSS PS384 RSA 3072 PSS PS512 RSA 4096 PSS ES256 ECC SECP256R1 ES384 ECC SECP384R1 ES512 ECC SECP521R1
baPayload	Carga útil JWS para la suscripción.

Devolución

JWS firmado.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

Utiliza el formato Compact Serialisation descrito en la Sección-3.1 del RFC 7515.

signPIXJWS() [2/2]

String signPIXJWS	(	String	strKeyId,
		String	strHeader,
		String	strPayload ) throws TacException

PIX Realiza una firma JWS RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strKeyId	Nombre de la clave privada utilizada para firmar. Tal como se define en el PIX
strHeader	Cabecera JWS para la firma. Al menos el parámetro de cabecera alg debe ser informado. Valores aceptados para alg. Valor Significado RS256 RSA 2048 PKCS#1v5 RS384 RSA 3072 PKCS#1v5 RS512 RSA 4096 PKCS#1v5 PS256 RSA 2048 PSS PS384 RSA 3072 PSS PS512 RSA 4096 PSS ES256 ECC SECP256R1 ES384 ECC SECP384R1 ES512 ECC SECP521R1
strPayload	Carga útil JWS para la suscripción.

Devolución

JWS firmado.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

Utiliza el formato Compact Serialisation descrito en la Sección-3.1 del RFC 7515.

checkPIXJWS() [1/4]

JwsComponents checkPIXJWS	(	String	strChainId,
		String	strCRLId,
		byte[]	baJWS,
		int	nFlags ) throws TacException

PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strChainId	Nombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Pix Este formato es necesario porque el mensaje XML de no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para firmar en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
strCRLId	Nombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
baJWS	JWS firmado.
nFlags	Comprueba las opciones. Debería ser 0.

Devolución

Clase JwsComponents que contendrá el código de retorno, la Cabecera y la Carga útil del mensaje firmado.

Excepciones

TacException

checkPIXJWS() [2/4]

JwsComponents checkPIXJWS	(	String	strChainId,
		String	strCRLId,
		String	strJWS,
		int	nFlags ) throws TacException

PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strChainId	Nombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Pix Este formato es necesario porque el mensaje XML de no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para firmar en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
strCRLId	Nombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
strJWS	JWS firmado.
nFlags	Comprueba las opciones. Debería ser 0.

Devolución

Clase JwsComponents que contendrá el código de retorno, la Cabecera y la Carga útil del mensaje firmado.

Excepciones

TacException

checkPIXJWS() [3/4]

boolean checkPIXJWS	(	String	strChainId,
		String	strCRLId,
		byte[]	baJWS ) throws TacException

PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strChainId	Nombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Pix Este formato es necesario porque el mensaje XML de no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para firmar en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
strCRLId	Nombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
baJWS	JWS firmado.

Devolución

Verdadero si la comprobación se realiza correctamente.

Excepciones

TacException

checkPIXJWS() [4/4]

boolean checkPIXJWS	(	String	strChainId,
		String	strCRLId,
		String	strJWS ) throws TacException

PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Parámetros

strChainId	Nombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Pix Este formato es necesario porque el mensaje XML de no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para firmar en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
strCRLId	Nombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
strJWS	JWS firmado.

Devolución

Verdadero si la comprobación se realiza correctamente.

Excepciones

TacException

postPIX() [1/2]

PIXResponse postPIX	(	String	strKeyId,
		String	strCertId,
		String	strPIXCertChainId,
		String	strURL,
		String[]	straRequestHeaderList,
		byte[]	baRequestData,
		int	nTimeOut,
		boolean	bUseGzip,
		boolean	bVerifyHostName ) throws TacException

PIX Realiza una petición HTTP POST segura siguiendo el estándar definido en SPI (Sistema de Pago Instantáneo).

Utiliza la cabecera HTTP inicial básica.

Observación

Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.

Parámetros

strKeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
strCertId	Nombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
strPIXCertChainId	PIX Nombre de la cadena PKCS#7 utilizada para comprobar el servidor (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
strURL	PIX URL del servidor (ICOM o DICT).
straRequestHeaderList	Líneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios. Esta opción sobrescribirá las cabeceras por defecto si se solapan. Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:). Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;). NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente. Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual. La cabecera inicial estándar incluye Host, User-Agent y Content-Length.
baRequestData	Datos enviados en la solicitud.
nTimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
bUseGzip	Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).
bVerifyHostName	Comprueba el certificado con el nombre del host.

Devolución

Respuesta a la solicitud.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

PIX Ejecuta una petición segura siguiendo el estándar definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP hay que utilizar la misma sesión HSM que se utilizó previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

postPIX() [2/2]

PIXResponse postPIX	(	String	strKeyId,
		String	strCertId,
		String	strPIXCertChainId,
		String	strURL,
		String[]	straRequestHeaderList,
		byte[]	baRequestData,
		int	nTimeOut,
		int	nParam ) throws TacException

PIX Realiza una petición HTTP POST segura siguiendo el estándar definido en SPI (Sistema de Pago Instantáneo).

Observación

Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.

Parámetros

strKeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
strCertId	Nombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
strPIXCertChainId	PIX Nombre de la cadena PKCS#7 utilizada para comprobar el servidor (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
strURL	PIX URL del servidor (ICOM o DICT).
straRequestHeaderList	Líneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios. Esta opción sobrescribirá las cabeceras por defecto si se solapan. Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:). Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;). NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente. Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual. La cabecera inicial estándar incluye Host, User-Agent, Accept, Accept-Encoding, Content-Type, Expect y Content-Length.
baRequestData	Datos enviados en la solicitud.
nTimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
nParam	Valor Significado 0 Opción por defecto. No comprueba el certificado con el nombre de host. PIXTacNDJavaLib. _VERIFY_HOST_NAME Comprueba el certificado con el nombre del host. PIXTacNDJavaLib. _BASIC_HTTP_HEADER Utiliza la cabecera HTTP inicial básica. Incluye Host, User-Agent y Content-Length. PIXTacNDJavaLib. _GZIP Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).

Devolución

Respuesta a la solicitud.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

PIX Ejecuta una petición segura siguiendo el estándar definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP hay que utilizar la misma sesión HSM que se utilizó previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

putPIX() [1/2]

PIXResponse putPIX	(	String	strKeyId,
		String	strCertId,
		String	strPIXCertChainId,
		String	strURL,
		String[]	straRequestHeaderList,
		byte[]	baRequestData,
		int	nTimeOut,
		boolean	bUseGzip,
		boolean	bVerifyHostName ) throws TacException

PIX Realiza una petición HTTP PUT segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Utiliza la cabecera HTTP inicial básica.

Observación

Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.

Parámetros

strKeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
strCertId	Nombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
strPIXCertChainId	PIX Nombre de la cadena PKCS#7 utilizada para comprobar el servidor (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
strURL	PIX URL del servidor (ICOM o DICT).
straRequestHeaderList	Líneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios. Esta opción sobrescribirá las cabeceras por defecto si se solapan. Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:). Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;). NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente. Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual. La cabecera inicial estándar incluye Host, User-Agent y Content-Length.
baRequestData	Datos enviados en la solicitud.
nTimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
bUseGzip	Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).
bVerifyHostName	Comprueba el certificado con el nombre del host.

Devolución

Respuesta a la solicitud.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

PIX Ejecuta una petición segura siguiendo el estándar definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP hay que utilizar la misma sesión HSM que se utilizó previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

putPIX() [2/2]

PIXResponse putPIX	(	String	strKeyId,
		String	strCertId,
		String	strPIXCertChainId,
		String	strURL,
		String[]	straRequestHeaderList,
		byte[]	baRequestData,
		int	nTimeOut,
		int	nParam ) throws TacException

PIX Realiza una petición HTTP PUT segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Observación

Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.

Parámetros

strKeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
strCertId	Nombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
strPIXCertChainId	PIX Nombre de la cadena PKCS#7 utilizada para comprobar el servidor (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
strURL	PIX URL del servidor (ICOM o DICT).
straRequestHeaderList	Líneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios. Esta opción sobrescribirá las cabeceras por defecto si se solapan. Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:). Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;). NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente. Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual. La cabecera inicial estándar incluye Host, User-Agent, Accept, Accept-Encoding, Expect y Content-Length.
baRequestData	Datos enviados en la solicitud.
nTimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
nParam	Valor Significado 0 Opción por defecto. No comprueba el certificado con el nombre de host. PIXTacNDJavaLib. _VERIFY_HOST_NAME Comprueba el certificado con el nombre del host. PIXTacNDJavaLib. _BASIC_HTTP_HEADER Utiliza la cabecera HTTP inicial básica. Incluye Host, User-Agent y Content-Length. PIXTacNDJavaLib. _GZIP Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).

Devolución

Respuesta a la solicitud.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

PIX Ejecuta una petición segura siguiendo el estándar definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP hay que utilizar la misma sesión HSM que se utilizó previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

getPIX() [1/2]

PIXResponse getPIX	(	String	strKeyId,
		String	strCertId,
		String	strPIXCertChainId,
		String	strURL,
		String[]	straRequestHeaderList,
		int	nTimeOut,
		boolean	bUseGzip,
		boolean	bVerifyHostName ) throws TacException

PIX Realiza una petición HTTP GET segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Utiliza la cabecera HTTP inicial básica.

Observación

Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.

Parámetros

strKeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
strCertId	Nombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
strPIXCertChainId	PIX Nombre de la cadena PKCS#7 utilizada para comprobar el servidor (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
strURL	PIX URL del servidor (ICOM o DICT).
straRequestHeaderList	Líneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios. Esta opción sobrescribirá las cabeceras por defecto si se solapan. Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:). Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;). NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente. Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual. La cabecera inicial estándar incluye Host, User-Agent, Accept, Accept-Encoding.
nTimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
bUseGzip	Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.
bVerifyHostName	Comprueba el certificado con el nombre del host.

Devolución

Respuesta a la solicitud.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

PIX Ejecuta una petición segura siguiendo el estándar definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP hay que utilizar la misma sesión HSM que se utilizó previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

getPIX() [2/2]

PIXResponse getPIX	(	String	strKeyId,
		String	strCertId,
		String	strPIXCertChainId,
		String	strURL,
		String[]	straRequestHeaderList,
		int	nTimeOut,
		int	nParam ) throws TacException

PIX Realiza una petición HTTP GET segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Observación

Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.

Parámetros

strKeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
strCertId	Nombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
strPIXCertChainId	PIX Nombre de la cadena PKCS#7 utilizada para comprobar el servidor (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
strURL	PIX URL del servidor (ICOM o DICT).
straRequestHeaderList	Líneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios. Esta opción sobrescribirá las cabeceras por defecto si se solapan. Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:). Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;). NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente. Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual. La cabecera inicial estándar incluye Host, User-Agent, Accept, Accept-Encoding.
nTimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
nParam	Valor Significado 0 Opción por defecto.No comprueba el certificado con el nombre del host. PIXTacNDJavaLib. _VERIFY_HOST_NAME Comprueba el certificado con el nombre del host. PIXTacNDJavaLib. _BASIC_HTTP_HEADER Utiliza la cabecera HTTP inicial básica. Incluye Host y User-Agent. PIXTacNDJavaLib. _GZIP Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.

Devolución

Respuesta a la solicitud.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

PIX Ejecuta una petición segura siguiendo el estándar definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP hay que utilizar la misma sesión HSM que se utilizó previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

deletePIX() [1/2]

PIXResponse deletePIX	(	String	strKeyId,
		String	strCertId,
		String	strPIXCertChainId,
		String	strURL,
		String[]	straRequestHeaderList,
		int	nTimeOut,
		boolean	bUseGzip,
		boolean	bVerifyHostName ) throws TacException

PIX Realiza una petición segura HTTP DELETE siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Utiliza la cabecera HTTP inicial básica.

Observación

Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.

Parámetros

strKeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
strCertId	Nombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
strPIXCertChainId	PIX Nombre de la cadena PKCS#7 utilizada para comprobar el servidor (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
strURL	PIX URL del servidor (ICOM o DICT).
straRequestHeaderList	Líneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios. Esta opción sobrescribirá las cabeceras por defecto si se solapan. Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:). Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;). NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente. Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual. La cabecera inicial por defecto incluye Host y User-Agent.
nTimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
bUseGzip	Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.
bVerifyHostName	Comprueba el certificado con el nombre del host.

Devolución

Respuesta a la solicitud.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

PIX Ejecuta una petición segura siguiendo el estándar definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP hay que utilizar la misma sesión HSM que se utilizó previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

deletePIX() [2/2]

PIXResponse deletePIX	(	String	strKeyId,
		String	strCertId,
		String	strPIXCertChainId,
		String	strURL,
		String[]	straRequestHeaderList,
		int	nTimeOut,
		int	nParam ) throws TacException

PIX Realiza una petición segura HTTP DELETE siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

Observación

Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.

Parámetros

strKeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
strCertId	Nombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
strPIXCertChainId	PIX Nombre de la cadena PKCS#7 utilizada para comprobar el servidor (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
strURL	PIX URL del servidor (ICOM o DICT).
straRequestHeaderList	Líneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios. Esta opción sobrescribirá las cabeceras por defecto si se solapan. Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:). Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;). NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente. Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual. La cabecera inicial estándar incluye Host, User-Agent, Accept, Accept-Encoding.
nTimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
nParam	Valor Significado 0 Opción por defecto.No comprueba el certificado con el nombre del host. PIXTacNDJavaLib. _VERIFY_HOST_NAME Comprueba el certificado con el nombre del host. PIXTacNDJavaLib. _BASIC_HTTP_HEADER Utiliza la cabecera HTTP inicial básica. Incluye Host y User-Agent. PIXTacNDJavaLib. _GZIP Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.

Devolución

Respuesta a la solicitud.

Excepciones

TacException

Lanza una excepción en caso de error de firma

Notas

PIX Ejecuta una petición segura siguiendo el estándar definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP hay que utilizar la misma sesión HSM que se utilizó previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

getPIXHTTPReqDetails()

PIXHTTPReqDetails getPIXHTTPReqDetails

(

)

throws TacException

PIX Recupera los detalles de la última petición HTTP (POST, GET...) realizada en esta sesión.

PIXEsta operación debe llamarse inmediatamente después de llamar a la API de solicitud. Debe llamarse utilizando la misma sesión. No realice otras operaciones entre estas llamadas.

Devolución

PIX Detalles de la última petición HTTP para esta sesión.

Excepciones

TacException

Lanza una excepción en caso de error de firma

getPIXHTTPReqCode()

long getPIXHTTPReqCode

(

)

throws TacException

PIX Recupera el código de retorno de la última petición HTTP (POST, GET...) realizada en esta sesión.

PIXEsta operación debe llamarse inmediatamente después de llamar a la API de solicitud. Debe llamarse utilizando la misma sesión. No realice otras operaciones entre estas llamadas.

Devolución

Código de retorno HTTP.

Excepciones

TacException

Lanza una excepción en caso de error