<!DOCTYPE html>
<html lang="es">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Arcopay Widget</title>
</head>
<body>
<h1>Arcopay Widget</h1>
<h2 id='frameResponse'></h2>
<div id='arcopayContainer'></div>
</body>
<script>
let parameters = {
// ID de cliente
"id": "Test-0001",
// Acción del widget
"action": "read",
// Configuración del widget
"countryCode": "ALL",
"banksShownPSD2": "N26,bankinter,sandbox",
"banksShownV3": "bbva,caixa,bankia,bankia_emp,ingdirect",
"defaultBank": "",
"autoStart": 0,
"defaultLanguage": "ES",
"showSandbox": 0,
"showSplashScreen": 0,
"showCheckTerms": 0,
"URLredirectAfterOK": "",
"URLredirectAfterKO": "",
// Parámetros READ PSD2
"dailyFrequency": 4,
"validUntil": "31-12-2021"
};
</script>
<script>
function receiveFromFrame(ev) {
if (ev.data != ''&& ev.data.code != undefined && ev.data.message != undefined) {
let codigo = ev.data.code;
let mensaje = ev.data.message;
let widgetContainer = document.getElementById('arcopayContainer');
console.warn(`${codigo} - ${mensaje}`);
switch (codigo) {
case 200:
if (parameters.action == 'read') {
document.getElementById('frameResponse').innerHTML = 'Lectura finalizada correctamente.';
}
break;
case 9999: // Cambio en el tamaño del widget
widgetContainer.style.height = mensaje + 'px';
window.scrollTo(0, 0);
document.getElementById('iframeArcopay').contentWindow.postMessage({"action": "changeIframeHeight"}, 'https://www.afterbanks.com/');
break;
default:
document.getElementById('frameResponse').innerHTML = `${codigo} - ${mensaje}`;
break;
}
}
}
window.addEventListener("message", receiveFromFrame, false);
</script>
<script src="https://static.afterbanks.com/appmain/PSD2ExternalForm/js/external_mixed.js"></script>
</html>
| Parámetro | Descripción |
|---|---|
| Parámetro | Descripción |
| id | Obligatorio. Identificador único de la operación generado por el cliente con el que se identificará la información recibida en el callback. En el caso de una operación de pago, este identificador aparecerá en el concepto del pago, por lo que es aconsejable que coincida con un identificador de pedido, o código de factura. Solo se permiten caracteres alfanuméricos y guión. |
| action | Obligatorio. Valores posibles: “read”, “payment”, “broker”, “ownership”, “insurance” o “utilities”. |
| countryCode | Códigos de país separados por coma en ISO 3166-1, por ejemplo ES para España, o ALL para todos los disponibles. Filtra el listado de bancos que se muestra al usuario. Si no se especifica valor, tomará por defecto el del país del usuario. |
| banksShownPSD2 | Obligatorio cuando el valor de "action" es "read" o "payment". Códigos de bancos separados por coma. El listado completo está disponible en el método https://apipsd2.afterbanks.com/listOfSupportedBanks/, en la key "service". Filtra el listado de bancos que se muestra al usuario. |
| banksShownV3 | Obligatorio cuando el valor de "action" es "read", "payment", "broker" o "titularidad". Códigos de bancos separados por coma. El listado completo está disponible en los métodos https://api.afterbanks.com/V3/forms/ y https://api.afterbanks.com/Broker/forms/ , en la key "service". Dependiendo del país, encontrarás bancos en este listado que también están disponibles en el listado del parámetro anterior. En ese caso, puedes elegir cualquiera de ellos. Filtra el listado de bancos que se muestra al usuario. |
| servicesShown | Obligatorio cuando el valor de "action" es "insurance" o "utilities". Códigos de servicios separados por coma. Los servicios soportados están disponible en los métodos https://api.afterbanks.com/Insurance/forms/ y https://api.afterbanks.com/Utilities/forms/, en la key "service". Filtra el listado de servicios que se muestra al usuario. Si no se especifica valor, tomará por defecto el valor "ALL", mostrando todos los disponibles en el "countryCode" seleccionado. |
| defaultService | En caso de tener valor, muestra al usuario un banco o servicio seleccionado, en lugar del selector de servicios. Ahorra un click cuando es conocido qué servicio tiene intención de agregar el usuario. |
| autoStart | En caso de haber recibido un servicio válido en el parámetro defaultBank o haber detectado el banco automáticamente en función del IBAN de origen indicado en el parámetro sourceIBAN, el flujo de consentimiento se iniciará sin pedir al usuario que seleccione el banco. Los valores posibles son 0 ó 1. El valor por defecto es 0, desactivado. |
| defaultLanguage | En caso de tener valor, carga el widget en el idioma indicado. Formato ISO 3166-1. Actualmente ES y EN disponibles. |
| showSandbox | Muestra al usuario bancos con nombre Sandbox que permiten al cliente hacer pruebas con un servicio mock. Los valores posibles son 0 ó 1. El valor por defecto es 0, desactivado. |
| showSplashScreen | Muestra una una pantalla inicial explicando al usuario en qué consiste el servicio. Los valores posibles son 0 ó 1. El valor por defecto es 0, desactivado. |
| showCheckTerms | Muestra una casilla de verificación de aceptación de términos junto al enlace de términos y condiciones. Los valores posibles son 0 ó 1. El valor por defecto es 1, activado. |
| URLredirectAfterOK | Si el flujo termina correctamente, URL a la que redirigir al usuario. Se tomará en cuenta si el callback del cliente no devuelve una url donde quiere ser redirigido en la key nextURL. Observa que este parámetro es opcional ya que hay otras opciones para controlar cómo continúa el flujo, detalladas en esta guía, como la notificación a la página padre mediante un evento javascript, o que sea la respuesta proporcionada por la URL de callback la que indique la URL de redirect. |
| URLredirectAfterKO | Si el flujo no termina correctamente, URL a la que redirigir al usuario. Se tomará en cuenta si el callback del cliente no devuelve una url donde quiere ser redirigido en la key nextURL. Observa que este parámetro es opcional. |
| dailyFrequency | Tomado en consideración cuando el valor de action es read. Número máximo de veces que se podrá acceder al día con el token obtenido en modo lectura. Los valores posibles son del 1 al 4. El valor por defecto es 4. |
| validUntil | Tomado en consideración cuando el valor de action es read. Fecha hasta la que serán válidos los tokens de consentimiento de acceso, en formato dd-mm-yyyy. El valor máximo es 89 días desde la fecha actual. El valor por defecto es el día actual. |
| paymentType | Obligatorio si el valor de action es payment. Los valores posibles son: normal, instant, normalPeriodic o instantPeriodic. El valor por defecto es normal. Desaconsejamos indicar pago instantáneo, ya que la probabilidad de que el banco del cliente le cargue una comisión es muy alta, y las APIs regulatorias no informan sobre la comisión a los TPP, por lo que no es un factor controlable por el widget. |
| amount | Obligatorio si el valor de action es payment. Importe del pago en formato float. Por ejemplo, mil euros con 55 céntimos = 1000.55 |
| currency | Tomado en consideración cuando el valor del parámetro action es payment. Código de la divisa en formato ISO 4217. El valor por defecto es EUR. |
| sourceIBAN | Tomado en consideración cuando el valor del parámetro action es payment. IBAN del origen de los fondos. En caso de no especificarse el valor, se mostrará un selector de cuentas al usuario final. En caso de no tener fondos suficientes para el pago en el IBAN indicado también se mostrará el selector de cuentas. |
| sourceCreditorName | Tomado en consideración cuando el valor de action es payment. Nombre de la persona que realiza el pago. Este valor es utilizado para realizar el control de Blanqueo de Capitales (PBC). Si se especifica su valor el widget será capaz de iniciar pagos directos, de otro modo el widget siempre deberá realizar el pago en dos pasos, para en el primero obtener el nombre del titular de la cuenta origen. |
| destinationIBAN | Tomado en consideración cuando el valor del parámetro action es payment. IBAN de destino. En caso de no especificarse valor, se tomará el IBAN que Arcopay tenga configurado en su backend. Si necesitas conocer o modificar el valor de destinationIBAN en backend, escribe un ticket a soporte. |
| destinationCreditorName | Obligatorio si el parámetro destinationIBAN no es vacío. Nombre del titular de la cuenta. En caso de no especificarse valor, se tomará el IBAN en el que se va a recibir el pago. |
| paymentDescription | Tomado en consideración cuando el valor de action es payment. Concepto del pago. La longitud máxima es de 140 caracteres. En caso de no especificarse el valor, este parámetro tomará el valor de id. |
| firstQuotaDay | Obligatorio si el valor del parámetro action es payment y el valor del parámetro paymentType es Periodic. Si el cobro es periódico. Día del primer cargo de la cuota, en formato dd-mm-yyyy. |
| frequency | Obligatorio si el valor del parámetro action es payment y el valor del parámetro paymentType es Periodic. Si el cobro es periódico. Los valores posibles son daily, weekly, everyTwoWeeks, monthly, everyTwoMonths, quarterly, annual. |
| payments | Parámetro utilizado para iniciar pagos Bulk.
Tipo de dato aceptado: array de objetos. Si el valor del parámetro action es "payment" y no se recibe un paymentType o amount, existe la posibilidad de realizar un pago Bulk pasando un array de pagos en este parámetro. Dentro de éste array habrán varios objetos de pago con la siguiente información sobre cada uno de ellos: amount, destinationIBAN, destinationCreditorName y paymentDescription. |
| numberOfQuotas | Obligatorio si el valor del parámetro action es payment y el valor del parámetro paymentType es Periodic. Si el cobro es periódico. Valor entero que indica el número de pagos que se harán. Por ejemplo, si la orden corresponde a la devolución de un préstamo en 60 cuotas. El valor será 60. |
| payFromIframe | Parámetro utilizado para ejecutar el proceso del pago sin salir del iframe de Afterbanks Arcopay si se especifica el valor: 1 Operativo con los siguientes servicios: |
| traceUserEvents | El widget remitirá a la función gestora de eventos registrada y vinculado al elemento contenedor del elemento IFRAME del widget los eventos correspondientes a la familia de eventos 90XX relativos a las distintas interacciones que realiza el usuario sobre los elementos interactivos del componente, p.e. el usuario ha seleccionado una entidad para acceder a través de la API V3 (9003) o el usuario ha cambiado el idioma del widget (9022). |
| startDate | Fecha desde la que queremos obtener los movimientos en formato dd-mm-aaaa. |
| manualExternalLinks | Parámetro utilizado para reemplazar el comportamiento del iframe de Afterbanks Arcopay si se especifica el valor: 1, cuando es necesario abrir enlaces externos (9100). |