Wealth Reader (8.1.3)

Download OpenAPI specification:

PSD2-pohjaiset sääntely-API:t tarjoavat pääsyn tiettyihin taloudellisiin tietoihin, kuten pankkitilisaldoihin ja tapahtumiin. On kuitenkin olemassa muita varallisuustietojen lähteitä, jotka eivät ole saatavilla näiden API:iden kautta. Wealth Reader API laajentaa sääntely-API:iden tarjoamia tietoja tarjoamalla reaaliaikaisen pääsyn lisävarallisuuslähteisiin missä tahansa maailmanlaajuisessa yksikössä. On olemassa kaksi muuta liittyvää asiakirjaa, jotka auttavat sinua integroimaan Wealth Reader API:n. Toinen on Javascript-widgetin integraatio-opas: https://docs-en.wealthreader.com/ ja toinen on Postman-kokoelma, joka perustuu tähän dokumentaatioon. Erittäin tärkeää: Tämä API-määrittely on mukautettu asiakkaille, jotka integroivat Widgetin kautta, joten jotkin parametrit, joita ei tarvita tällaisessa integraatiossa, on jätetty pois, kuten pankkitunnistautumisen parametrit, koska tokenia käytetään.

Core

Ydin-API vaaditaan vakiointegraatioihin

Hakee taloudelliset varat ja niiden koostumustiedot

Hakee taloudelliset varat ja niiden koostumustiedot mukaan lukien sijoitussalkut koostuen osakkeista tai rahastoista, luottokortit, vakuutukset ja lainat. Sisältää omistustiedot jokaiselle varalle sekä yksilölliset tunnisteet, jotka helpottavat tietojen käsittelyä. On mahdollista saada Mock-tietoja. Tarkista tekniseltä tiimiltä miten tämä tehdään.

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

api_key	string Tunnistaa asiakkaan palvelussa
code	string Yksikön nimi. Täydellinen luettelo on saatavilla GET-pyynnöllä
token	string Tunnistaa säilytetyt tunnistetiedot. Kulku, jolla token on saatu, on kuvattu dokumentissa 'Widgetin integraatio-opas'. Seuraavat Mock-käyttäjät ovat saatavilla: MOCKDATA, OK-vastaus; MOCKOTP, vastaus OTP-haasteella; MOCKLOGINKO, vastaus kirjautumisvirheellä
product_types	string Enum: "accounts" "portfolios" "cards" "receipts" "loans" "factoring" "confirming" "properties" "invoices" "files" Luettelo tuotetyypeistä, joista tiedot haetaan. Hyväksyy useita pilkuilla erotettuja arvoja.
only_balances	boolean Default: false Ilmoittaa, haetaanko vain tuotteiden saldot kaiken saatavilla olevan tiedon sijaan. Oletusarvo: false.
date_from	string <date> Päivämäärä, josta lähtien tapahtumia pyydetään, muodossa VVVV-KK-PP. Täytyy olla päivämäärä ennen tätä päivää.
date_to	string <date> Tämä koskee vain tulevien päivämäärien rajoittamista tuotteille loan ja confirming, muodossa VVVV-KK-PP. Päivämäärän on oltava tämän päivän jälkeen
required_products_schema	string Vaadittu tuoteskeema. Ilmoittaa tilit tai kortit, joista tietoja halutaan, lisäkonfiguraatioiden kanssa.
add_pdf_from_uuids	string Hyväksyy tapahtuma-uuid:t pilkuilla erotettuna. Parametri, joka otetaan huomioon vain jos product_types on ALL tai sisältää accounts. Lisää kunkin pyydetyn pankkitapahtuman liittyvän PDF-dokumentin.

Responses

Request samples

Payload

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

[{"success": true,
"payload": {"user_information": {"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"gender": "male",
"birth_date": "1980-09-26",
"birth_place": "Ibiza",
"email": "[email protected]",
"cell_phone": "+34666123456",
"address": "CALLE BAILEN 41 1A",
"city": "MADRID",
"country": "SPAIN",
"postal_code": "28005",
"marital_status": "married",
"job": "CUENTA PROPIA"
},
"portfolios": [{"subtype": "funds",
"uuid": "05e4563f5bbf2d06efd0a29ebe7edbbb4e1bff63",
"code": "1465010091400123456789",
"name": "Fondo Dinámico",
"currency": "EUR",
"total_value": 3275.6,
"weighted_return": 8.49,
"annualized_volatility": 0,
"yield": 256.27,
"contributions": 3019.33,
"withholdings": 0,
"contracting_date": "2016-04-27",
"linked_account": "ES4021005321592566566159",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"composition": {"currency": "EUR",
"weighting": 100,
"shares": 225.0077,
"price": 14.5577,
"total_amount": 3275.6
},
"transactions": [{"uuid": "05e4563f5bbf2d06efd0a29ebe7edbbb4e1bff63",
"operation_pending": false,
"operation_date": "2020-01-30",
"value_date": "2020-01-30",
"operation_type": "purchase",
"shares": 1076.8273,
"price": 11.1438,
"total_amount": 12000,
"reference_currency": "EUR",
"currency": "EUR",
"exchange_rate": 1
}
]
}
],
"bonds": [{"uuid": "b8e42d60e6e8d3a5efb0b2a8e4e0b1a4b5c5d6e7",
"name": "Bono del Estado Español 2025",
"isin": "ES00000123E5",
"currency": "EUR",
"total_value": 5000,
"interest_rate": 1.75,
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"maturity_date": "2025-10-15",
"issuer": "Gobierno de España",
"principal": 1000,
"coupon_payment_dates": ["2023-04-15",
"2023-10-15"
],
"credit_rating": "AAA",
"yield_to_maturity": 2.5,
"current_yield": 2,
"callability": "Callable a partir del 2024-01-01",
"type_of_bond": "government"
}
],
"accounts": [{"uuid": "8076932f04f73e27fe608fee4d12fca8708dec8c",
"subtype": "checking",
"interest_rate": 0.5,
"line_of_credit_details": {"credit_limit": 50000,
"interest_rate": 4.5,
"credit_used": 15000,
"credit_available": 35000,
"constitution_date": "2021-05-20",
"expiration_date": "2031-05-20"
},
"code": "ES4914651234561234567890",
"name": "Cuenta NÓMINA",
"currency": "EUR",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"balances": {"available": 14302.07,
"current": 14302.07
},
"additional_info": [{"key": "string",
"value": "string"
}
],
"transactions": [{"uuid": "d0c2ea4c072cf4d7b0fd494d7728260d736e6b25",
"operation_date": "2022-12-30",
"value_date": "2022-12-30",
"amount": -1.1,
"balance": 14302.07,
"description": "Pago en TELPARK MADRID ES",
"pdf_file": "string",
"pdf_file_final": true,
"categorization": {"type": 1,
"portfolio-uuid": "1465010091400123456789",
"ISIN": "US88160R1014"
},
"transfer_details": {"concept": "Pago de factura 12345",
"sender_receiver": "Juan Pérez",
"account_number": "ESXX12341234121234567890"
},
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"cards": [{"status": "active",
"subtype": "credit",
"uuid": "aefd89eade0a6a09d9b8eab4c22da6a6a37632e6",
"code": "516097********1234",
"name": "Credit Card",
"currency": "EUR",
"next_payment_date": "2023-01-05",
"anual_interest": 17.48,
"tae": 18.95,
"balances": {"available": 3980,
"limit": 4000,
"disposed": 20
},
"linked_account": "ES4021005321592566566159",
"owner": {"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
},
"additional_info": [{"key": "string",
"value": "string"
}
],
"transactions": [{"uuid": "78ceedca9cd9d2f2bfbb2439795ab6a1fcefc12b",
"settled": false,
"operation_date": "2022-12-28",
"value_date": "2022-12-28",
"amount": -20,
"currency": "EUR",
"exchange_rate": 1,
"description": "Pago en AMZN MKTP ES123CM0ZM4",
"categorization": {"type": 0
},
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"receipts": [{"last_receipt_date": "2023-07-23",
"issuer": "Canal de Isabel II",
"description": "RECIBO CONTRATO 328774628 FACTURA DEL 18 07 23",
"account": "ES0123456789012345678901",
"status": "paid",
"amount": 50.75,
"pdf_file": "string",
"pdf_file_settled": true
}
],
"loans": [{"contract_number": "9620.321-205439-70",
"loan_type": "Variable rate mortgage",
"constitution_date": "2022-02-23",
"currency": "EUR",
"granted_capital": 207000,
"pending_amount": 166639.77,
"next_installment": 1040.3,
"linked_account": "ES0123456789012345678901",
"holders": [{"id": "32945945D",
"name": "Diego Serrano"
}
],
"interest_rate": 3.768,
"expiration_date": "2042-03-01",
"pending_receipts": 223,
"amortization_made": [{"date": "2022-12-01",
"amortized": 515.43,
"interest": 524.87,
"total": 1040.3,
"pending_capital": 166639.77,
"operation_type": "receipt_paid"
}
],
"amortization_pending": [{"date": "2030-12-01",
"amortized": 515.43,
"interest": 524.87,
"total": 1040.3,
"pending_capital": 66639.77,
"operation_type": "receipt_scheduled"
}
]
}
],
"deposits": [{"uuid": "0ae4d722b1c82feeafb4b36b2893230444071335",
"code": "DPZ-1234567890",
"name": "12-month deposit",
"currency": "EUR",
"principal": 10000,
"pending_principal": 5000,
"start_date": "2024-09-01",
"maturity_date": "2025-09-01",
"payment_frequency": "at_maturity",
"capitalization": "none",
"rate_type": "fixed",
"nominal_interest_rate": 3,
"apr_tae": 3.04,
"day_count_convention": "ACT/365",
"linked_account": "ES4021005321592566566159",
"accrued_interest": 24.58,
"expected_interest_total": 300,
"withholding_tax_rate": 19,
"status": "active",
"auto_renewal": {"enabled": false,
"renewed_times": 0,
"next_renewal_date": "2019-08-24",
"renewal_term_months": 0
},
"early_withdrawal": {"allowed": true,
"penalty_type": "interest_loss",
"penalty_value": 100,
"notes": "Loss of accrued interest for the current period"
},
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"interest_movements": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"scheduled": false,
"date": "2025-09-01",
"period_start": "2024-09-01",
"period_end": "2025-09-01",
"currency": "EUR",
"gross_interest": 300,
"withholding_tax": 57,
"net_interest": 243,
"payment_type": "maturity"
}
],
"principal_movements": [{"date": "2019-08-24",
"type": "opening",
"amount": 12000,
"currency": "string",
"target_account": "string"
}
]
}
],
"leases": [{"subtype": "leasing",
"uuid": "1f0a0b1c2d3e4f5a6b7c8d9e0f1234567890abcd",
"contract_number": "L-2024-000123",
"name": "BMW 3 Series Leasing",
"provider": {"name": "Banco XYZ Renting, S.A.",
"tax_id": "A12345678"
},
"currency": "EUR",
"start_date": "2024-10-01",
"end_date": "2028-09-30",
"term_months": 48,
"payment_frequency": "monthly",
"status": "active",
"linked_account": "ES4021005321592566566159",
"holders": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"asset": {"category": "vehicle",
"description": "BMW 320d Touring",
"vin": "WBA8G51040K123456",
"license_plate": "1234-ABC",
"brand": "BMW",
"model": "320d",
"year": 2024,
"serial_number": "string",
"address": "string"
},
"financials": {"capital_financed": 35000,
"nominal_interest_rate": 4.25,
"apr_tae": 4.38,
"discount_rate": 0,
"initial_fee": 3000,
"security_deposit": 1000,
"residual_value": 12000,
"purchase_option": true,
"services_included": {"maintenance": true,
"insurance": true,
"roadside_assistance": true,
"tires": false
},
"vat_included": true,
"mileage_limit_year": 15000,
"early_termination": {"allowed": true,
"penalty_type": "percentage_of_remaining",
"penalty_value": 40
}
},
"totals": {"paid_installments": 10,
"remaining_installments": 38,
"total_paid": 0,
"total_pending": 0,
"principal_outstanding": 0,
"accrued_interest": 0
},
"installments": {"paid": [{"uuid": "b07a1a0d3e6f4c2a9e1d0f8b7c6a5e4d3c2b1a0f",
"date": "2025-01-01",
"status": "pending",
"currency": "EUR",
"total": 625.5,
"breakdown": {"principal": 450,
"interest": 80,
"services": 70,
"taxes": 25.5,
"fees": 0
},
"value_date": "2019-08-24",
"receipt_uuid": "string",
"additional_info": [{"key": null,
"value": null
}
]
}
],
"scheduled": [{"uuid": "b07a1a0d3e6f4c2a9e1d0f8b7c6a5e4d3c2b1a0f",
"date": "2025-01-01",
"status": "pending",
"currency": "EUR",
"total": 625.5,
"breakdown": {"principal": 450,
"interest": 80,
"services": 70,
"taxes": 25.5,
"fees": 0
},
"value_date": "2019-08-24",
"receipt_uuid": "string",
"additional_info": [{"key": null,
"value": null
}
]
}
]
}
}
],
"properties": [{"uuid": "string",
"code": "string",
"description": "string",
"purpose": "string",
"currency": "string",
"trading_price": 0,
"trading_year": 0,
"historic_prices": [{"date": "2019-08-24",
"price": 0
}
]
}
],
"files": [{"file_date": "2023-07-21",
"retrieval_type": "repository",
"file_type": "Norma 43",
"description": "Monthly account statement",
"content": "string"
}
],
"contracts": [{"signing_date": "2003-09-26",
"type": "loan",
"subtype": "mortgage",
"description": "Variable rate mortgage",
"pdf_file": "string"
}
],
"factoring": [{"uuid": "a62ae601a424403d0fbe968d335378421006c277",
"contract_number": "000117001234567",
"name": "FACTORING PPAL SIN RECURSO",
"currency": "EUR",
"balances": {"available": 11360.26,
"disposed": 0,
"limit": 11360.26
},
"interest_rate": 5.25,
"linked_account": "ES0700812345678987654321",
"next_payment_date": "",
"number_invoices": 8,
"total_value": 14495.28,
"total_advanced_value": 6919.29,
"providers": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"company_id": "A12345678",
"company_name": "EMPRESA 1 SA"
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"provider_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"amount": 918.45,
"status": "advanced",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"confirming": [{"uuid": "a62ae601a424403d0fbe968d335378421006c277",
"contract_number": "000117001234567",
"name": "CONFIRMING PPAL SIN RECURSO",
"currency": "EUR",
"balances": {"available": 11360.26,
"disposed": 0,
"limit": 11360.26
},
"interest_rate": 5.25,
"linked_account": "ES0700812345678987654321",
"next_payment_date": "",
"number_invoices": 8,
"total_value": 14495.28,
"total_advanced_value": 6919.29,
"providers": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"company_id": "A12345678",
"company_name": "EMPRESA 1 SA"
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"provider_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"amount": 918.45,
"status": "advanced",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"employment": {"summary": {"totalDaysRegistered": 8912,
"daysInMultipleActivity": 130,
"daysContributedForBenefits": 8782,
"totalTimeEquivalence": "24 años, 0 meses y 17 días."
},
"periods": [{"employer": "TRABAJADOR AUTONOMO",
"regime": "AUTONOMO",
"contract": "INDEFINIDO.TIEMPO COMPLETO.ORDINARIO",
"category": "INGENIEROS LICENCIADOS",
"actualStartDate": "2022-11-10",
"startDate": "2022-11-10",
"endDate": "Actual",
"contributedDays": 1062
}
]
},
"guarantees": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"code": "f2eb8HsfBDSDseBw8HeSccOwJweJ2OfxH2xDw8Ss",
"name": "Aval Financiero",
"nickname": "Aval Técnico",
"subtype": "financial",
"currency": "EUR",
"linked_account": "ES1001289462580857003432",
"issuer": "Bankinter, S.A.",
"beneficiary": "AYUNTAMIENTO DE MADRID",
"purpose": "Licitación obra pública expediente 2025/00123",
"issue_date": "2024-06-12",
"expiration_date": "2026-06-11",
"status": "active",
"balances": {"guaranteed_amount": 50000,
"exposure": 0,
"available": 50000,
"euro_equivalent": 50000
},
"fees_commissions": {"periodicity": "quarterly",
"last_charge_date": "2025-03-31",
"last_charge_amount": 125
},
"additional_info": [{"key": "euroEquivalent",
"value": "0.00"
}
]
}
]
},
"statistics": {"SESSION": Infinity,
"execution_time": 0.958119869232178,
"warnings": [{"code": 1000,
"message": "No contracted funds",
"product_type": "portfolios"
}
],
"operation_id": "1827C79229",
"token": "FRJ0mHlaqZwLzu"
}
}
]

Tapahtumatyyppien luettelo

query Parameters

lang	string Default: "es" Enum: "es" "en" Response language

Responses

Response samples

Content type

application/json

[[{"type": 100,
"literal": "Dividend collection"
}
]
]

Kysy api_key-tunnisteeseen liittyviä tokeneita

Käytä tätä menetelmää kaikkien tiettyyn api_key-tunnisteeseen liittyvien tokenien kyselyyn. Tulokset palautetaan 500 tokenin lohkoissa sivua kohden.

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

api_key	string api_key asiakkaan tunnistamiseksi palvelussa
page	number Määritä sivunumero, jonka haluat hakea. Jokainen sivu sisältää enintään 500 tokenia. Jos ei ole annettu, oletusarvo on `1`.

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

api_key=12345678&page=1

Response samples

Content type

application/json

[{"token": "string",
"entity_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"accesed_at": "2019-08-24T14:15:22Z",
"times_accesed": 0,
"latest_code": 0,
"latest_session": "string"
}
]

Peruuta token

Tämä menetelmä mahdollistaa olemassa olevan tokenin peruuttamisen tulevien API-käyttöpyyntöjen estämiseksi.

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

api_key	string Tunnistaa asiakkaan palvelussa
token	string Token, joka peruutetaan.

Responses

Response samples

Content type

application/json

{"success": true,
"message": "Token successfully revoked."
}

Määritä token uudelleen eri api_key-tunnisteelle

Tämä menetelmä mahdollistaa tokenin uudelleenmäärityksen yhdestä api_key-tunnisteesta toiseen.

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

api_key_source	string api_key, josta token määritetään uudelleen.
api_key_target	string api_key, johon token määritetään uudelleen.
token	string Token, joka määritetään uudelleen.

Responses

Request samples

Payload

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."
}

Lisää uusi verkkotunnus

Lisää yhteyden widgetin isännöivän verkkotunnuksen ja kohde-webhookin välille. Turvallisuussyistä muokkaus- ja poistotoiminnot ovat mahdollisia vain pyytämällä niitä tuelta

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

Payload

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"
}

Virhekoodiluettelo

Virhekoodiluettelo. Kiinnitä erityistä huomiota siihen, että kaikkia virhekoodeja ei pitäisi käsitellä samalla tavalla sovelluksessasi. Väärän salasanan virheen kohdalla sinun ei pitäisi yrittää kutsua uudelleen samoilla parametreilla, mutta virheen kohdalla, joka osoittaa että entiteetti on huollossa, voit yrittää uudelleen. Pyydä teknistä istuntoa tiimimme kanssa ratkaistaksesi kaikki kysymykset virheenhallinnasta.

query Parameters

lang	string Default: "es" Enum: "es" "en" Response language

Responses

Response samples

Content type

application/json

[[{"code": 2,
"description": "Incorrect call",
"possible_reasons": "Some of the required parameters have not been sent or have been sent in an incorrect format",
"how_to_proceed": "The text received in \"message\" will detail the reason for the error. For example, \"The parameter \"api_key\" is mandatory\"."
}
]
]

Varoituskoodiluettelo

Varoituskoodiluettelo.

query Parameters

lang	string Default: "es" Enum: "es" "en" Response language

Responses

Response samples

Content type

application/json

[[{"code": 2,
"description": "Incorrect call",
"possible_reasons": "Some of the required parameters have not been sent or have been sent in an incorrect format",
"how_to_proceed": "The text received in \"message\" will detail the reason for the error. For example, \"The parameter \"api_key\" is mandatory\"."
}
]
]

Advanced

Valinnaiset päätepisteet, joita ei vaadita vakiointegraatioihin. Käytä vain, jos Wealth Reader nimenomaisesti ohjeistaa.

Hakee tuettujen yksiköiden luettelon

Hakee tuettujen yksiköiden luettelon ja tiedot, jotka tarvitaan yksikön kirjautumislomakkeen piirtämiseen.

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

[{"code": "bancamarch",
"name": "Bancamarch",
"logo": "https://cdn.wealthreader.com/bancamarch.svg",
"color": "#e23e4d",
"inputs": {"document_type": {"required": false,
"name": "DNI;Pasaporte"
},
"user": {"required": true,
"name": "Username"
},
"password": {"required": true,
"name": "Access key"
}
},
"statistics": {"SESSION": Infinity,
"execution_time": 0.958119869232178,
"warnings": [{"code": 1000,
"message": "No contracted funds",
"product_type": "portfolios"
}
],
"operation_id": "1827C79229",
"token": "FRJ0mHlaqZwLzu"
}
}
]

Vahvista pankkitilin omistajuus IBAN:in kautta

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Mahdollistaa sen tarkistamisen, onko luonnollinen tai oikeushenkilö tietyn pankkitilin haltija käyttäen IBAN:ia ja väitetyn haltijan tunnistetietoja.

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

Payload

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": {"code": 1,
"message": "The IBAN belongs to the indicated holder"
},
"statistics": {"SESSION": Infinity,
"execution_time": 0.958119869232178,
"warnings": [{"code": 1000,
"message": "No contracted funds",
"product_type": "portfolios"
}
],
"operation_id": "1827C79229",
"token": "FRJ0mHlaqZwLzu"
}
}

Rekisteröi uusi käyttäjä

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tämä päätepiste mahdollistaa käyttäjän rekisteröinnin joko portfolion siirtoalustalle Easytransfer tai raportointityökalulle Acumulas, perustuen yksilölliseen tunnisteeseen.

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"
}

Tarkista käyttäjän rekisteröintitila

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tarkistaa, onko käyttäjä rekisteröity Easytransfer- tai Acumulas-järjestelmään ja palauttaa käyttäjän yksilöllisen pääsylinkin.

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

{"success": true,
"registered": true,
"user_id": "12345",
"links": {"easy-transfer": "https://singularbank.wealthreader.com/...",
"integra": "https://www.acumulas.com/register?..."
}
}

Peruuta aiemmin rekisteröity käyttäjä

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tämä päätepiste mahdollistaa käyttäjän poistamisen Easytransfer- tai Acumulas-alustapalvelusta.

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"
}

Batch-yhteyksien lataus

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tärkeää: Wealthreader-puolen eräprosessien hallinnan käyttämiseen vaaditaan omistettu ympäristö. Tämä päätepiste ei ole käytettävissä osoitteessa api.wealthreader.com. "batch"-tagin alla ryhmitellyt päätepisteet mahdollistavat useiden pankkiyhteyksien asynkronisen käsittelyn, toisin kuin synkroninen /entities/-menetelmä. Ihanteellinen suurten yhteysvolyymien käsittelyyn ja aikakatkaisujen välttämiseen.

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

Payload

Content type

application/json

{"api_key": "12345678",
"notification_url": "https://example.com/webhook/batch-complete",
"connections": [{"code": "caixabank",
"token": "token123",
"product_types": "accounts,portfolios"
},
{"code": "BBVA",
"token": "token456",
"product_types": "accounts",
"date_from": "2024-01-01"
}
]
}

Response samples

Content type

application/json

{"success": true,
"batch_id": "batch_20250120_a1b2c3d4",
"total_connections": 5,
"estimated_completion_time": "2025-01-20T10:45:00Z"
}

Hae yleisiä tilastoja batch-yhteyksistä

Tämä päätepiste on valinnainen. Hakee yleisiä tilastoja kaikkien batch-yhteyksien käsittelytuloksesta.

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

Payload

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": {"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"total_execution_time": 125.5,
"total_connections": 8,
"successful_connections": 7,
"failed_connections": 1
}
}

Hae tietyn yhteyden yksittäinen tulos batchin sisällä

Tämä päätepiste on valinnainen. Hakee tietyn yhteyden tuloksen batchista.

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

Payload

Content type

application/json

{"api_key": "string",
"batch_id": "string",
"credential_id": "string"
}

Response samples

Content type

application/json

{"success": true,
"payload": {"user_information": {"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"gender": "male",
"birth_date": "1980-09-26",
"birth_place": "Ibiza",
"email": "[email protected]",
"cell_phone": "+34666123456",
"address": "CALLE BAILEN 41 1A",
"city": "MADRID",
"country": "SPAIN",
"postal_code": "28005",
"marital_status": "married",
"job": "CUENTA PROPIA"
},
"portfolios": [{"subtype": "funds",
"uuid": "05e4563f5bbf2d06efd0a29ebe7edbbb4e1bff63",
"code": "1465010091400123456789",
"name": "Fondo Dinámico",
"currency": "EUR",
"total_value": 3275.6,
"weighted_return": 8.49,
"annualized_volatility": 0,
"yield": 256.27,
"contributions": 3019.33,
"withholdings": 0,
"contracting_date": "2016-04-27",
"linked_account": "ES4021005321592566566159",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"composition": {"currency": "EUR",
"weighting": 100,
"shares": 225.0077,
"price": 14.5577,
"total_amount": 3275.6
},
"transactions": [{"uuid": "05e4563f5bbf2d06efd0a29ebe7edbbb4e1bff63",
"operation_pending": false,
"operation_date": "2020-01-30",
"value_date": "2020-01-30",
"operation_type": "purchase",
"shares": 1076.8273,
"price": 11.1438,
"total_amount": 12000,
"reference_currency": "EUR",
"currency": "EUR",
"exchange_rate": 1
}
]
}
],
"bonds": [{"uuid": "b8e42d60e6e8d3a5efb0b2a8e4e0b1a4b5c5d6e7",
"name": "Bono del Estado Español 2025",
"isin": "ES00000123E5",
"currency": "EUR",
"total_value": 5000,
"interest_rate": 1.75,
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"maturity_date": "2025-10-15",
"issuer": "Gobierno de España",
"principal": 1000,
"coupon_payment_dates": ["2023-04-15",
"2023-10-15"
],
"credit_rating": "AAA",
"yield_to_maturity": 2.5,
"current_yield": 2,
"callability": "Callable a partir del 2024-01-01",
"type_of_bond": "government"
}
],
"accounts": [{"uuid": "8076932f04f73e27fe608fee4d12fca8708dec8c",
"subtype": "checking",
"interest_rate": 0.5,
"line_of_credit_details": {"credit_limit": 50000,
"interest_rate": 4.5,
"credit_used": 15000,
"credit_available": 35000,
"constitution_date": "2021-05-20",
"expiration_date": "2031-05-20"
},
"code": "ES4914651234561234567890",
"name": "Cuenta NÓMINA",
"currency": "EUR",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"balances": {"available": 14302.07,
"current": 14302.07
},
"additional_info": [{"key": "string",
"value": "string"
}
],
"transactions": [{"uuid": "d0c2ea4c072cf4d7b0fd494d7728260d736e6b25",
"operation_date": "2022-12-30",
"value_date": "2022-12-30",
"amount": -1.1,
"balance": 14302.07,
"description": "Pago en TELPARK MADRID ES",
"pdf_file": "string",
"pdf_file_final": true,
"categorization": {"type": 1,
"portfolio-uuid": "1465010091400123456789",
"ISIN": "US88160R1014"
},
"transfer_details": {"concept": "Pago de factura 12345",
"sender_receiver": "Juan Pérez",
"account_number": "ESXX12341234121234567890"
},
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"cards": [{"status": "active",
"subtype": "credit",
"uuid": "aefd89eade0a6a09d9b8eab4c22da6a6a37632e6",
"code": "516097********1234",
"name": "Credit Card",
"currency": "EUR",
"next_payment_date": "2023-01-05",
"anual_interest": 17.48,
"tae": 18.95,
"balances": {"available": 3980,
"limit": 4000,
"disposed": 20
},
"linked_account": "ES4021005321592566566159",
"owner": {"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
},
"additional_info": [{"key": "string",
"value": "string"
}
],
"transactions": [{"uuid": "78ceedca9cd9d2f2bfbb2439795ab6a1fcefc12b",
"settled": false,
"operation_date": "2022-12-28",
"value_date": "2022-12-28",
"amount": -20,
"currency": "EUR",
"exchange_rate": 1,
"description": "Pago en AMZN MKTP ES123CM0ZM4",
"categorization": {"type": 0
},
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"receipts": [{"last_receipt_date": "2023-07-23",
"issuer": "Canal de Isabel II",
"description": "RECIBO CONTRATO 328774628 FACTURA DEL 18 07 23",
"account": "ES0123456789012345678901",
"status": "paid",
"amount": 50.75,
"pdf_file": "string",
"pdf_file_settled": true
}
],
"loans": [{"contract_number": "9620.321-205439-70",
"loan_type": "Variable rate mortgage",
"constitution_date": "2022-02-23",
"currency": "EUR",
"granted_capital": 207000,
"pending_amount": 166639.77,
"next_installment": 1040.3,
"linked_account": "ES0123456789012345678901",
"holders": [{"id": "32945945D",
"name": "Diego Serrano"
}
],
"interest_rate": 3.768,
"expiration_date": "2042-03-01",
"pending_receipts": 223,
"amortization_made": [{"date": "2022-12-01",
"amortized": 515.43,
"interest": 524.87,
"total": 1040.3,
"pending_capital": 166639.77,
"operation_type": "receipt_paid"
}
],
"amortization_pending": [{"date": "2030-12-01",
"amortized": 515.43,
"interest": 524.87,
"total": 1040.3,
"pending_capital": 66639.77,
"operation_type": "receipt_scheduled"
}
]
}
],
"deposits": [{"uuid": "0ae4d722b1c82feeafb4b36b2893230444071335",
"code": "DPZ-1234567890",
"name": "12-month deposit",
"currency": "EUR",
"principal": 10000,
"pending_principal": 5000,
"start_date": "2024-09-01",
"maturity_date": "2025-09-01",
"payment_frequency": "at_maturity",
"capitalization": "none",
"rate_type": "fixed",
"nominal_interest_rate": 3,
"apr_tae": 3.04,
"day_count_convention": "ACT/365",
"linked_account": "ES4021005321592566566159",
"accrued_interest": 24.58,
"expected_interest_total": 300,
"withholding_tax_rate": 19,
"status": "active",
"auto_renewal": {"enabled": false,
"renewed_times": 0,
"next_renewal_date": "2019-08-24",
"renewal_term_months": 0
},
"early_withdrawal": {"allowed": true,
"penalty_type": "interest_loss",
"penalty_value": 100,
"notes": "Loss of accrued interest for the current period"
},
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"interest_movements": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"scheduled": false,
"date": "2025-09-01",
"period_start": "2024-09-01",
"period_end": "2025-09-01",
"currency": "EUR",
"gross_interest": 300,
"withholding_tax": 57,
"net_interest": 243,
"payment_type": "maturity"
}
],
"principal_movements": [{"date": "2019-08-24",
"type": "opening",
"amount": 12000,
"currency": "string",
"target_account": "string"
}
]
}
],
"leases": [{"subtype": "leasing",
"uuid": "1f0a0b1c2d3e4f5a6b7c8d9e0f1234567890abcd",
"contract_number": "L-2024-000123",
"name": "BMW 3 Series Leasing",
"provider": {"name": "Banco XYZ Renting, S.A.",
"tax_id": "A12345678"
},
"currency": "EUR",
"start_date": "2024-10-01",
"end_date": "2028-09-30",
"term_months": 48,
"payment_frequency": "monthly",
"status": "active",
"linked_account": "ES4021005321592566566159",
"holders": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"asset": {"category": "vehicle",
"description": "BMW 320d Touring",
"vin": "WBA8G51040K123456",
"license_plate": "1234-ABC",
"brand": "BMW",
"model": "320d",
"year": 2024,
"serial_number": "string",
"address": "string"
},
"financials": {"capital_financed": 35000,
"nominal_interest_rate": 4.25,
"apr_tae": 4.38,
"discount_rate": 0,
"initial_fee": 3000,
"security_deposit": 1000,
"residual_value": 12000,
"purchase_option": true,
"services_included": {"maintenance": true,
"insurance": true,
"roadside_assistance": true,
"tires": false
},
"vat_included": true,
"mileage_limit_year": 15000,
"early_termination": {"allowed": true,
"penalty_type": "percentage_of_remaining",
"penalty_value": 40
}
},
"totals": {"paid_installments": 10,
"remaining_installments": 38,
"total_paid": 0,
"total_pending": 0,
"principal_outstanding": 0,
"accrued_interest": 0
},
"installments": {"paid": [{"uuid": "b07a1a0d3e6f4c2a9e1d0f8b7c6a5e4d3c2b1a0f",
"date": "2025-01-01",
"status": "pending",
"currency": "EUR",
"total": 625.5,
"breakdown": {"principal": 450,
"interest": 80,
"services": 70,
"taxes": 25.5,
"fees": 0
},
"value_date": "2019-08-24",
"receipt_uuid": "string",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
],
"scheduled": [{"uuid": "b07a1a0d3e6f4c2a9e1d0f8b7c6a5e4d3c2b1a0f",
"date": "2025-01-01",
"status": "pending",
"currency": "EUR",
"total": 625.5,
"breakdown": {"principal": 450,
"interest": 80,
"services": 70,
"taxes": 25.5,
"fees": 0
},
"value_date": "2019-08-24",
"receipt_uuid": "string",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
}
],
"properties": [{"uuid": "string",
"code": "string",
"description": "string",
"purpose": "string",
"currency": "string",
"trading_price": 0,
"trading_year": 0,
"historic_prices": [{"date": "2019-08-24",
"price": 0
}
]
}
],
"files": [{"file_date": "2023-07-21",
"retrieval_type": "repository",
"file_type": "Norma 43",
"description": "Monthly account statement",
"content": "string"
}
],
"contracts": [{"signing_date": "2003-09-26",
"type": "loan",
"subtype": "mortgage",
"description": "Variable rate mortgage",
"pdf_file": "string"
}
],
"factoring": [{"uuid": "a62ae601a424403d0fbe968d335378421006c277",
"contract_number": "000117001234567",
"name": "FACTORING PPAL SIN RECURSO",
"currency": "EUR",
"balances": {"available": 11360.26,
"disposed": 0,
"limit": 11360.26
},
"interest_rate": 5.25,
"linked_account": "ES0700812345678987654321",
"next_payment_date": "",
"number_invoices": 8,
"total_value": 14495.28,
"total_advanced_value": 6919.29,
"providers": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"company_id": "A12345678",
"company_name": "EMPRESA 1 SA"
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"provider_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"amount": 918.45,
"status": "advanced",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"confirming": [{"uuid": "a62ae601a424403d0fbe968d335378421006c277",
"contract_number": "000117001234567",
"name": "CONFIRMING PPAL SIN RECURSO",
"currency": "EUR",
"balances": {"available": 11360.26,
"disposed": 0,
"limit": 11360.26
},
"interest_rate": 5.25,
"linked_account": "ES0700812345678987654321",
"next_payment_date": "",
"number_invoices": 8,
"total_value": 14495.28,
"total_advanced_value": 6919.29,
"providers": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"company_id": "A12345678",
"company_name": "EMPRESA 1 SA"
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"provider_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"amount": 918.45,
"status": "advanced",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"employment": {"summary": {"totalDaysRegistered": 8912,
"daysInMultipleActivity": 130,
"daysContributedForBenefits": 8782,
"totalTimeEquivalence": "24 años, 0 meses y 17 días."
},
"periods": [{"employer": "TRABAJADOR AUTONOMO",
"regime": "AUTONOMO",
"contract": "INDEFINIDO.TIEMPO COMPLETO.ORDINARIO",
"category": "INGENIEROS LICENCIADOS",
"actualStartDate": "2022-11-10",
"startDate": "2022-11-10",
"endDate": "Actual",
"contributedDays": 1062
}
]
},
"guarantees": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"code": "f2eb8HsfBDSDseBw8HeSccOwJweJ2OfxH2xDw8Ss",
"name": "Aval Financiero",
"nickname": "Aval Técnico",
"subtype": "financial",
"currency": "EUR",
"linked_account": "ES1001289462580857003432",
"issuer": "Bankinter, S.A.",
"beneficiary": "AYUNTAMIENTO DE MADRID",
"purpose": "Licitación obra pública expediente 2025/00123",
"issue_date": "2024-06-12",
"expiration_date": "2026-06-11",
"status": "active",
"balances": {"guaranteed_amount": 50000,
"exposure": 0,
"available": 50000,
"euro_equivalent": 50000
},
"fees_commissions": {"periodicity": "quarterly",
"last_charge_date": "2025-03-31",
"last_charge_amount": 125
},
"additional_info": [{"key": "euroEquivalent",
"value": "0.00"
}
]
}
]
},
"statistics": {"SESSION": Infinity,
"execution_time": 0.958119869232178,
"warnings": [{"code": 1000,
"message": "No contracted funds",
"product_type": "portfolios"
}
],
"operation_id": "1827C79229",
"token": "FRJ0mHlaqZwLzu"
}
}

Wealth Reader (8.1.3)

Core

Hakee taloudelliset varat ja niiden koostumustiedot

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

Responses

Request samples

Response samples

Tapahtumatyyppien luettelo

query Parameters

Responses

Response samples

Kysy api_key-tunnisteeseen liittyviä tokeneita

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Peruuta token

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Määritä token uudelleen eri api_key-tunnisteelle

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Lisää uusi verkkotunnus

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Virhekoodiluettelo

query Parameters

Responses

Response samples

Varoituskoodiluettelo

query Parameters

Responses

Response samples

Advanced

Hakee tuettujen yksiköiden luettelon

query Parameters

Responses

Response samples

Vahvista pankkitilin omistajuus IBAN:in kautta

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Rekisteröi uusi käyttäjä

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Tarkista käyttäjän rekisteröintitila

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Peruuta aiemmin rekisteröity käyttäjä

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Batch-yhteyksien lataus

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Hae yleisiä tilastoja batch-yhteyksistä

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Hae tietyn yhteyden yksittäinen tulos batchin sisällä

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

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

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

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

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

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

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

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

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required