API docs by Redocly

Wealth Reader (8.1.3)

Download OpenAPI specification:

E-mail: [email protected]

Les APIs reguladores basades en PSD2 proporcionen accés a certa informació financera com saldos de comptes bancaris i transaccions. No obstant això, hi ha altres fonts d'informació patrimonial que no són accessibles per aquestes APIs. L'API de Wealth Reader amplia la informació oferta per les APIs reguladores proporcionant accés en temps real a les fonts patrimonials addicionals en qualsevol entitat del món. Hi ha dos altres documents relacionats que t'ajudaran a integrar l'API de Wealth Reader. Un és la guia d'integració del widget Javascript: https://docs-es.wealthreader.com/ i l'altre és una col·lecció Postman basada en aquesta documentació. Molt important: Aquesta definició de l'API està adaptada per als clients que integren per Widget, per la qual cosa s'han omès alguns paràmetres que no són necessaris per a aquest tipus d'integració, com poden ser els d'autenticació amb el banc, ja que s'utilitzarà un token.

Core

API principal requerida per a integracions estàndard

Obté els actius financers i el detall de la seva composició

Obté els actius financers i el detall de la seva composició de carteres d'inversió compostes per accions o fons, targetes de crèdit, assegurances i préstecs. Inclou informació de titularitat de cadascun dels actius així com identificadors únics que faciliten el tractament de la dada. És possible obtenir dades Mock. Consulteu amb l'equip tècnic com fer-ho.

Request Body schema: application/x-www-form-urlencoded
api_key
string

Identifica el client en el servei

code
string

Nom de l'entitat. El llistat complet està disponible amb GET

token
string

Identifica la credencial custodiada. El flux mitjançant el qual s'ha obtingut el token es descriu al document 'Guia d'integració del Widget'. Els següents usuaris Mock estan disponibles: MOCKDATA, resposta OK; MOCKOTP, resposta amb desafiament OTP; MOCKLOGINKO, resposta amb error de login

product_types
string
Enum: "accounts" "portfolios" "cards" "receipts" "loans" "factoring" "confirming" "properties" "invoices" "files"

Llista de tipus de producte dels quals es vol obtenir informació. Accepta múltiples valors separats per comes.

only_balances
boolean
Default: false

Indica si es desitgen obtenir només els saldos dels productes en lloc de tota la informació disponible. Valor per defecte: false.

date_from
string <date>

Data a partir de la qual es sol·liciten les transaccions, en format AAAA-MM-DD. Ha de ser una data anterior a avui.

date_to
string <date>

Això només s'aplica per restringir per dates futures per als productes loan i confirming, en format AAAA-MM-DD. La data ha de ser posterior a avui

required_products_schema
string

Esquema de productes requerits. Indica els comptes o targetes dels quals es desitgen obtenir dades, amb configuracions addicionals.

add_pdf_from_uuids
string

Accepta uuids de transaccions separats per comes. Paràmetre que només es té en compte si product_types és ALL o inclou accounts. Afegeix el document PDF associat a cadascuna de les transaccions bancàries sol·licitades.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&code=caixabank&token=MOCKDATA&product_types=accounts%2Cportfolios&date_from=2024-01-01

Response samples

Content type
application/json
[
  • {
    }
]

Llista de tipus de transacció

query Parameters
lang
string
Default: "es"
Enum: "es" "en"

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Consulta els tokens associats a una api_key

Utilitza aquest mètode per consultar tots els tokens vinculats a una api_key específica. Els resultats es retornen en blocs de 500 tokens per pàgina.

Request Body schema: application/x-www-form-urlencoded
required
api_key
string

api_key per identificar el client en el servei

page
number

Especifica el número de pàgina que vols recuperar. Cada pàgina conté fins a 500 tokens. Si no es proporciona, el valor per defecte és 1.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&page=1

Response samples

Content type
application/json
[
  • {
    }
]

Revocar un token

Aquest mètode permet revocar un token existent per desautoritzar futures sol·licituds d'accés a l'API.

Request Body schema: application/x-www-form-urlencoded
required
api_key
string

Identifica el client en el servei

token
string

Token a revocar.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Token successfully revoked."
}

Reassignar un token a una api_key diferent

Aquest mètode permet reassignar un token d'una api_key a una altra.

Request Body schema: application/x-www-form-urlencoded
required
api_key_source
string

api_key des de la qual reassignar el token.

api_key_target
string

api_key a la qual reassignar el token.

token
string

Token a reassignar.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key_source=12345678&api_key_target=87654321&token=FRJ0mHlaqZwLzu

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Token successfully reassigned."
}

Afegir un nou domini

Afegeix l'associació entre el domini que hostatjarà el widget i el webhook de destinació. Per seguretat, les operacions d'editar i esborrar només són possibles sol·licitant-ho al suport

Request Body schema: application/x-www-form-urlencoded
required
method
required
string

Method to execute.

api_key
required
string

User's API key.

domain
required
string

Domain to add.

url_callback
required
string

URL for callback.

tokenize
required
string

Indicates whether to tokenize or not.

Responses

Request samples

Content type
application/x-www-form-urlencoded
method=add&api_key=12345678&domain=https%3A%2F%2Fwww.cliente.com&url_callback=https%3A%2F%2Fwww.cliente.com%2Fwebhooks%2Fwealthreader&tokenize=1

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Llista de codis d'error

Llista de codis d'error. Presta especial atenció al fet que no tots els codis d'error han de rebre el mateix tractament per part de la teva aplicació. Davant d'un error de contrasenya incorrecta no has de reintentar la crida amb els mateixos paràmetres, però davant d'un error que t'indiqui que l'entitat està en manteniment sí que pots reintentar-ho. Demana una sessió tècnica amb el nostre equip per resoldre qualsevol dubte sobre la gestió d'errors.

query Parameters
lang
string
Default: "es"
Enum: "es" "en"

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Llista de codis d'advertència

Llista de codis d'advertència.

query Parameters
lang
string
Default: "es"
Enum: "es" "en"

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Punts finals opcionals no requerits per a integracions estàndard. Utilitzar només si Wealth Reader ho indica explícitament.

Obté el llistat d'entitats suportades

Obté el llistat d'entitats suportades i la informació necessària per dibuixar el formulari de login de l'entitat.

query Parameters
show_only_tested
integer
Default: 0
Enum: 0 1

Indicates whether to show only tested entities. Default value is 0. In production environments, always use 1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Verificar la titularitat d'un compte bancari mitjançant IBAN

Aquest endpoint és opcional i no és necessari per a integracions estàndard. Utilitzar només si Wealth Reader ho indica explícitament. Permet verificar si una persona física o jurídica és titular d'un compte bancari específic mitjançant l'IBAN i les dades identificatives del suposat titular.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Identifies the client in the service

iban
required
string

IBAN code of the bank account to verify (without spaces)

document_type
required
string
Enum: "NIF" "NIE" "Pasaporte" "CIF"

Type of identification document

document_number
required
string

Identification document number

holder_name
required
string

Full name of the natural person or company name

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&iban=ES4914651234561234567890&document_type=NIF&document_number=12345678Z&holder_name=LUIS%20GARCIA%20BAQUERO

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    },
  • "statistics": {
    }
}

Registrar un nou usuari

Aquest endpoint és opcional i no és necessari per a integracions estàndard. Utilitzar només si Wealth Reader ho indica explícitament. Aquest endpoint permet registrar un usuari ja sigui a la plataforma de traspàs de carteres Easytransfer o a l'eina de reporting Acumulas, a partir d'un identificador únic.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Authentication key (8 alphanumeric characters)

user_id
required
string

User identification document.

service
required
string
Enum: "integra" "easy-transfer"

Service associated with the user. Determines the data flow.

email
required
string <email>

User email, used according to service type.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "User registered successfully"
}

Consultar l'estat de registre d'un usuari

Aquest endpoint és opcional i no és necessari per a integracions estàndard. Utilitzar només si Wealth Reader ho indica explícitament. Consulta si un usuari està registrat al sistema Easytransfer o Acumulas i retorna l'enllaç d'accés únic per a l'usuari.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Authentication key

user_id
required
string

User identification document.

Responses

Response samples

Content type
application/json
{}

Donar de baixa un usuari prèviament registrat

Aquest endpoint és opcional i no és necessari per a integracions estàndard. Utilitzar només si Wealth Reader ho indica explícitament. Aquest endpoint permet donar de baixa un usuari del servei de la plataforma Easytransfer o Acumulas.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Authentication key (8 alphanumeric characters)

user_id
required
string

User identification document.

service
required
string
Enum: "integra" "easy-transfer" "all"

Service from which to unregister the user. 'all' for all services.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "User unregistered successfully"
}

Càrrega de connexions en batch

Aquest endpoint és opcional i no és necessari per a integracions estàndard. Utilitzar només si Wealth Reader ho indica explícitament. Important: Per utilitzar la gestió de processos batch del costat de Wealthreader és necessari comptar amb un entorn dedicat. Aquest endpoint no està disponible a api.wealthreader.com. Els endpoints agrupats sota l'etiqueta "batch" permeten processar múltiples connexions bancàries de forma asíncrona, a diferència del mètode /entities/ que és síncron. Ideal per processar grans volums de connexions i evitar timeouts.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

notification_url
required
string <uri>

URL where notification will be sent when batch processing finishes

required
Array of objects (batch-connection) non-empty

List of connections to process

Responses

Request samples

Content type
application/json
{
  • "api_key": "12345678",
  • "notification_url": "https://example.com/webhook/batch-complete",
  • "connections": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "batch_id": "batch_20250120_a1b2c3d4",
  • "total_connections": 5,
  • "estimated_completion_time": "2025-01-20T10:45:00Z"
}

Obtenir estadístiques generals sobre les connexions del batch

Aquest endpoint és opcional. Recupera estadístiques generals sobre el resultat del processament de totes les connexions d'un batch.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

batch_id
required
string

Batch ID

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "batch_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "batch_id": "batch_20250120_a1b2c3d4",
  • "status": "completed",
  • "statistics": {
    }
}

Obtenir el resultat individual d'una connexió específica dins d'un batch

Aquest endpoint és opcional. Recupera el resultat d'una connexió específica del batch.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

batch_id
required
string

Batch ID

credential_id
required
string

Filter by specific credential_id

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "batch_id": "string",
  • "credential_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    },
  • "statistics": {
    }
}