Funcionalidades adicionales

Introducción

En esta sección encontrarás distintas operativas Host2Host que te permitirán realizar determinadas acciones, como ver el estado de una transacción, los detalles de un cliente, etc.

Consulta de estado

En esta sección se encuentra la petición con la que consultar el estado de las transacciones. Se puede consultar una transacción de, como máximo, 2 años de antigüedad.

A continuación, tienes los endpoints a los que enviar las operaciones de consulta de estado:

Petición	Entorno	URL
Estado de la transacción	Staging	https://checkout-stg.addonpayments.com/EPGCheckout/rest/status/merchantcall/repeat
Estado de la transacción	Producción	https://checkout.addonpayments.com/EPGCheckout/rest/status/merchantcall/repeat

Estado de la transacción

Esta petición solicita el mensaje de estado devuelto en una transacción previa.

Esta es una petición de ejemplo para ver el estado de una transacción:

				
					https://checkout-stg.addonpayments.com/EPGCheckout/rest/status/merchantcall/repeat?token={token}&merchantId
={merchantId}&transactions={transactions}=postback={postback}&url={url}

Estos son los parámetros requeridos/obligatorios (R) y opcionales (O) en la petición de estado de la transacción:

Campo	Formato	Tipo	Descripción	Ejemplo
merchantId	Numérico entero 4~7 dígitos	R	Es el indicador de tu comercio en la plataforma de AP. Es facilitado por Soporte en el correo de bienvenida, es común para los dos entornos	14983
token	Cualquiera	R	Hash MD5 del siguiente patrón: {merchantId}.{merchant_transaction_ids}.{merchant_password}	f2768df5cf6574ac5f0c13a71103e984
transactions	Alfanumérico	R	Listado de los ids de las transacciones del comercio que se quieran consultar. Separados por «;». Corresponden al identificador del comercio, es decir, al «merchantTransactionId»	12345;12346;12347
postback	Booleano – 0 – 1	O	Reenvía el estado de la transacción al statusURL original. Por ejemplo, en casos donde por alto volumen de transacciones, no recibieras todas las notificaciones. – 0 para no enviarlo – 1 para enviarlo	1
url	Alfanumérico	O	Nueva Status URL donde Addon Payments enviará la notificación del estado de la transacción.	https://new.url/status

Consulta de estado por fecha

En esta sección está la operación que permite consultar el estado de la transacción por fecha. Puntos a tener en cuenta sobre esta operación:

Estas consultas se deben hacer como máximo por 30 días (inclusive).
En el entorno de pruebas, podemos consultar como máximo del mes pasado. Por ejemplo, si estamos a 12 de marzo, podemos consultar desde el 1 de febrero.
En el entorno de producción, podemos consultar como máximo 2 meses. Por ejemplo, si estamos a 12 de marzo, podemos consultar desde el 1 de enero.

Estos son los endpoints para consultar el estado de la transacción por fecha:

Petición	Entorno	URL
Estado de la transacción por fecha	Staging	https://checkout-stg.addonpayments.com/EPGCheckout/rest/status/statusByDate
Estado de la transacción por fecha	Producción	https://checkout.addonpayments.com/EPGCheckout/rest/status/statusByDate

Estado de la transacción por fecha

Esta petición solicita el mensaje de estado devuelto en las transacciones de las fechas que se indiquen.

Esta es una petición de ejemplo para ver el estado de una transacción por fecha:

				
					https://checkout-stg.addonpayments.com/EPGCheckout/rest/status/statusByDate?merchantId={merchantId}&encrypted
={encrypted}&integrityCheck={integrityCheck}

Antes de cifrar los parámetros (encrypted), debes concatenarlos como en el siguiente ejemplo:

{"merchantId":"21577","from":"2020/08/01 23:59:59", "to":"2020/08/07 23:59:59"}

Para conocer detalles sobre el cifrado de parámetros y envío de la petición, visita nuestra sección de Cifrado, firma y envío de la petición.

Estos son los parámetros requeridos/obligatorios (R) en la petición de estado de la transacción por fecha. Recuerda que deben ser concatenados, cifrados e incluidos en el campo «encrypted»:

Campo	Formato	Tipo	Descripción	Ejemplo
merchantId	Numérico entero 4~7 dígitos	R	Es el indicador de tu comercio en la plataforma de AP. Es facilitado por Soporte en el correo de bienvenida, es común para los dos entornos	14983
from	YYYY/MM/dd HH:mm:ss	R	Fecha desde la que se quiera recopilar las transacciones. Se incluyen año, mes, día, hora, minuto y segundo.	2020/08/01 23:59:59
to	YYYY/MM/dd HH:mm:ss	R	Fecha hasta la que se quiera recopilar las transacciones. Se incluyen año, mes, día, hora, minuto y segundo.	2020/08/07 23:59:59

Además de estos parámetros cifrados dentro del «encrypted», debes enviar el «merchantId» y el «integrityCheck». Más detalles en el documento de cifrado.

Ver datos del cliente

En esta sección puedes encontrar las operaciones usadas para obtener datos del cliente. Hay dos tipos de operaciones que obtienen distintos detalles del cliente:

Detalles del cliente
Resumen del cliente

A continuación, tienes los endpoints utilizados para este tipo de operaciones:

Petición	Entorno	URL
Detalles del cliente	Staging	https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/customer
Detalles del cliente	Producción	https://checkout.addonpayments.com/EPGCheckout/rest/online/customer
Resumen del cliente	Staging	https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/customerSummary
Resumen del cliente	Producción	https://checkout.addonpayments.com/EPGCheckout/rest/online/customerSummary

Detalles del cliente

Esta petición te informa sobre las cuentas de diferentes soluciones de pago que un cliente ha utilizado y almacenado previamente.

Este es un ejemplo de petición para ver los detalles del cliente:

Para conocer detalles sobre el cifrado de parámetros y envío de la petición, visita nuestra sección de Cifrado, firma y envío de la petición.

				
					customerId=000001&paymentSolution=creditcards

				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/customer' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

Los parámetros en cadena son los datos previos al cifrado y envío. Estos deben pasar por el proceso de cifrado y ser incluidos en el envío de la petición (cURL) como «encrypted».

Los parámetros requeridos (R) y opcionales (O) para obtener los detalles del cliente son:

Campo	Formato	Tipo	Descripción	Ejemplo
customerId	Alfanumérico Máx. 80 caracteres	R	Id. del cliente en tu plataforma de comercio electrónico del que quieras obtener la información.	A34623
paymentSolution	Alfanumérico Máx. 45 caracteres	O	Nombre de la solución de pago por la cual se ha procesado al transacción.	creditcards

Resumen del cliente

Esta petición te informa sobre los detalles de las operaciones que el cliente ha realizado a través de Addon Payments.

Este es un ejemplo de petición para ver el resumen del cliente:

Para conocer detalles sobre el cifrado de parámetros y envío de la petición, visita nuestra sección de Cifrado, firma y envío de la petición.

				
					customerId=000001&paymentSolution=creditcards

				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/customerSummary' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

Los parámetros en cadena son los datos previos al cifrado y envío. Estos deben pasar por el proceso de cifrado y ser incluidos en el envío de la petición (cURL) como «encrypted».

Los parámetros requeridos (R) y opcionales (O) para obtener el resumen del cliente del cliente son:

Campo	Formato	Tipo	Descripción	Ejemplo
customerId	Alfanumérico Máx. 80 caracteres	R	Id. del cliente en tu plataforma de comercio electrónico del que quieras obtener la información.	A34623
paymentSolution	Alfanumérico Máx. 45 caracteres	O	Nombre de la solución de pago por la cual se ha procesado al transacción.	creditcards

Bloqueo y desbloqueo de tarjetas

En esta sección encontrarás las operaciones usadas para bloquear y desbloquear tarjetas en Addon Payments mediante su token (identificador que sustituye los datos de la tarjeta). Hay dos tipos de operaciones:

Bloqueo de token
Desbloqueo de token

A continuación, tienes los endpoints a los que enviar estas operaciones de bloqueo/desbloqueo de tarjetas:

Petición	Entorno	URL
Bloqueo de token	Staging	https://api-stg.addonpayments.com/rest/card/block
Bloqueo de token	Producción	https://api.addonpayments.com/rest/card/block
Desbloqueo de token	Staging	https://api-stg.addonpayments.com/rest/card/unblock
Desbloqueo de token	Producción	https://api.addonpayments.com/rest/card/unblock

Bloqueo de token

Esta petición bloquea el número de tarjeta asociado al token enviado.

Este es un ejemplo de petición para bloquear el token:

Para conocer detalles sobre el cifrado de parámetros y envío de la petición, visita nuestra sección de Cifrado, firma y envío de la petición.

				
					customerId=000001&cardNumberToken=4535954006730084

				
					curl --location --request POST 'https://api-stg.addonpayments.com/rest/card/block' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

Los parámetros en cadena son los datos previos al cifrado y envío. Estos deben pasar por el proceso de cifrado y ser incluidos en el envío de la petición (cURL) como «encrypted».

Los parámetros requeridos (R) para el bloqueo de token son:

Campo	Formato	Tipo	Descripción	Ejemplo
customerId	Alfanumérico Máx. 80 caracteres	R	Id. del cliente en tu plataforma de comercio electrónico del que quieras bloquear/desbloquear la tarjeta.	A34623
cardNumberToken	Alfanumérico 16~20 caracteres	R	Token de Addon Payments del número de tarjeta que quieras bloquear/desbloquear. Los últimos 4 dígitos coinciden con el número de tarjeta original.	4535954006730084

Nota: La respuesta devuelve un código 200 (bloqueado/desbloqueado con éxito) aunque el token de la tarjeta no exista. Devuelve un error 400 si alguno de los parámetros necesarios no se ha enviado.

Desbloqueo de token

Esta petición desbloquea el número de tarjeta asociado al token enviado.

Este es un ejemplo de petición para desbloquear el token:

Para conocer detalles sobre el cifrado de parámetros y envío de la petición, visita nuestra sección de Cifrado, firma y envío de la petición.

				
					customerId=000001&cardNumberToken=4535954006730084

				
					curl --location --request POST 'https://api-stg.addonpayments.com/rest/card/unblock' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

Los parámetros en cadena son los datos previos al cifrado y envío. Estos deben pasar por el proceso de cifrado y ser incluidos en el envío de la petición (cURL) como «encrypted».

Los parámetros requeridos (R) para el desbloqueo de token son:

Campo	Formato	Tipo	Descripción	Ejemplo
customerId	Alfanumérico Máx. 80 caracteres	R	Id. del cliente en tu plataforma de comercio electrónico del que quieras bloquear/desbloquear la tarjeta.	A34623
cardNumberToken	Alfanumérico 16~20 caracteres	R	Token de Addon Payments del número de tarjeta que quieras bloquear/desbloquear. Los últimos 4 dígitos coinciden con el número de tarjeta original.	4535954006730084

Obtener información del cajero

En esta sección podrás encontrar las operaciones usadas para obtener información del cajero, como: soluciones de pago disponibles, divisas, etc. La operación disponible para esto es:

Cajero exprés

A continuación, tienes una tabla con los endpoints a los que enviar las operaciones de cajero exprés:

Petición	Entorno	URL
Cajero exprés	Staging	https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/expressCheckoutV2
Cajero exprés	Producción	https://checkout.addonpayments.com/EPGCheckout/rest/online/expressCheckoutV2

Cajero exprés

La petición de cajero exprés te permite conocer las soluciones de pago que tienes disponibles según tu país y divisa. Además, te permite conocer el limite del importe de cada solución de pago. En la respuesta a la petición, tendrás una lista con las soluciones de pago disponibles.

Caché TTL (time to live) es de 10 minutos. Addon Payments actualiza la configuración cada 10 minutos, recomendamos almacenar en caché la solicitud y limpiarla cada 10 minutos.

A continuación, tienes un ejemplo de petición para ver el cajero exprés:

Para conocer detalles sobre el cifrado de parámetros y envío de la petición, visita nuestra sección de Cifrado, firma y envío de la petición.

				
					merchantId=12345&currency=EUR&country=ES&operationType=debit&productId=12345000

				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/expressCheckoutV2' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

Los parámetros en cadena son los datos previos al cifrado y envío. Estos deben pasar por el proceso de cifrado y ser incluidos en el envío de la petición (cURL) como «encrypted».

Los parámetros requeridos (R) para el cajero exprés son:

Campo	Formato	Tipo	Descripción	Ejemplo
merchantId	Numérico entero 4~7 dígitos	R	Es el indicador de tu comercio en la plataforma de AP. Es facilitado por Soporte en el correo de bienvenida, es común para los dos entornos	14983
operationType	Alfanumérico Máx. 45 caracteres	R	Especifica el tipo de operación a realizar. Valores admitidos: – debit (por defecto): Transacción de pago. Es decir, el efectivo viaja desde la cuenta del cliente al comercio. – credit: Transacción de ingreso en cuenta del cliente. Es decir, el efectivo viaja desde el comercio hasta la cuenta del cliente. Por ejemplo, en el pago de un premio. No confundir con las devoluciones. Estas tienen su propio tipo de transacción.	debit
productId	Numérico entero 6~11 dígitos	R	Identificador del producto creado en tu comercio en AP. Es facilitado en el correo de bienvenida.	149830
currency	Alfabético 3 caracteres ISO-4217.3	R	Divisa de la transacción	EUR Códigos de divisa
country	Alfabético 2 caracteres ISO 3166-1 alfa-2	R	País desde el que se envía la transacción.	ES Códigos de países

Funcionalidades adicionales

Introducción

Consulta de estado

Estado de la transacción

Consulta de estado por fecha

Estado de la transacción por fecha

Ver datos del cliente

Detalles del cliente

Resumen del cliente

Bloqueo y desbloqueo de tarjetas

Bloqueo de token

Desbloqueo de token

Obtener información del cajero

Cajero exprés

Tabla de Contenidos

Productos

Ventas

Soporte técnico

Socios

SmartWiki, Impulsada por IA

Funcionalidades adicionales

Introducción

Consulta de estado

Estado de la transacción

Consulta de estado por fecha

Estado de la transacción por fecha

Ver datos del cliente

Detalles del cliente

Resumen del cliente

Bloqueo y desbloqueo de tarjetas

Bloqueo de token

Desbloqueo de token

Obtener información del cajero

Cajero exprés

Tabla de Contenidos

Productos

Ventas

Soporte técnico

Socios

SmartWiki, Impulsada por IA

Cyberpac

Consulta la documentación de las distintas secciones de integraciones:

Addon Payments

Pagos integrados en TPV