PayByBank

Introducción

PayByBank (PBB) es un método de pago online que permite a los usuarios realizar transferencias bancarias directas de forma rápida, segura y sin necesidad de utilizar tarjetas ni crear cuentas adicionales.

La solución, ofrecida por Addon Payments, se apoya en la infraestructura de Tink, plataforma líder de open banking que actúa como agregador y conexión con múltiples entidades bancarias europeas. Fundada en 2012 y adquirida por Visa en 2022, Tink ha desarrollado una de las plataformas de banca abierta más robustas de Europa, con una amplia conectividad y capacidades avanzadas que permiten a bancos, fintechs y comercios crear experiencias de pago y servicios financieros innovadores.

PayByBank se posiciona como una alternativa eficiente a los métodos de pago tradicionales, facilitando transacciones inmediatas directamente desde la cuenta bancaria del cliente.

Tipo de pagoTransferencia bancaria
Países disponiblesAUT, BEL, DNK, EST, FIN,
FRA, DEU, IRL, ITA, LVA,
LTU, NLD, NOR, POL, PRT,
ESP, SWE, GBR
Divisas disponiblesEuro, libra esterlina, corona sueca, corona danesa, corona noruega y zloty polaco.
¿Necesita redirección?Sí
¿Admite devoluciones?Sí, total y parcial

Operativas admitidas

PayByBank está disponible en los 3 tipos de integración. Por otro lado, las operativas admitidas son:

  • Autorización: Un pago normal del cliente a tu comercio. La captura del importe es automática.
  • Devoluciones: Devoluciones totales o parciales. A través del BackOffice o mediante endpoint.
OperativaHostedHost2HostJavaScript
AutorizaciónSíSíSí
Devolución (parcial y total)NoSíNo

Requisitos para usar PayByBank

En esta sección tienes los requisitos que deben cumplir los clientes y comercios para poder usar PayByBank en tu comercio con Addon Payments.

Requisitos para clientes

Para poder usar PayByBank – Tink, los clientes deben:

  • Disponer de una cuenta bancaria en alguno de los bancos disponibles en la plataforma Tink.
  • Disponer de acceso online a dicha cuenta bancaria.

Requisitos para comercios

Antes de empezar a integrar la solución PayByBank con Tink, debes solicitar al equipo de Soporte de Addon Payments la activación y configuración de PBB en tu TPV Virtual.

Entornos y endpoints: Staging y Producción

Addon Payments cuenta con dos (2) entornos operativos independientes:

Entorno de Staging:

  • Es el primer entorno con el cual entrarás en contacto.
  • Puedes hacer pruebas con las credenciales de la sección anterior.
  • Esto te permite comprobar la correcta gestión de las diferentes casuísticas por parte de tu integración.
  • Las tarjetas y cuentas reales no funcionan.

Entorno de Producción:

  • Es el entorno en el cual las transacciones tienen efectos contables.
  • Únicamente se puede transaccionar con tarjetas y cuentas reales y operativas.

A continuación, tienes los endpoints según el tipo de integración:

EntornoHostedHost2Host
Staginghttps://checkout-stg.addonpayments.com/EPGCheckout/rest/online/tokenize
https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/pay
Producciónhttps://checkout.addonpayments.com/EPGCheckout/rest/online/tokenize
https://checkout.addonpayments.com/EPGCheckout/rest/online/pay
PeticiónEntornoURL
Petición /authStaginghttps://epgjs-mep-stg.addonpayments.com/auth
Petición /chargeStaginghttps://epgjs-mep-stg.addonpayments.com/charge/v2
Petición /authProducciónhttps://epgjs-mep.addonpayments.com/auth
Petición /chargeProducciónhttps://epgjs-mep.addonpayments.com/charge/v2

Realizar pruebas en staging

Paybybank dispone de un entorno de pruebas ficticio que permite probar la integración sin la necesidad de utilizar datos reales, para ello se utiliza Demo Bank. Demo Bank es un banco ficticio donde, utilizando un usuario y contraseña de prueba para simular el inicio de sesión durante el proceso de pago, permite probar distintas situaciones determinadas.

Para realizar operaciones de prueba en staging con PayByBank el importe de las transacciones debe de ser superior a 10€.

Las operaciones de PayByBank realizadas en el entorno de pruebas podrán llegar como máximo al estado SUCCESS_WARNING. Debido a que la liquidación de la operación no se contempla en el entorno de pruebas, las operaciones no serán actualizadas al estado SUCCESS en el entorno de pruebas.

Según las pruebas que necesites realizar puedes utilizar las siguientes credenciales en Demo Bank:

Escenario esperadoUsuarioContraseñaDescripción
SUCCESSu89609866bst827Usuario con múltiples cuentas personales para realizar operaciones correctas en transacciones superiores a 10€
ERRORu92721594nbs589Error en la autorización
ERRORu91902655jtx720Error puntual con PayByBank

Sigue estos pasos para realizar pruebas de pago con Demo Bank:

  1. Selecciona «Tink Demo Bank».
  2. A continuación, selecciona «Open banking».
  3. Selecciona «Redirect».
  4. Pulsa en «Abrir inicio de sesión en Tink Demo Bank».
  5. Utiliza el usuario y contraseña de la tabla superior según la prueba que necesites realizar:
  6. Selecciona «Authorize».
  7. Marca la cuenta con la que deseas realizar la operación y pulsa en «Continuar».
  8. Por último, pulsa en «Confirm» y la transacción será realizada.
pbb-tink_demo-bank2
pbb-tink_demo-bank4
pbb-tink_demo-bank6
pbb-tink_demo-bank7

Datos requeridos y opcionales PayByBank

A continuación tienes una tabla con los parámetros requeridos para mandar una petición con PayByBank. Estos datos son comunes en los 3 tipos de integración: Hosted, Host2Host y JavaScript. El tipo indica que el parámetro es requerido/obligatorio (R). 

CampoFormatoTipoDescripciónEjemplo
paymentSolutionAlfanuméricoRNombre de la solución de pago por la cual debe procesarse la transacción. IMPORTANTE: Si quieres que se muestren todas las soluciones de pago que tengas disponibles, NO envíes este parámetro.PayByBank
productIdNumérico entero
Máximo 20 caracteres		OIdentificador del producto creado en tu comercio en AP. Es facilitado en el correo de bienvenida.149830
customerIdAlfanumérico
Máx. 80 caracteres		OId. del cliente en tu plataforma de comercio electrónico.A34623
countryAlfabético
2 caracteres
ISO 3166-1 alfa-2		RPaís desde el que se envía la transacción. PayByBank sólo está disponible en países de zona Euro y Reino Unido.ES
currencyAlfabético
3 caracteres		RDivisa de la transacción.EUR
merchantIdNumérico entero
Máx. 20 dígitos		REs 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 entornos1115
merchantTransactionIdAlfanumérico
Máx. 18 caracteres		REs el identificador único de la transacción del comercio. Sirve para que tu plataforma enlace las notificaciones recibidas con el pedido del cliente.123321as
amountNumérico decimal
0~1000000000.00		RImporte de la transacción. Si el importe tiene decimales, el separador es un punto (.). No se puede incluir el separador en los millares12.22
operationTypeAlfabéticoREspecifica el tipo de operación a realizar. Valor admitido:
– debit (por defecto): Transacción de pago. Es decir, el efectivo viaja desde la cuenta del cliente al comercio.		debit
customerCountryCódigo ISO 3166-2RPaís del cliente.ES
statusUrlAlfanumérico (caracteres permitidos en URL)
Máx. 250 caracteres		RURL de tu plataforma de comercio electrónico donde AP enviará la notificación con el estado de la transacción. Si se envía en la petición, tendrá prioridad sobre la configurada en el Portal BackOffice de Addon Payments. Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.https://receivedcallback.com
successUrlAlfanumérico (caracteres permitidos en URL)
Máx. 250 caracteres		RURL de tu plataforma a la que se redirecciona al cliente si la transacción es autorizada. Si se envía en la petición, tendrá prioridad sobre la configurada en el Portal BackOffice de Addon Payments. Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.https://returntoSuccess.com
errorUrlAlfanumérico (caracteres permitidos en URL)
Máx. 250 caracteres		RURL de tu plataforma a la que se redirecciona al cliente si la transacción es denegada. Si se envía en la petición, tendrá prioridad sobre la configurada en el Portal BackOffice de Addon Payments. Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.https://returntoError.com
cancelUrlAlfanumérico (caracteres permitidos en URL)
Máx. 250 caracteres		RURL de tu plataforma a la que se redirecciona el cliente si cancela la transacción durante el proceso de pago. Si se envía en la petición, tendrá prioridad sobre la configurada en el Portal BackOffice de Addon Payments. Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.https://cancelledTransaction.com
awaitingUrlAlfanumérico (caracteres permitidos en URL)
Máx. 250 caracteres		RURL de tu plataforma a la que se redirecciona el cliente si la transacción está pendiente de procesar. Si se envía en la petición, tendrá prioridad sobre la configurada en el Portal BackOffice de Addon Payments. Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.https://receivedcallback.com/awaiting
languageCódigo ISO 639-1OIdioma para mostrar en la pasarela de pago al cliente. Los idiomas soportados por PayByBank son: EN, ES, FR, DE, IT, PT, NL, SV, DA, NO, FI, PL, CS, ET, LV.

Si el código de idioma no es uno de los soportados o si se omite el parámetro, se utilizará por defecto Inglés (EN).		ES

Integración Host2Host

Con Addon Payments puedes usar la solución de pago PayByBank con tu integración Host2Host. Te recomendamos que visites la documentación Host2Host para conocer más detalles sobre este tipo de integración. Los links de pago a los que se ha redirigido al cliente se pueden volver a clicar siempre que el pago no se haya completado. En Addon Payments, estas operaciones tendrán el estado REDIRECTED.

Autorización

La autorización es una operación de pago del cliente al comercio. La captura del importe es automática. Envía la petición al endpoint Host2Host correspondiente.

Petición

Estos son unos ejemplos de autorización mediante PayByBank por Host2Host. Recuerda que la petición en cadena debe pasar el proceso de cifrado.

				
					merchantId=12345&paymentSolution=PayByBank&customerId=123456&merchantTransactionId=1402003&amount=11&currency=EUR&country=ES&operationType=debit&customerCountry=ES&statusURL=https://test.com/status&successURL=https://test.com/success&errorURL=https://test.com/error&cancelURL=https://test.com/cancel&awaitingURL=https://test.com/awaiting
				
			
				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/pay' \
--header 'apiVersion: 5' \
--header 'encryptionMode: CBC' \
--header 'iv: 0Pn6pDEm73YvekNKUJcvwg==' \
--form 'merchantId="12345"' \
--form 'encrypted="jULXEtDfSVYIgfV29GBTcibe+ED+IvnfI2ssayrpqoJRzmI+SVst1SV3LRjt7DHlU5+0FoBPZy8KfoajNYn6DwRU0ltMtgd2TsR2ccm+Aeg5NAPbMlVZZnDmWA2WUmh3sXFWDMFGcHnwigMv0dWW+0QOieFJN+NLPMo/HMhLOLNNfS9240qdT++PTx7IdtSM3hfbD31ZDgKSkxwCDQYSrcIS0LyPtRuRkMQjHNMjOzo/FNSe0dqTdRw0dI5QpoqAgFk8MEkByIiZPIK6GYzkRv9NsBrVpRw3271VPG7gDlK4+ZEkjRXJ+JQgV0QxybU4XNE1pPlB3BxzBtsr56gPEVCNrVjNQtfTwNqphT39+7GShtEUrAsKU7r+nxivGxhd/8b2ECkk/7Dk7WPLnCJPnXJrIAWzKd1wiPaTPYrMvCuxRAMYF+sk6ZPENAipntbetAbXHDVs6KKbjyCjDLRwGX7rrIlPi0TTIH9nGfPTq4DL1CDxivnjd1eOGOnHzQRr”' \
--form 'integrityCheck="0bc22b4408a6a2bf135fd2eb3832775f44b02f96d7e10d940b81c5069763685f"'

Respuesta

Este es un ejemplo de la respuesta recibida a una petición de autorización PayByBank:

				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payfrex-response operation-size="1">
    <message>WorkFlow has finished successfully, for transaction Id: 535028</message>
    <operations>
        <operation sorted-order="1">
            <amount>10</amount>
            <currency>EUR</currency>
            <details>{"amount":10.00,"currency":"EUR","id":"efb45645yg565645463f9","market":"ES","merchantId":"b29a7bc4-54uid-4a5e-b2ac-v43oi34vd","paymentScheme":"SEPA_CREDIT_TRANSFER"
              ,"recipient":{"accountNumber":"ES3684651318746534683","accountType":"IBAN"},"recipientName":"TMaC SL","remittanceInformation":{"type":"UNSTRUCTURED",
              "value":"MERCHANT-S1-1406825579-1088"},"sourceMessage":""}</details>
            <merchantTransactionId>MERCHANT-S1-1406825579</merchantTransactionId>
            <message>Operation redirected, continue with the payment.</message>
            <operationType>DEBIT</operationType>
            <optionalTransactionParams/>
            <payFrexTransactionId>535028</payFrexTransactionId>
            <paySolTransactionId>efb121588447425694e819dda323a3f9</paySolTransactionId>
            <paymentSolution>paybybank</paymentSolution>
            <redirectionResponse>redirect:https://link.tink.com/1.0/pay/?client_id=a12f4fb53d364d0fbb0a2c49fa9e24ea&amp;amp;
              redirect_uri=https://checkout-team04.epgpay.com/EPGCheckout/returnurl/returnUrlTink/paysol/paybybank/&amp;amp;
              payment_request_id=efb121588447425694e819dda323a3f9&amp;market=&amp;locale=&amp;session_id=819e2e21580441a9be3be8e7cb7743ce0611d440186f4666b1040bcae08ec361&lt;/redirectionResponse>
            <status>REDIRECTED</status>
        </operation>
    </operations>
    <optionalTransactionParams/>
    <status>SUCCESS</status>
    <workFlowResponse>
        <id>15139</id>
        <name>DEbit</name>
        <version>0</version>
    </workFlowResponse>
</payfrex-response>
La URL donde se debe redirigir al cliente para proceder con el pago en PayByBank es la que se muestra dentro de redirectionResponse. Esta URL requiere de un tratamiento previo a realizarse la redirección en base a la siguiente URL:
				
					<redirectionResponse>redirect:https://link.tink.com/1.0/pay/?client_id=e86731ec45374c88a8c4e3b4dfe3cf36&amp;redirect_uri=https://checkout.stg-eu-west1.epgint.com/EPGCheckout/returnurl/returnUrlTink/paysol/paybybank&amp;payment_request_id=6d866107eca546b385c2ece6f1c527a0&amp;market=ES&amp;locale=es-ES&amp;session_id=ecdaf5cec1274203975a3a69261b3a3f7f3ea47abfe7436a9d8de902f3a09c11</redirectionResponse>
Se debe de omitir la parte inicial de  «redirect:»  y eliminar los «amp;» presentes en la URL. Siguiendo con el mismo ejemplo, la URL a la que redirigir quedaría de la siguiente forma:
				
					https://link.tink.com/1.0/pay/?client_id=e86731ec45374c88a8c4e3b4dfe3cf36&redirect_uri=https://checkout.stg-eu-west1.epgint.com/EPGCheckout/returnurl/returnUrlTink/paysol/paybybank&payment_request_id=6d866107eca546b385c2ece6f1c527a0&market=ES&amp;locale=es-ES&;session_id=ecdaf5cec1274203975a3a69261b3a3f7f3ea47abfe7436a9d8de902f3a09c11
Cuando el cliente finaliza el pago, PayByBank devuelve el estado de la operación y Addon Payments actualiza el estado de la transacción y envia una notificación con el estado a la statusURL definida. Para conocer mayor detalle de los estados de las operaciones de PayByBank visita esta sección.

 

El cliente será redirigido a las URLs de OK, Cancel, Error o Awaiting, en función del estado de la operación y del posible error recibido:

  • successURL: el cliente es redirigido si el estado de transacción = SUCCESS_WARNING
  • cancelURL: el cliente es redirigido si el estado de la transacción ≠ SUCCESS_WARNING y estado en PayByBank = USER_CANCELLED
  • errorURL: el cliente es redirigido si el estado de la transacción ≠ SUCCESS_WARNING y estado en PayByBank ≠ USER_CANCELLED
  • awaitingURL: el cliente es redirigido si el estado de la transacción = REDIRECTED y no se informa error en el estado de PayByBank.

Devoluciones

Puedes realizar devoluciones parciales o totales del importe de una operación PayByBank, siempre que al operación esté autorizada y liquidada. Puedes realizar devoluciones mediante:

Devolución mediante petición

Estos son los endpoints donde se envían las peticiones de devolución.

EntornoURL
Staginghttps://checkout-stg.addonpayments.com/EPGCheckout/rest/online/rebate
Producciónhttps://checkout.addonpayments.com/EPGCheckout/rest/online/rebate

Petición

Estos son unos ejemplos de petición de devolución de una transacción PayByBank por Host2Host. Recuerda que la petición en cadena debe pasar el proceso de cifrado. 

				
					merchantId=12345&merchantTransactionId=61565574&amount=5&paymentSolution=PayByBank&transactionId=7556056
				
			
				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/rebate' \
--header 'apiVersion: 5' \
--header 'encryptionMode: CBC' \
--header 'iv: Z7VA6TpG9B84X9x9qqXoWQ==' \
--form 'merchantId="12345"' \
--form 'encrypted="4xUYxJxLc/ABCyqJfwttTalkds3YeijsJe6MlTnC6mgmbm0aXKwhI7thwa70o6lLyjrUtW8fFNUWf/l3jIojR4H5nW54Pl+GxerG1/AjMFpHlacchB3+kfkZzko42dQKk7MopAALi6SAFbl1Uq//qsESz8fV07ED7IvRQwlXREZDFtxQn2m9eyPr5zrJczILhRx27p3lqFQ61Sqlq0nCN+3sgJmuPUMKRqlXhYqf+vErv+fBaZMPV/8iKgERJLpIjPn+HZSLpc+q5VBcD4b+rGAgEKNi56Ni/MPCpKVWBUv8HFb06PngrLfiXcnFTfNeegg0XPkkmuGwR1l1y/k1tv9dPrdBkSIwE2OuHYvrkrn+NAOTHBxjGR4Ap93aZEwcPX9afkHkFOMi/5e3JdoxtFvSwOCe1ScEw2vRDhonE+5lV7jwOrqSMr+tfWVGPqzrYj/DZiQwCIUQJM6g5x+ocLTAURzz4IiJ26kBlQpYVnedKEVhevNJNZ88z6m50W2THtDR70pQq6qjF37NCfOeq/UDCg0RB/MPfYUJRUIsfPk=' \
--form 'integrityCheck="1c256f5b834e5db6d5f453043a8a3830859b308f297cc2cf423064510c5c9b72"'

Parámetros de la solicitud de devolución

Estos son los parámetros a enviar para una petición de devolución de una transacción PayByBank. La columna tipo indica si el elemento es Requerido/Obligatorio (R) u Opcional (O).

CampoFormatoTipoDescripciónEjemplo
merchantIdNumérico entero (4~7 dígitos)REs 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
transactionIdNumérico entero (Máx. 100 dígitos)RIdentificador de la transacción original sobre la cual va a realizarse una operación secundaria, como captura, liberación o devolución.76543210
paymentSolutionAlfanumérico (Máx. 45 caracteres)RNombre de la solución de pago por la cual ha sido procesada la transacción inicial. Se indica en la respuesta de la transacción original.PayByBank
amountNumérico decimal (0~1000000.00)RImporte de la transacción. Si el importe contiene decimales, debe usar el punto (.) como separador. No se puede incluir separador de millares.10.50
merchantTransactionIdMáx. 45 caracteres. Página de códigos Latin-1 (ISO-8859-1)RIdentificador de la transacción en tu plataforma de comercio electrónico. Sirve para que tu plataforma enlace las notificaciones recibidas con el pedido del cliente. No puede repetirse entre transacciones.pedido_91684
descriptionMáx. 1000 caracteres. Página de códigos Latin-1 (ISO-8859-1)ODescripción de la transacción. Se guarda en los detalles de la transacción y se devuelve en la notificación. No afecta a la transacción, sirve para que puedas realizar una mejor identificación.Devolución después de entregar producto

Respuesta

Este es un ejemplo de notificación de una devolución de una operación de PayByBank:

				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payfrex-response operation-size="1">
    <operations>
         <operation sorted-order="1">
                        <amount>0.30</amount>
                    <currency>EUR</currency>
                     <details>{"id":"31","self":"/2.0/orders/31","name":"(1x) Test027","value":"0.3","currency":"EUR","amount":"0,30 €","status":"REIMBURSED","sandbox":0,"images":["https://comercia.truust.io/assets/images/MpOWk5m7kg.jpg"],"tag":"test027","metadata":{"merchant_id":"12345","product_id":"123450001","buyer_confirmed_url":"https://success.es/success","buyer_denied_url":"https://error.es/error","buyer_cancel_url":"https://cancel.es/cancel","awaiting_url":"https://awaiting.es/awaiting","merchant_notification_url":"https://status.es/status","ownership_check_enabled":false,"tink_url":"https://link.tink.com/1.0/pay/?client_id\u003d94396fec34b64a3fb91ae6cbd8fc4ae5\u0026redirect_uri\u003dhttps://checkout.prd-eu-west3-c.epgint.com/EPGCheckout/returnurl/returnUrlTink/paysol/paybybank\u0026payment_request_id\u003d622ee6dd357e4e42b3c082f23d7d56bd\u0026market\u003dES\u0026locale\u003den-GB\u0026session_id\u003dbfe9d29af82e46b0b78c8df33551a58ff6beebdbafc84061ba063b74405cbc9e","payin_bank_account":10.0},"refundStatus":"CONFIRMED","buyer":"/2.0/customers/vkaQk0","payins":"/2.0/payins?search\u003descrow_id\u0026query\u003d31","seller":"/2.0/customers/d3q8wQ"}</details>
                        <merchantTransactionId>test027</merchantTransactionId>
                   <message>Transaction amount refunded successfully</message>
                       <operationType>REFUND</operationType>
                   <optionalTransactionParams/>
                        <originalPayFrexTransactionId>943790789</originalPayFrexTransactionId>
                   <payFrexTransactionId>944180879</payFrexTransactionId>
                      <paySolTransactionId>31</paySolTransactionId>
                  <paymentDetails>
                           <extraDetails/>
                     </paymentDetails>
                     <paymentSolution>paybybank</paymentSolution>
                  <remainingAmount>0.00</remainingAmount>
                    <status>SUCCESS</status>
             </operation>
  </operations>
      <status>SUCCESS</status>
</payfrex-response>

Integración Hosted

La solución de pago de PayByBank está disponible en integraciones Hosted. Puedes elegir si mostrar el cajero completo con todas las soluciones de pago que tu comercio tiene activas, o únicamente PayByBank. Te recomendamos que visites la documentación Hosted para conocer más detalles sobre este tipo de integración. Los links de pago a los que se ha redirigido al cliente se pueden volver a clicar siempre que el pago no se haya completado. En Addon Payments, estas operaciones tendrán el estado REDIRECTED.

Autorización

La autorización es una operación de pago del cliente al comercio. La captura del importe es automática. Envía la petición al endpoint Hosted correspondiente. 

Petición

Estos son unos ejemplos de autorización mediante PayByBank por Hosted. Recuerda que la petición en cadena debe pasar el proceso de cifrado.  

				
					merchantId=12345&paymentSolution=PayByBank&customerId=123456&merchantTransactionId=1402003&amount=11&currency=EUR&country=ES&operationType=debit&customerCountry=ES&statusURL=https://test.com/status&successURL=https://test.com/success&errorURL=https://test.com/error&cancelURL=https://test.com/cancel&awaitingURL=https://test.com/awaiting
				
			
				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/tokenize' \
--header 'apiVersion: 5' \
--header 'encryptionMode: CBC' \
--header 'iv: 0Pn6pDEm73YvekNKUJcvwg==' \
--form 'merchantId="12345"' \
--form 'encrypted="jULXEtDfSVYIgfV29GBTcibe+ED+IvnfI2ssayrpqoJRzmI+SVst1SV3LRjt7DHlU5+0FoBPZy8KfoajNYn6DwRU0ltMtgd2TsR2ccm+Aeg5NAPbMlVZZnDmWA2WUmh3sXFWDMFGcHnwigMv0dWW+0QOieFJN+NLPMo/HMhLOLNNfS9240qdT++PTx7IdtSM3hfbD31ZDgKSkxwCDQYSrcIS0LyPtRuRkMQjHNMjOzo/FNSe0dqTdRw0dI5QpoqAgFk8MEkByIiZPIK6GYzkRv9NsBrVpRw3271VPG7gDlK4+ZEkjRXJ+JQgV0QxybU4XNE1pPlB3BxzBtsr56gPEVCNrVjNQtfTwNqphT39+7GShtEUrAsKU7r+nxivGxhd/8b2ECkk/7Dk7WPLnCJPnXJrIAWzKd1wiPaTPYrMvCuxRAMYF+sk6ZPENAipntbetAbXHDVs6KKbjyCjDLRwGX7rrIlPi0TTIH9nGfPTq4DL1CDxivnjd1eOGOnHzQRr”' \
--form 'integrityCheck="0bc22b4408a6a2bf135fd2eb3832775f44b02f96d7e10d940b81c5069763685f"'

Recibirás una respuesta a esta petición con el enlace al cajero Hosted al que debes redirigir al cliente. Este es im ejemplo de URL a la que se tendrá que redirigir:

				
					https://checkout.stg-eu-west1.epgint.com/EPGCheckout/rest/online/detokenize?token=3a57eebe-9e4e-41ab-8ddc-a00949372c14&apiVersion=5

Parámetros de la solicitud de autorización

Puedes ver en la tabla común los parámetros requeridos para enviar para una petición de autorización PayByBank vía Hosted.

Respuesta

Este es un ejemplo de respuesta recibida a una petición de autorización de una operación PayByBank:

				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payfrex-response operation-size="1">
    <message>WorkFlow has finished successfully, for transaction Id: 535028</message>
    <operations>
        <operation sorted-order="1">
            <amount>10</amount>
            <currency>EUR</currency>
            <details>{"amount":10.00,"currency":"EUR","id":"53hoh5oj26bh23bh65jñ736io23b3","market":"ES","merchantId":"o7pñib3hjw4v-32ik-24ho-b2ac-6v3m4n345mnebt535","paymentScheme":"SEPA_CREDIT_TRANSFER"
              ,"recipient":{"accountNumber":"ES0245724598752789254789","accountType":"IBAN"},"recipientName":"TMaC SL","remittanceInformation":{"type":"UNSTRUCTURED",
              "value":"MERCHANT-S1-1406825579-1088"},"sourceMessage":""}</details>
            <merchantTransactionId>MERCHANT-S1-1406825579</merchantTransactionId>
            <message>Operation redirected, continue with the payment.</message>
            <operationType>DEBIT</operationType>
            <optionalTransactionParams/>
            <payFrexTransactionId>535028</payFrexTransactionId>
            <paySolTransactionId>efb121588447425694e819dda323a3f9</paySolTransactionId>
            <paymentSolution>paybybank</paymentSolution>
            <redirectionResponse>redirect:https://link.tink.com/1.0/pay/?client_id=a12f4fb53d364d0fbb0a2c49fa9e24ea&amp;amp;
              redirect_uri=https://checkout-team04.epgpay.com/EPGCheckout/returnurl/returnUrlTink/paysol/paybybank/&amp;amp;
              payment_request_id=efb121588447425694e819dda323a3f9&amp;market=&amp;locale=&amp;session_id=819e2e21580441a9be3be8e7cb7743ce0611d440186f4666b1040bcae08ec361&lt;/redirectionResponse>
            <status>REDIRECTED</status>
        </operation>
    </operations>
    <optionalTransactionParams/>
    <status>SUCCESS</status>
    <workFlowResponse>
        <id>15139</id>
        <name>DEbit</name>
        <version>0</version>
    </workFlowResponse>
</payfrex-response>
Cuando el cliente finaliza el pago, PayByBank devuelve el estado de la operación y Addon Payments actualiza el estado de la transacción y envia una notificación con el estado a la statusURL definida. Para conocer mayor detalle de los estados de las operaciones de PayByBank visita esta sección.
 
El cliente será redirigido a las URLs de OK, Cancel, Error o Awaiting, en función del estado de la operación y del posible error recibido:
  • successURL: el cliente es redirigido si el estado de transacción = SUCCESS_WARNING
  • cancelURL: el cliente es redirigido si el estado de la transacción ≠ SUCCESS_WARNING y estado en PayByBank = USER_CANCELLED
  • errorURL: el cliente es redirigido si el estado de la transacción ≠ SUCCESS_WARNING y estado en PayByBank ≠ USER_CANCELLED
  • awaitingURL: el cliente es redirigido si el estado de la transacción = REDIRECTED y no se informa error en el estado de PayByBank.

Integración JavaScript

Con Addon Payments puedes usar la solución de pago PayByBank con tu integración JavaScript. Esta integración tiene algunos pasos extra diferentes al resto de integraciones, por lo que te recomendamos que visites la documentación JavaScript para conocer más detalles.

Los links de pago a los que se ha redirigido al cliente se pueden volver a clicar siempre que el pago no se haya completado.  En Addon Payments, estas operaciones tendrán el estado REDIRECTED.

Autorización

La autorización es una operación de pago del cliente al comercio. La captura del importe es automática. Envía la petición al endpoint JavaScript correspondiente.  

Obtención del authToken y renderizado del cajero

El primer paso es solicitar el authToken y renderizar el cajero. Este paso es igual independientemente de la integración JavaScript. Consulta la documentación:

Charge

Con la obtención del «prepayToken», podrás enviar la petición de pago/charge. A continuación, te mostramos un ejemplo de petición PayByBank vía JavaScript.

				
					merchantId=12345&paymentSolution=PayByBank&customerId=123456&merchantTransactionId=1402003&amount=11&currency=EUR&country=ES&operationType=debit&customerCountry=ES&statusURL=https://test.com/status&successURL=https://test.com/success&errorURL=https://test.com/error&cancelURL=https://test.com/cancel&awaitingURL=https://test.com/awaiting
				
			
				
					curl --location --request POST 'https://epgjs-mep-stg.addonpayments.com/charge/v2' \
--header 'Content-Type: application/json' \
--header 'prepayToken: 8862abf9-ca5a-49da-9527-1e3163e64954' \
--data-raw '{
    "merchantId": "12345",
    "merchantTransactionId": "1402003",
    "apiVersion": "5",
    "amount": "11.00",
    "currency": "EUR",
    "country": "ES",
    "customerId": "000001",
    "customerCountry": "ES",
    "paymentSolution": "PayByBank",
    "productId": "123450001",
    "statusURL": "https://test.com/status",
    "successURL": "https://test.com/success",
    "errorURL": "https://test.com/error",
    "cancelURL": "https://test.com/cancel",
    "awaitingURL": "https://test.com/awaiting"
}'

Parámetros de la solicitud charge

Puedes ver en la tabla común los parámetros requeridos para enviar para una petición charge de autorización PayByBank vía JavaScript. Además, deberás enviar este parámetro que habrás obtenido previamente:

  • prepayToken: Se envía en la cabecera de la petición. AP devuelve esta referencia después de que el cliente introduzca sus datos en el formulario de pago de JS. Es la referencia que enlaza con los datos de la tarjeta o cuenta del cliente para integración JavaScript.

Respuesta

Este es un ejemplo de notificación a una transacción PayByBank con el resultado de la transacción:

				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payfrex-response operation-size="1">
    <message>WorkFlow has finished successfully, for transaction Id: 535028</message>
    <operations>
        <operation sorted-order="1">
            <amount>10</amount>
            <currency>EUR</currency>
            <details>{"amount":10.00,"currency":"EUR","id":"efb121588447425694e819dda323a3f9","market":"ES","merchantId":"b29a7bc4-8e56-4a5e-b2ac-c23bfb13998a","paymentScheme":"SEPA_CREDIT_TRANSFER"
              ,"recipient":{"accountNumber":"ES9121000418450200051332","accountType":"IBAN"},"recipientName":"TMaC SL","remittanceInformation":{"type":"UNSTRUCTURED",
              "value":"MERCHANT-S1-1406825579-1088"},"sourceMessage":""}</details>
            <merchantTransactionId>MERCHANT-S1-1406825579</merchantTransactionId>
            <message>Operation redirected, continue with the payment.</message>
            <operationType>DEBIT</operationType>
            <optionalTransactionParams/>
            <payFrexTransactionId>535028</payFrexTransactionId>
            <paySolTransactionId>efb121588447425694e819dda323a3f9</paySolTransactionId>
            <paymentSolution>paybybank</paymentSolution>
            <redirectionResponse>redirect:https://link.tink.com/1.0/pay/?client_id=a12f4fb53d364d0fbb0a2c49fa9e24ea&amp;amp;
              redirect_uri=https://checkout-team04.epgpay.com/EPGCheckout/returnurl/returnUrlTink/paysol/paybybank/&amp;amp;
              payment_request_id=efb121588447425694e819dda323a3f9&amp;market=&amp;locale=&amp;session_id=819e2e21580441a9be3be8e7cb7743ce0611d440186f4666b1040bcae08ec361&lt;/redirectionResponse>
            <status>REDIRECTED</status>
        </operation>
    </operations>
    <optionalTransactionParams/>
    <status>SUCCESS</status>
    <workFlowResponse>
        <id>15139</id>
        <name>DEbit</name>
        <version>0</version>
    </workFlowResponse>
</payfrex-response>
La URL donde se debe redirigir al cliente para proceder con el pago en PayByBank es la que se muestra dentro de redirectionResponse. Esta URL requiere de un tratamiento previo a realizarse la redirección en base a la siguiente URL:
				
					<redirectionResponse>redirect:https://link.tink.com/1.0/pay/?client_id=e86731ec45374c88a8c4e3b4dfe3cf36&amp;redirect_uri=https://checkout.stg-eu-west1.epgint.com/EPGCheckout/returnurl/returnUrlTink/paysol/paybybank&amp;payment_request_id=6d866107eca546b385c2ece6f1c527a0&amp;market=ES&amp;locale=es-ES&amp;session_id=ecdaf5cec1274203975a3a69261b3a3f7f3ea47abfe7436a9d8de902f3a09c11</redirectionResponse>
Se debe de omitir la parte inicial de  «redirect:»  y eliminar los «amp;» presentes en la URL. Siguiendo con el mismo ejemplo, la URL a la que redirigir quedaría de la siguiente forma:
				
					https://link.tink.com/1.0/pay/?client_id=e86731ec45374c88a8c4e3b4dfe3cf36&redirect_uri=https://checkout.stg-eu-west1.epgint.com/EPGCheckout/returnurl/returnUrlTink/paysol/paybybank&payment_request_id=6d866107eca546b385c2ece6f1c527a0&market=ES&amp;locale=es-ES&;session_id=ecdaf5cec1274203975a3a69261b3a3f7f3ea47abfe7436a9d8de902f3a09c11
Cuando el cliente finaliza el pago, PayByBank devuelve el estado de la operación y Addon Payments actualiza el estado de la transacción y envia una notificación con el estado a la statusURL definida. Para conocer mayor detalle de los estados de las operaciones de PayByBank visita esta sección.
El cliente será redirigido a las URLs de OK, Cancel, Error o Awaiting, en función del estado de la operación y del posible error recibido:
  • successURL: el cliente es redirigido si el estado de transacción = SUCCESS_WARNING
  • cancelURL: el cliente es redirigido si el estado de la transacción ≠ SUCCESS_WARNING y estado en PayByBank = USER_CANCELLED
  • errorURL: el cliente es redirigido si el estado de la transacción ≠ SUCCESS_WARNING y estado en PayByBank ≠ USER_CANCELLED
  • awaitingURL: el cliente es redirigido si el estado de la transacción = REDIRECTED y no se informa error en el estado de PayByBank.

Estados de las operaciones

Una vez el enlace se ha creado correctamente y el cliente interactúa con el mismo, recibirás varias notificaciones a la statusURL que hayas indicado informando el estado de la operación en cada momento. Las notificaciones de estado que recibirás pueden ser:
  • Un status REDIRECTED indica que se ha generado la petición y se encuentra pendiente de completar el proceso de pago por parte del cliente.
  • Un status SUCCESS_WARNING indica que la operación ha sido completada por el cliente pero todavía no se ha realizado la liquidación.
  • Un status SUCCESS indica que la operación ha sido completada y se ha realizado la liquidación.
  • Un status ERROR indica que la operación ha sido cancelada por el cliente o se ha denegado la transacción.

A continuación tienes una serie de ejemplos de las notificaciones explicadas:

				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response operation-size="1">
    <message>WorkFlow has finished successfully, for transaction Id: 14176751</message>
    <operations>
        <operation sorted-order="1">
            <amount>11.35</amount>
            <currency>EUR</currency>
            <details>{"amount":11.35,"currency":"EUR","id":"056f9d43eb4f445b99c9e51cf87ccfe5","market":"ES","merchantId":"b2XXXX1b-2246-XXXX-97b9-aafXXXXX1d80","paymentScheme":"SEPA_INSTANT_CREDIT_TRANSFER","recipient":{"accountNumber":"ES3221008990940200068272","accountType":"IBAN"},"recipientName":"test","remittanceInformation":{"type":"UNSTRUCTURED","value":"test-12345"},"sourceMessage":""}</details>
            <merchantTransactionId>test1085</merchantTransactionId>
            <message>The payment request was successfully created.</message>
            <operationType>DEBIT</operationType>
            <optionalTransactionParams/>
            <paySolTransactionId>056f9d43eb4f445b99c9e51cf87ccfe5</paySolTransactionId>
            <paymentDetails>
                <account>ES32 2100 0000 0000 0000 0000</account>
                <extraDetails/>
            </paymentDetails>
            <paymentSolution>paybybank</paymentSolution>
            <redirectionResponse>redirect:https://link.tink.com/1.0/pay/?client_id=e86731ec45374c88a8c4e3b4dfe3cf36&amp;redirect_uri=https://checkout.stg-eu-west1.epgint.com/EPGCheckout/returnurl/returnUrlTink/paysol/paybybank&amp;payment_request_id=056f9d43eb4f445b99c9e51cf87ccfe5&amp;market=ES&amp;locale=es-ES&amp;session_id=0cb56d0cf69543d6b0a51b0c77f98497d7536b42ca144b06928b6a2c29551481</redirectionResponse>
            <status>REDIRECTED</status>
            <transactionId>14176751</transactionId>
            <respCode>
                <code>0000</code>
                <message>Successful</message>
                <uuid>8d49edd0_6d20_4d07_abb6_9f19b7678777</uuid>
            </respCode>
        </operation>
    </operations>
    <optionalTransactionParams/>
    <status>SUCCESS</status>
    <workFlowResponse>
        <id>74366</id>
        <name>paybybank tink</name>
        <version>0</version>
    </workFlowResponse>
</response>
				
			
				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payfrex-response operation-size="1">
    <message>WorkFlow has finished successfully, for transaction Id: 1XXXXX6</message>
    <operations>
        <operation sorted-order="1">
            <amount>20.2</amount>
            <currency>EUR</currency>
            <details>{"context":{"userId":"c6d3eXXXXXXXXXXXXX565e","externalUserId":"9e99dcXXXXXXXXX2c011015"},"content":{"id":"74ee214XXXXXXXXXXdf4c4a9804f","paymentRequestId":"74eeXXXXXXXXXXXXXXXXXXXXXdf4c4a9804f","destination":{"accountNumber":"ESXXXXXXXXXXXXXX","type":"iban"},"amount":20.2,"currency":"EUR","paymentScheme":"SEPA_INSTANT_CREDIT_TRANSFER","recipientName":"test12","sourceMessage":"","providerName":"es-demobank-password","status":"SENT","statusMessage":"The payment has been sent to your bank","created":177505XXXXXX5092,"updated":17750XXXXXXXX02,"source":{"accountNumber":"ESXXXXXXXXXXXXXXXXXXXXXXXX","type":"iban","uri":"iban://ESXXXXXXXXXXXXXXXXX","payerName":""},"metadata":{"transactionId":"1XXXXXX6"},"remittanceInformation":{"type":"UNSTRUCTURED","value":"sopork012-1XXXX"},"payerInformation":{"name":"","accountIdentifier":"ESXXXXXXXXXXXXXXXXXX"}},"event":"payment:updated"}</details>
            <merchantTransactionId>soporteApiPblPbbTink012</merchantTransactionId>
            <message>Updated transaction to SUCCESS WARNING status</message>
            <operationType>DEBIT</operationType>
            <payFrexTransactionId>1XXXXXXXX6</payFrexTransactionId>
            <paySolTransactionId>74XXXXXXXXXXXXXXXXXXXXXf</paySolTransactionId>
            <paymentSolution>paybybank</paymentSolution>
            <status>SUCCESS_WARNING</status>
        </operation>
    </operations>
    <optionalTransactionParams/>
    <status>SUCCESS</status>
</payfrex-response>
				
			
				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payfrex-response operation-size="1">
    <message>PayByBank callback response has finished successfully, for the transaction Id: 1XXXXXXX6</message>
    <operations>
        <operation sorted-order="1">
            <amount>20.2</amount>
            <currency>EUR</currency>
            <details>{"start_microtime":1.XXXXXXXX9,"payin":{"type":"EPG_TINK","status":"CONFIRMED","provider":{"operations.operation.merchantTransactionId":"sop12","operations.operation.payFrexTransactionId":"1XXXXXXXXXX6"}},"escrow":{"id":"123","status":"RELEASED"}}</details>
            <merchantTransactionId>sop012</merchantTransactionId>
            <message>TINK - Settlement completed successfully</message>
            <operationType>DEBIT</operationType>
            <payFrexTransactionId>1XXXXXX6</payFrexTransactionId>
            <paymentSolution>paybybank</paymentSolution>
            <status>SUCCESS</status>
        </operation>
    </operations>
    <optionalTransactionParams/>
    <status>SUCCESS</status>
    <workFlowResponse>
        <id>970784</id>
        <name>paybybank tink</name>
        <version>0</version>
    </workFlowResponse>
</payfrex-response>
				
			
				
					<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response operation-size="1">
    <message>WorkFlow has finished successfully, for transaction Id: 609232</message>
    <operations>
        <operation sorted-order="1">
            <amount>300.0</amount>
            <currency>EUR</currency>
            <details>{"context":{"userId":"d5cXXXXXXXXXXcc","externalUserId":"8a605cXXXXXXXXXXbba4"},"content":{"id":"28785e46b9484d98abcdaee210a9a2a5",
              "paymentRequestId":"28785e46b9484d98abcdaee210a9a2a5","destination":{"accountNumber":"ES3221000000000000000000","type":"iban"},"amount":300.0,"currency":"EUR",
              "paymentScheme":"SEPA_INSTANT_CREDIT_TRANSFER","recipientName":"Testing EPG","sourceMessage":"","providerName":"es-demobank-open-banking-redirect","status":"CANCELLED",
              "statusMessage":"Authorisation of payment was cancelled. Please try again.","created":1772793711916,"updated":1772793844253,"source":{"accountNumber":"ES4320339641318952396609",
              "type":"iban","uri":"iban://ES322000000000000000000","payerName":""},"metadata":{"transactionId":"609232"},"remittanceInformation":{"type":"UNSTRUCTURED","value":"test-1111"},
              "payerInformation":{"name":"","accountIdentifier":" ES322000000000000000000  "}},"event":"payment:updated"}</details>
            <merchantTransactionId>tink7</merchantTransactionId>
            <message>Updated transaction to ERROR status</message>
            <operationType>DEBIT</operationType>
            <paySolTransactionId>28785e46b9484d98abcdaee210a9a2a5</paySolTransactionId>
            <paymentDetails>
                <extraDetails/>
            </paymentDetails>
            <paymentSolution>paybybank</paymentSolution>
            <status>ERROR</status>
            <transactionId>609232</transactionId>
            <respCode>
                <code>1676</code>
                <message>Payment solution error, please check payment solution respond</message>
                <uuid>765f0b7e_486d_49c1_b41a_e5f3a49a3228</uuid>
            </respCode>
        </operation>
    </operations>
    <optionalTransactionParams/>
    <status>SUCCESS</status>
</response>
Comparte este documento
Tabla de Contenidos

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

Comienza a integrar

undraw_add_to_cart_re_wrdo 1 (1) (1)

Plugins para CMS

Complementa la integración

SDKs

Métodos de pago

Herramientas

Addon Payments

Consulta la documentación de Addon Payments. Aquí tienes las distintas secciones:

Integraciones

Consultas frecuentes

Portal Backoffice

Cyberpac

Consulta la documentación de Cyberpac. Aquí tienes las distintas secciones:

Canales

Módulos de integración

Integraciones a medida

Pagos integrados en TPV

Crea una solución que te ayudará a automatizar procesos. Incluso, podrás agregar procesos de pago en terminales físicos.

Pago integrado con TPV Android

Pago integrado con Smartphone TPV

Fichas Técnicas TPVs