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

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.
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.
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

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

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

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 (cadena KeyId, cadena CertId, int Flags, byte[] byUnsignedPIXEnvelope)
	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 (cadena KeyId, cadena CertId, byte[] byUnsignedPIXEnvelope)
	PIX Firma digitalmente un XML en formato ISO 20.022 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

bool	VerifyPIX (cadena ChainId, cadena CRL, cadena SignedPIXEnvelope)
	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).

byte[]	SignPIXDict (cadena KeyId, cadena CertId, int Flags, byte[] byUnsignedDictEnvelope)
	Firma digitalmente un XML en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).

byte[]	SignPIXDict (cadena KeyId, cadena CertId, byte[] byUnsignedDictEnvelope)
	Firma digitalmente un XML en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).

bool	VerifyPIX (cadena ChainId, cadena CRL, int Flags, byte[] SignedPIXEnvelope)
	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).

bool	VerifyPIX (cadena ChainId, cadena CRL, byte[] SignedPIXEnvelope)
	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).

bool	VerifyPIXDict (cadena ChainId, cadena CRL, int Flags, byte[] SignedDictEnvelope)
	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).

bool	VerifyPIXDict (cadena ChainId, cadena CRL, byte[] SignedDictEnvelope)
	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 (cadena KeyId, byte[] byHeader, byte[] byPayload)
	PIX Realiza una firma JWS RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

cadena	SignPIXJWS (cadena KeyId, cadena Header, cadena Payload)
	PIX Realiza una firma JWS RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

JwsComponents	CheckPIXJWS (cadena Chain, cadena CRL, byte[] byJWS, Int32 flags)
	PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

JwsComponents	CheckPIXJWS (cadena Chain, cadena CRL, cadena JWS, Int32 flags)
	PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

bool	CheckPIXJWS (cadena Chain, cadena CRL, byte[] byJWS)
	PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

bool	CheckPIXJWS (cadena Chain, cadena CRL, cadena JWS)
	PIX Valida un JWS firmado RFC 7515 siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

PIXResponse	postPIX (string KeyId, string CertId, string PIXCertChainId, string URL, string[] RequestHeaderList, byte[] RequestData, Int32 TimeOut, bool UseGzip, bool VerifyHostName)
	PIX Realiza una petición HTTP POST segura siguiendo el estándar definido en SPI (Sistema de Pago Instantáneo). Utiliza la cabecera HTTP básica inicial.

PIXResponse	postPIX (string KeyId, string CertId, string PIXCertChainId, string URL, string[] RequestHeaderList, byte[] RequestData, Int32 TimeOut, Int32 Param)
	PIX Realiza una petición HTTP POST segura siguiendo el estándar definido en SPI (Sistema de Pago Instantáneo).

PIXResponse	putPIX (string KeyId, string CertId, string PIXCertChainId, string URL, string[] RequestHeaderList, byte[] RequestData, Int32 TimeOut, bool UseGzip, bool VerifyHostName)
	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 básica inicial.

PIXResponse	putPIX (string KeyId, string CertId, string PIXCertChainId, string URL, string[] RequestHeaderList, byte[] RequestData, Int32 TimeOut, Int32 Param)
	PIX Realiza una petición HTTP PUT segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

PIXResponse	getPIX (string KeyId, string CertId, string PIXCertChainId, string URL, string[] RequestHeaderList, Int32 TimeOut, bool UseGzip, bool VerifyHostName)
	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 básica inicial.

PIXResponse	getPIX (cadena KeyId, cadena CertId, cadena PIXCertChainId, cadena URL, cadena[] RequestHeaderList, Int32 TimeOut, Int32 Param)
	PIX Realiza una petición HTTP GET segura siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

PIXResponse	deletePIX (string KeyId, string CertId, string PIXCertChainId, string URL, string[] RequestHeaderList, Int32 TimeOut, bool UseGzip, bool VerifyHostName)
	PIX Realiza una petición HTTP DELETE segura siguiendo el estándar definido en SPI (Sistema de Pago Instantáneo). Utiliza la cabecera HTTP básica inicial.

PIXResponse	deletePIX (string KeyId, string CertId, string PIXCertChainId, string URL, string[] RequestHeaderList, Int32 TimeOut, Int32 Param)
	PIX Realiza una petición segura HTTP DELETE siguiendo el estándar definido en el SPI (Sistema de Pago Instantáneo).

DinamoApi.PIXHTTPReqDetails	getPIXHTTPReqDetails ()
	PIX Recupera los detalles de la última petición HTTP (POST, GET...) realizada en esta sesión. PIX Esta operación debe llamarse inmediatamente después de llamar a la API de petición. Debe llamarse utilizando la misma sesión. No realice ninguna otra operación entre estas llamadas.

Int64	getPIXHTTPReqCode ()
	PIX Recupera el código de retorno de la última petición HTTP (POST, GET...) realizada en esta sesión. PIX Esta operación debe llamarse inmediatamente después de llamar a la API de petición. Debe llamarse utilizando la misma sesión. No realice ninguna otra operación entre estas llamadas.

Funciones

◆ SignPIX() [1/2]

byte[] SignPIX	(	string	KeyId,
		string	CertId,
		int	Flags,
		byte[]	byUnsignedPIXEnvelope )

inline

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

KeyId Nombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.

CertId 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.

Flags

Opciones de suscripción. Pase 0. Si necesita opciones adicionales, se aceptan los siguientes valores.

Valor	Significado
PIXDinamoAPI. _SIGN_RNS	Permite el uso de espacios de nombres relativos.

Parámetros

byUnsignedPIXEnvelope Parámetro que contiene el XML que se va a firmar.

Devolución: El documento XML firmado.

Excepciones

DinamoException Lanza una excepción en caso de error de firma

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

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

Ejemplos: sign_verify_pix.cs.

◆ SignPIX() [2/2]

byte[] SignPIX	(	string	KeyId,
		string	CertId,
		byte[]	byUnsignedPIXEnvelope )

inline

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

KeyId	Nombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.
CertId	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.
byUnsignedPIXEnvelope	Parámetro que contiene el XML que se va a firmar.

Devolución: El documento XML firmado.

Excepciones

DinamoException Lanza una excepción en caso de error de firma

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

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

◆ VerificarPIX() [1/3]

bool VerifyPIX	(	string	ChainId,
		string	CRL,
		string	SignedPIXEnvelope )

inline

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

ChainId	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.
CRL	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.
SignedPIXEnvelope	XML firmado digitalmente

Devolución: Verdadero si la comprobación se realiza correctamente.

Excepciones

DinamoException Lanza una excepción en caso de error.

Ejemplos: sign_verify_pix.cs.

◆ SignPIXDict() [1/2]

byte[] SignPIXDict	(	string	KeyId,
		string	CertId,
		int	Flags,
		byte[]	byUnsignedDictEnvelope )

inline

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

Parámetros

KeyId	Nombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.
CertId	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.
Flags	Reservado para uso futuro (debe ser 0).
byUnsignedDictEnvelope	Parámetro que contiene el XML que se va a firmar.

Devolución: El documento XML firmado.

Excepciones

DinamoException Lanza una excepción en caso de error de firma

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

◆ SignPIXDict() [2/2]

byte[] SignPIXDict	(	string	KeyId,
		string	CertId,
		byte[]	byUnsignedDictEnvelope )

inline

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

Parámetros

KeyId	Nombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.
CertId	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.
byUnsignedDictEnvelope	Parámetro que contiene el XML que se va a firmar.

Devolución: El documento XML firmado.

Excepciones

DinamoException Lanza una excepción en caso de error de firma

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

◆ VerificarPIX() [2/3]

bool VerifyPIX	(	string	ChainId,
		string	CRL,
		int	Flags,
		byte[]	SignedPIXEnvelope )

inline

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

ChainId	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.
CRL	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.
Flags	Reservado para uso futuro (debe ser 0).
SignedPIXEnvelope	XML firmado digitalmente

Devolución: Verdadero si la comprobación se realiza correctamente.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ VerificarPIX() [3/3]

bool VerifyPIX	(	string	ChainId,
		string	CRL,
		byte[]	SignedPIXEnvelope )

inline

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

ChainId	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.
CRL	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.
SignedPIXEnvelope	XML firmado digitalmente

Devolución: Verdadero si la comprobación se realiza correctamente.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ VerificarPIXDict() [1/2]

bool VerifyPIXDict	(	string	ChainId,
		string	CRL,
		int	Flags,
		byte[]	SignedDictEnvelope )

inline

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

ChainId	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.
CRL	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.
Flags	Reservado para uso futuro (debe ser 0).
SignedDictEnvelope	XML firmado digitalmente

Devolución: Verdadero si la comprobación se realiza correctamente.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ VerificarPIXDict() [2/2]

bool VerifyPIXDict	(	string	ChainId,
		string	CRL,
		byte[]	SignedDictEnvelope )

inline

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

ChainId	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.
CRL	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.
SignedDictEnvelope	XML firmado digitalmente

Devolución: Verdadero si la comprobación se realiza correctamente.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ SignPIXJWS() [1/2]

byte[] SignPIXJWS	(	string	KeyId,
		byte[]	byHeader,
		byte[]	byPayload )

inline

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

Parámetros

KeyId Nombre de la clave privada utilizada para firmar. Tal como se define en el PIX

byHeader

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

byPayload Carga útil JWS para la suscripción.

Devolución: JWS firmado.

Excepciones

DinamoException Lanza una excepción en caso de error de firma

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

Ejemplos: sign_check_jws.cs.

◆ SignPIXJWS() [2/2]

string SignPIXJWS	(	string	KeyId,
		string	Header,
		string	Payload )

inline

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

Parámetros

KeyId Nombre de la clave privada utilizada para firmar. Tal como se define en el PIX

Header

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

Payload Carga útil JWS para la suscripción.

Devolución: JWS firmado.

Excepciones

DinamoException Lanza una excepción en caso de error de firma

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

◆ ComprobarPIXJWS() [1/4]

JwsComponents CheckPIXJWS	(	string	Chain,
		string	CRL,
		byte[]	byJWS,
		Int32	flags )

inline

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

Parámetros

Chain	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.
CRL	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.
byJWS	JWS firmado.
flags	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

DinamoException Lanza una excepción en caso de error de verificación

Ejemplos: sign_check_jws.cs.

◆ ComprobarPIXJWS() [2/4]

JwsComponents CheckPIXJWS	(	string	Chain,
		string	CRL,
		string	JWS,
		Int32	flags )

inline

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

Parámetros

Chain	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.
CRL	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.
JWS	JWS firmado.
flags	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

DinamoException Lanza una excepción en caso de error de verificación

◆ ComprobarPIXJWS() [3/4]

bool CheckPIXJWS	(	string	Chain,
		string	CRL,
		byte[]	byJWS )

inline

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

Parámetros

Chain	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.
CRL	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.
byJWS	JWS firmado.

Devolución: Verdadero si la comprobación se realiza correctamente.

Excepciones

DinamoException Lanza una excepción en caso de error de verificación

◆ ComprobarPIXJWS() [4/4]

bool CheckPIXJWS	(	string	Chain,
		string	CRL,
		string	JWS )

inline

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

Parámetros

Chain	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.
CRL	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.
JWS	JWS firmado.

Devolución: Verdadero si la comprobación se realiza correctamente.

Excepciones

DinamoException Lanza una excepción en caso de error de verificación

◆ postPIX() [1/2]

PIXResponse postPIX	(	string	KeyId,
		string	CertId,
		string	PIXCertChainId,
		string	URL,
		string[]	RequestHeaderList,
		byte[]	RequestData,
		Int32	TimeOut,
		bool	UseGzip,
		bool	VerifyHostName )

inline

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

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

Parámetros

KeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
CertId	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.
PIXCertChainId	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.
URL	PIX URL del servidor (ICOM o DICT).
RequestHeaderList	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.
RequestData	Datos enviados en la solicitud.
TimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
UseGzip	Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).
VerifyHostName	Comprueba el certificado con el nombre del host.

Devolución: La respuesta a la solicitud.

Excepciones

DinamoException Lanza una excepción en caso de error en la solicitud

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.

Ejemplos: basic_post_put_get_delete_pix.cs y post_put_get_delete_pix.cs.

◆ postPIX() [2/2]

PIXResponse postPIX	(	string	KeyId,
		string	CertId,
		string	PIXCertChainId,
		string	URL,
		string[]	RequestHeaderList,
		byte[]	RequestData,
		Int32	TimeOut,
		Int32	Param )

inline

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

KeyId Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.

CertId 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.

PIXCertChainId 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.

URL PIX URL del servidor (ICOM o DICT).

RequestHeaderList 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.

RequestData Datos enviados en la solicitud.

TimeOut Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.

Param

Valor	Significado
0	Opción por defecto. No comprueba el certificado con el nombre de host.
PIXDinamoApi. _VERIFY_HOST_NAME	Comprueba el certificado con el nombre del host.
PIXDinamoApi. _BASIC_HTTP_HEADER	Utiliza la cabecera HTTP inicial básica. Incluye Host, User-Agent y Content-Length.
PIXDinamoApi. _GZIP	Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).

Devolución: La respuesta a la solicitud.

Excepciones

DinamoException Lanza una excepción en caso de error en la solicitud

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	KeyId,
		string	CertId,
		string	PIXCertChainId,
		string	URL,
		string[]	RequestHeaderList,
		byte[]	RequestData,
		Int32	TimeOut,
		bool	UseGzip,
		bool	VerifyHostName )

inline

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 básica inicial.

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

Parámetros

KeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
CertId	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.
PIXCertChainId	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.
URL	PIX URL del servidor (ICOM o DICT).
RequestHeaderList	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.
RequestData	Datos enviados en la solicitud.
TimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
UseGzip	Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).
VerifyHostName	Comprueba el certificado con el nombre del host.

Devolución: La respuesta a la solicitud.

Excepciones

DinamoException Lanza una excepción en caso de error en la solicitud

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.

Ejemplos: basic_post_put_get_delete_pix.cs y post_put_get_delete_pix.cs.

◆ putPIX() [2/2]

PIXResponse putPIX	(	string	KeyId,
		string	CertId,
		string	PIXCertChainId,
		string	URL,
		string[]	RequestHeaderList,
		byte[]	RequestData,
		Int32	TimeOut,
		Int32	Param )

inline

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

KeyId Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.

CertId 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.

PIXCertChainId 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.

URL PIX URL del servidor (ICOM o DICT).

RequestHeaderList 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.

RequestData Datos enviados en la solicitud.

TimeOut Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.

Param

Valor	Significado
0	Opción por defecto. No comprueba el certificado con el nombre de host.
PIXDinamoApi. _VERIFY_HOST_NAME	Comprueba el certificado con el nombre del host.
PIXDinamoApi. _BASIC_HTTP_HEADER	Utiliza la cabecera HTTP inicial básica. Incluye Host, User-Agent y Content-Length.
PIXDinamoApi. _GZIP	Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).

Devolución: La respuesta a la solicitud.

Excepciones

DinamoException Lanza una excepción en caso de error en la solicitud

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	KeyId,
		string	CertId,
		string	PIXCertChainId,
		string	URL,
		string[]	RequestHeaderList,
		Int32	TimeOut,
		bool	UseGzip,
		bool	VerifyHostName )

inline

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 básica inicial.

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

Parámetros

KeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
CertId	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.
PIXCertChainId	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.
URL	PIX URL del servidor (ICOM o DICT).
RequestHeaderList	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.
TimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
UseGzip	Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.
VerifyHostName	Comprueba el certificado con el nombre del host.

Devolución: La respuesta a la solicitud.

Excepciones

DinamoException Lanza una excepción en caso de error en la solicitud

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.

Ejemplos: basic_post_put_get_delete_pix.cs y post_put_get_delete_pix.cs.

◆ getPIX() [2/2]

PIXResponse getPIX	(	string	KeyId,
		string	CertId,
		string	PIXCertChainId,
		string	URL,
		string[]	RequestHeaderList,
		Int32	TimeOut,
		Int32	Param )

inline

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

KeyId Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.

CertId 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.

PIXCertChainId 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.

URL PIX URL del servidor (ICOM o DICT).

RequestHeaderList 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.

TimeOut Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.

Param

Valor	Significado
0	Opción por defecto.No comprueba el certificado con el nombre del host.
PIXDinamoApi. _VERIFY_HOST_NAME	Comprueba el certificado con el nombre del host.
PIXDinamoApi. _BASIC_HTTP_HEADER	Utiliza la cabecera HTTP inicial básica. Incluye Host y User-Agent.
PIXDinamoApi. _GZIP	Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.

Devolución: La respuesta a la solicitud.

Excepciones

DinamoException Lanza una excepción en caso de error en la solicitud

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	KeyId,
		string	CertId,
		string	PIXCertChainId,
		string	URL,
		string[]	RequestHeaderList,
		Int32	TimeOut,
		bool	UseGzip,
		bool	VerifyHostName )

inline

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

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

Parámetros

KeyId	Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
CertId	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.
PIXCertChainId	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.
URL	PIX URL del servidor (ICOM o DICT).
RequestHeaderList	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.
TimeOut	Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
UseGzip	Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.
VerifyHostName	Comprueba el certificado con el nombre del host.

Devolución: La respuesta a la solicitud.

Excepciones

DinamoException Lanza una excepción en caso de error en la solicitud

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.

Ejemplos: basic_post_put_get_delete_pix.cs y post_put_get_delete_pix.cs.

◆ deletePIX() [2/2]

PIXResponse deletePIX	(	string	KeyId,
		string	CertId,
		string	PIXCertChainId,
		string	URL,
		string[]	RequestHeaderList,
		Int32	TimeOut,
		Int32	Param )

inline

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

KeyId Nombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.

CertId 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.

PIXCertChainId 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.

URL PIX URL del servidor (ICOM o DICT).

RequestHeaderList 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.

TimeOut Tiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.

Param

Valor	Significado
0	Opción por defecto.No comprueba el certificado con el nombre del host.
PIXDinamoApi. _VERIFY_HOST_NAME	Comprueba el certificado con el nombre del host.
PIXDinamoApi. _BASIC_HTTP_HEADER	Utiliza la cabecera HTTP inicial básica. Incluye Host y User-Agent.
PIXDinamoApi. _GZIP	Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.

Devolución: La respuesta a la solicitud.

Excepciones

DinamoException Lanza una excepción en caso de error en la solicitud

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()

DinamoApi.PIXHTTPReqDetails getPIXHTTPReqDetails ( )

inline

PIX Recupera los detalles de la última petición HTTP (POST, GET...) realizada en esta sesión. PIX Esta operación debe llamarse inmediatamente después de llamar a la API de petición. Debe llamarse utilizando la misma sesión. No realice ninguna otra operación entre estas llamadas.

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

Excepciones

DinamoException Lanza una excepción en caso de error.

Ejemplos: post_put_get_delete_pix.cs.

◆ getPIXHTTPReqCode()

Int64 getPIXHTTPReqCode ( )

inline

PIX Recupera el código de retorno de la última petición HTTP (POST, GET...) realizada en esta sesión. PIX Esta operación debe llamarse inmediatamente después de llamar a la API de petición. Debe llamarse utilizando la misma sesión. No realice ninguna otra operación entre estas llamadas.

Devolución: Código de retorno HTTP.

Excepciones

DinamoException Lanza una excepción en caso de error.