API
La estandarización de la conexión con cualquier banco en tiempo real.
Este documento está obsoleto. Para acceder a la última versión de la documentación por favor contacte con el soporte técnico.
Summary
Tag: forms
| Operation | Description |
|---|---|
| GET /forms |
Lista de bancos soportados |
Tag: serviceV3
| Operation | Description |
|---|---|
| POST /serviceV3 |
Posición global y movimientos hasta una fecha dada. |
Tag: User
| Operation | Description |
|---|---|
| POST /me |
Información de uso de mi licencia |
Paths
Obtén una lista completa de los bancos soportados, así como los nombres de los campos necesarios para dibujar un formulario de login similar al oritinal del banco.
| country_code |
Código del país, formato ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Por ejemplo ES para España. Si no se proporciona ningún código, se devolverá la lista completa. |
query | string |
Uses default content-types: application/json
| 200 |
Array con el listado de bancos soportados y la información necesaria para dibujar su formulario de login |
| default |
Unexpected error |
Devuelve información sobre mi licencia y uso de llamadas
| servicekey |
Licencia que identifica al cliente. Si no tienes una, puedes solicitarla en https://www.afterbanks.com |
query | string |
Uses default content-types: application/json
| 200 |
Profile information for a user |
| default |
Unexpected error |
Este endpoint devuelve el listado de productos y los movimientos para cada uno de los productos desde la fecha solicidata hasta el día actual. Existe un sandbox donde probar llamadas: https://www.afterbanks.com/sandbox/
| servicekey |
Licencia que identifica al cliente. Si no tienes una, puedes solicitarla en https://www.afterbanks.com |
query | string |
| service |
Identificador único para cada banco. El listado de bancos soportados se obtiene de https://www.afterbanks.com/forms/ |
query | string |
| documentType |
Algunos bancos, en su formulario de login, solicitan el tipo de documento. En estos casos, se deberá identificar un número entero (de 0 a 4), que corresponde con su posición en el formulario de login del banco. |
query | number (int32) |
| user |
Usuario |
query | string |
| pass |
Contraseña |
query | string |
| pass2 |
Algunos bancos utilizan una segunda contraseña. |
query | string |
| products |
Nombres de productos bancarios (cuentas corrientes, tarjetas, etc), separados por coma. Cabe destacar que en la primera llamada a la API, aún no conocemos los nombres de los productos que el usuario tiene contratados, por lo que este parámetro estará vacío. |
query | string |
| startdate |
Fecha desde la que queremos obtener los movimientos en formato dd-mm-aaaa. Obligatorio cuando el valor de "products" es distinto de GLOBAL. |
query | string |
| account_id |
Es un valor de -1 a n. Algunos bancos permiten acceder a diferentes contratos (multicontrato), con distintos productos, utilizando las mismas credenciales. En los casos en los que esto suceda, y el valor de este parámetro sea null o 0, la respuesta de la API nofificará de que las credenciales introducidas permiten acceder a más de un contrato. Si el valor es -1, mostrará todos los productos de todos los contratos, haciendo transparente para el cliente la existencia de multicontrato. |
query | number (int32) |
Uses default content-types: application/json
| 200 |
Array con listado de productos bancarios y movimientos. |
| default |
Unexpected error |
Schema definitions
- country_code: string
-
Código del país, formato ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
- service: string
-
Identificador único del banco en la API.
- swift: string
-
Código SWIFT, formato ISO 9362 (https://en.wikipedia.org/wiki/ISO_9362).
- fullname: string
-
Nombre completo del banco.
- business: boolean
-
Valor booleano. Hay bancos que tienen accesos diferentes para particulares y para empresas. Si el valor es 1, indica que es acceso de empresas
- documentType: string
-
Lista de valores posibles para el campo de "tipo de documento", separado por el caracter "|" (por ejemplo: NIF|Pasaporte|Tarjeta de residencia). En el caso de que el banco no requiera de esta información en su formulario de login, el valor es 0
- user: string
-
Texto que acompaña al input box de usuario
- pass: string
-
Texto que acompaña al input box de password
- pass2: string
-
Texto que acompaña al input box del segundo password. En el caso de que el banco no requiera de esta información en su formulario de login, el valor es 0
- userdesc: string
-
Texto de ayuda para rellenar el inputbox de usuario, en caso de que el formulario original del banco tenga algún texto de ayuda.
- passdesc: string
-
Texto de ayuda para rellenar el inputbox de password, en caso de que el formulario original del banco tenga algún texto de ayuda.
- pass2desc: string
-
Texto de ayuda para rellenar el inputbox de segundo password, en caso de que el formulario original del banco tenga algún texto de ayuda.
- usertype: string
-
Texto que acompaña al input box de usuario
- passtype: string
-
Texto que acompaña al input box de password
- pass2type: string
-
Texto que acompaña al input box del segundo password. En el caso de que el banco no requiera de esta información en su formulario de login, el valor es 0
- image: string
-
URL del icono del banco en formato PNG transparente y resolución 128x128.
- product: string
-
Identificador único para un producto. Por ejemplo, número de cuenta bancaria o numeración de tarjeta de crédito.
- type: string
-
Tipo de producto. Los valores más habituales son "checking" para cuenta corriente, "card" para tarjeta de crédito, "debit" para tarjeta de débito y "loan" para préstamos. Los valores posibles son: card, checking, debit, insurance, investment, lineofcredit, loan, other, pensionplan, saving, securities, stocks
- balance: number (float)
-
Saldo disponible del producto. Siempre existirá este saldo, el resto de valores balance podrán existir o no.
- countable_balance: number (float)
-
Saldo contable
- balance_value: number (float)
-
Saldo valor
- arranged_balance: number (float)
-
Saldo dispuesto
- balance_credit_granted: number (float)
-
Saldo concedido
- currency: string
-
Código de la divisa en formato ISO 4217.
- description: string
-
Nombre del producto. En ocasiones es un alias que ha asignado el usuario, o puede coincidir con el valor de product.
- transactions: object[]
- date: string (date)
-
Fecha del movimiento en formato dd-mm-yyyy
- date2: string (date)
-
Fecha de valor en formato dd-mm-yyyy
- amount: number (float)
-
Importe de la transacción
- balance: number (float)
-
Saldo del producto en el instante posterior a la transacción
- description: string
-
Descricipción de la transacción
- categoryId: number (int32)
-
Id de categoría. Solo para las servicekeys con la opción contratada. Listado de categorías: https://www.afterbanks.com/serviceV3/categories/?country_code=ES
- transactionId: string
-
Identificador único de la transacción, dentro de ese producto, de 32 caracteres
- remaining_calls: integer (int32)
-
Llamadas restantes para tu ciclo de facturación actual.
- date_renewal: string (date)
-
Fecha de renovación del contador de llamadas, en formato dd-mm-yyyy
- message: string
-
- code: integer (int32)
-
Posibles valores: description: 1, Genérico; 2, La web del banco esta fuera de servicio; 3, Algún dato de conexión no es válido; 4, La cuenta solicitada no existe; 5, Conexion cortada, reintente la solicitud; 6, El usuario debe acceder a la web del banco a realizar una acción; 50, Parametro incorrecto en la llamada a la API