Wealth Reader (8.1.6)

Download OpenAPI specification:

基于PSD2的监管API提供对某些金融信息的访问，如银行账户余额和交易。然而，还存在其他财富信息来源，这些信息无法通过这些API访问。Wealth Reader API通过提供对全球任何实体中额外财富来源的实时访问来扩展监管API提供的信息。还有两个其他相关文档将帮助您集成Wealth Reader API。一个是Javascript小部件集成指南：https://docs-en.wealthreader.com/ 另一个是基于此文档的Postman集合。非常重要：此API定义适用于通过Widget集成的客户端，因此省略了一些对此类集成不必要的参数，例如银行认证参数，因为将使用令牌。

Core

标准集成所需的核心API

检索金融资产及其组成详情

检索金融资产及其组成详情，包括由股票或基金组成的投资组合、信用卡、保险和贷款。包括每个资产的所有权信息以及便于数据处理的唯一标识符。可以获取Mock数据。请咨询技术团队如何操作。

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

api_key	string 在服务中标识客户端
code	string 实体名称。完整列表可通过GET获取示例: `caixabank`
token	string 标识托管的凭据。获取令牌的流程在"Widget集成指南"文档中描述。可用的Mock用户如下：MOCKDATA，OK响应；MOCKOTP，带OTP挑战的响应；MOCKLOGINKO，带登录错误的响应示例: `MOCKDATA`
product_types	string Enum: "accounts" "portfolios" "cards" "receipts" "loans" "factoring" "confirming" "properties" "invoices" "files" "deposits" "leases" 要检索信息的产品类型列表。接受多个用逗号分隔的值。示例: `accounts,portfolios`
only_balances	boolean Default: false 指示是否仅获取产品余额而不是所有可用信息。默认值：false。示例: `false`
date_from	string <date> 请求交易的起始日期，格式为YYYY-MM-DD。必须是今天之前的日期。示例: `2024-01-01`
date_to	string <date> 这仅适用于按未来日期限制贷款和确认产品，格式为YYYY-MM-DD。日期必须晚于今天示例: `2025-12-31`
required_products_schema	string 所需产品架构。指示需要从哪些账户或卡获取数据，以及附加配置。示例: `{ "ACCOUNTS": { "0ae4d722b1c82feeafb4b36b2893230444071335": { "only_balances": false, "add_pdf_from_uuids": [ "90763109952d4f2ebece8dceca8254078c5384a0" ], "date_from": "2024-04-03" } }, "CARDS": { "957e6f63546f3fecacce80192b6f7436496dc057": {} } }`
add_pdf_from_uuids	string 接受用逗号分隔的交易uuid。仅当product_types为ALL或包含accounts时才考虑此参数。添加与每个请求的银行交易相关联的PDF文档。示例: `20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295`
otp_method	string 当API返回错误码2017或20171（多种OTP方式）时，用于选择二次验证投递渠道。请使用同一响应中的会话标识再次调用，并将otp_method设为statistics.otpMethods中某一对象的otp_method字段的完整字符串——不要使用数组下标。首次凭据请求可省略；用户选择方式后必填。下方示例仅供参考；请始终复制statistics.otpMethods中返回的字符串。示例: `OTP_SMS ****1234`

Responses

Request samples

Payload
CLI

Content type

application/x-www-form-urlencoded

api_key=a1b2c3d4e5f6g7h8i9j0&code=caixabank&token=1234Asdf&product_types=accounts%2Cportfolios&only_balances=false&date_from=2024-01-01&date_to=2025-12-31&required_products_schema=%7B%22ACCOUNTS%22%3A%7B%220ae4d722b1c82feeafb4b36b2893230444071335%22%3A%7B%22only_balances%22%3Afalse%2C%22add_pdf_from_uuids%22%3A%5B%2290763109952d4f2ebece8dceca8254078c5384a0%22%5D%2C%22date_from%22%3A%222024-04-03%22%7D%7D%2C%22CARDS%22%3A%7B%22957e6f63546f3fecacce80192b6f7436496dc057%22%3A%7B%7D%7D%7D&add_pdf_from_uuids=20966426721d0885ef9d4b95535e1d3198936f16%2C8772d6c978d37d7af83094abf380b8b703e94105

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",
"portfolio_statement": "JVBERi0xLjQKJ...",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"composition": [{"ISIN": "LU1234567890",
"ISIN_description": "My Fund Class A",
"currency": "EUR",
"weighting": 100,
"shares": 225.0077,
"price": 14.5577,
"total_amount": 3275.6,
"reference_currency": "EUR",
"exchange_rate": 1
}
],
"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,
"currency": "EUR",
"reference_currency": "USD",
"exchange_rate": 1
}
]
}
],
"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_settled": 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": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"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",
"assignor_id": "B12345678",
"assignor": "QUICKSILVER DISTRIBUCION Y LOGISTICA SL",
"assignor_type": "non-recourse-factor",
"assignee": "Banco Sabadell",
"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,
"clients": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"client_id": "A12345678",
"client_name": "EMPRESA 1 SA",
"limit": 50000,
"disposed": 15000,
"available": 35000,
"payment_method": "transfer_payment",
"payment_deadline": 30
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"client_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"payment_date": "2024-01-20",
"invoice_amount": 918.45,
"received_amount": 873.53,
"status": "funded",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
],
"transactions": [{"uuid": "8a3b5c7d9e1f2a4b6c8d0e2f4a6b8c0d2e4f6a8b",
"operation_date": "2023-10-25",
"value_date": "2023-10-26",
"amount": 1500,
"currency": "EUR",
"description": "ANTICIPO FACTURA 2023-53"
}
]
}
],
"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"
}
}
]

交易类型列表

query Parameters

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

Responses

Response samples

Content type

application/json

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

查询与api_key关联的令牌

使用此方法查询与特定api_key关联的所有令牌。结果按每页500个令牌的块返回。

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

api_key	string api_key用于在服务中识别客户端
page	number 指定要检索的页码。每页最多包含500个令牌。如果未提供，默认值为`1`。示例: `2`

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

api_key=a1b2c3d4e5f6g7h8i9j0&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"
}
]

撤销令牌

此方法允许撤销现有令牌以取消授权未来的API访问请求。

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

api_key	string 在服务中标识客户端
token	string 要撤销的令牌。

Responses

Response samples

Content type

application/json

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

将令牌重新分配给不同的api_key

此方法允许将令牌从一个api_key重新分配到另一个。

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

api_key_source	string 从中重新分配令牌的api_key。
api_key_target	string 要将令牌重新分配到的api_key。
token	string 要重新分配的令牌。示例: `FRJ0mHlaqZwLzu`

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

api_key_source=a1b2c3d4e5f6g7h8i9j0&api_key_target=b2c3d4e5f6g7h8i9j0k1&token=FRJ0mHlaqZwLzu

Response samples

Content type

application/json

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

添加新域名

添加将托管小部件的域名与目标webhook之间的关联。出于安全原因，编辑和删除操作只能通过向支持团队请求来完成

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

method required	string Method to execute. 示例: `add`
api_key required	string User's API key.
domain required	string Domain to add. 示例: `http://desarrollo.cliente.es`
url_callback required	string URL for callback. 示例: `https://desarrollo.cliente.es/hooks/wealthreader`
tokenize required	string Indicates whether to tokenize or not. 示例: `1`

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

method=add&api_key=a1b2c3d4e5f6g7h8i9j0&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"
}

错误代码列表

错误代码列表。请特别注意，并非所有错误代码都应该由您的应用程序以相同方式处理。对于密码错误，您不应该使用相同的参数重试调用，但对于指示实体正在维护的错误，您可以重试。请与我们的团队请求技术会议，以解决有关错误管理的任何问题。

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

警告代码列表

警告代码列表。

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

可选端点，不需要用于标准集成。仅在 Wealth Reader 明确指示时使用。

检索支持的实体列表

检索支持的实体列表以及绘制实体登录表单所需的信息。

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

通过IBAN验证银行账户所有权

此端点是可选的，不需要用于标准集成。仅在Wealth Reader明确指示时使用。允许使用IBAN和声称持有人的身份数据验证自然人或法人是否是特定银行账户的持有人。

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) 示例: `ES4914651234561234567890`
document_type required	string Enum: "NIF" "NIE" "Pasaporte" "CIF" Type of identification document
document_number required	string Identification document number 示例: `12345678Z`
holder_name required	string Full name of the natural person or company name 示例: `LUIS GARCIA BAQUERO`

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

api_key=a1b2c3d4e5f6g7h8i9j0&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"
}
}

注册新用户

此端点是可选的，不需要用于标准集成。仅在Wealth Reader明确指示时使用。此端点允许基于唯一标识符在投资组合转移平台Easytransfer或报告工具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. 示例: `12345678A`
service required	string Enum: "integra" "easy-transfer" Service associated with the user. Determines the data flow. 示例: `easy-transfer`
email required	string <email> User email, used according to service type. 示例: `[email protected]`

Responses

Response samples

Content type

application/json

{"success": true,
"message": "User registered successfully"
}

检查用户注册状态

此端点是可选的，不需要用于标准集成。仅在Wealth Reader明确指示时使用。检查用户是否已在Easytransfer或Acumulas系统中注册，并返回用户的唯一访问链接。

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

api_key required	string Authentication key
user_id required	string User identification document. 示例: `12345678A`

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

撤销之前注册的用户

此端点是可选的，不需要用于标准集成。仅在Wealth Reader明确指示时使用。此端点允许从Easytransfer或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. 示例: `12345678A`
service required	string Enum: "integra" "easy-transfer" "all" Service from which to unregister the user. 'all' for all services. 示例: `easy-transfer`

Responses

Response samples

Content type

application/json

{"success": true,
"message": "User unregistered successfully"
}

批量连接加载

此端点是可选的，不需要用于标准集成。仅在Wealth Reader明确指示时使用。重要：要使用Wealthreader端的批量进程管理，需要专用环境。此端点在api.wealthreader.com上不可用。在"batch"标签下分组的端点允许异步处理多个银行连接，与同步的/entities/方法不同。非常适合处理大量连接并避免超时。

Request Body schema: application/json
required

api_key required	string Identifies the client in the service
notification_url required	string <uri> Webhook URL. A notification is sent to this URL for each individual credential as soon as it completes processing, not only once all connections in the batch are done. 示例: `https://example.com/webhook/batch-complete`
required	Array of objects (batch-connection) non-empty List of connections to process

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"api_key": "a1b2c3d4e5f6g7h8i9j0",
"notification_url": "https://example.com/webhook/batch-complete",
"connections": [{"credential_id": "cred_demo_001",
"code": "caixabank",
"token": "token123",
"product_types": "accounts,portfolios"
},
{"credential_id": "cred_demo_002",
"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"
}

Callback payload samples

Callback

POST: Webhook fired when a credential finishes processing

Content type

application/json

{"batch_id": 10863151,
"credential_id": "cred_demo_002",
"status": "completed",
"timestamp": "2026-05-13T08:02:47+00:00"
}

获取批量连接的一般统计信息

此端点是可选的。检索批次中所有连接处理结果的一般统计信息。

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

获取批次中特定连接的单独结果

此端点是可选的。检索批次中特定连接的结果。

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",
"portfolio_statement": "JVBERi0xLjQKJ...",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"composition": [{"ISIN": "LU1234567890",
"ISIN_description": "My Fund Class A",
"currency": "EUR",
"weighting": 100,
"shares": 225.0077,
"price": 14.5577,
"total_amount": 3275.6,
"reference_currency": "EUR",
"exchange_rate": 1
}
],
"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,
"currency": "EUR",
"reference_currency": "USD",
"exchange_rate": 1
}
]
}
],
"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_settled": 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": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"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",
"assignor_id": "B12345678",
"assignor": "QUICKSILVER DISTRIBUCION Y LOGISTICA SL",
"assignor_type": "non-recourse-factor",
"assignee": "Banco Sabadell",
"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,
"clients": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"client_id": "A12345678",
"client_name": "EMPRESA 1 SA",
"limit": 50000,
"disposed": 15000,
"available": 35000,
"payment_method": "transfer_payment",
"payment_deadline": 30
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"client_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"payment_date": "2024-01-20",
"invoice_amount": 918.45,
"received_amount": 873.53,
"status": "funded",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
],
"transactions": [{"uuid": "8a3b5c7d9e1f2a4b6c8d0e2f4a6b8c0d2e4f6a8b",
"operation_date": "2023-10-25",
"value_date": "2023-10-26",
"amount": 1500,
"currency": "EUR",
"description": "ANTICIPO FACTURA 2023-53"
}
]
}
],
"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.6)

Core

检索金融资产及其组成详情

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

Responses

Request samples

Response samples

交易类型列表

query Parameters

Responses

Response samples

查询与api_key关联的令牌

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

Responses

Request samples

Response samples

撤销令牌

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

Responses

Response samples

将令牌重新分配给不同的api_key

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

Responses

Request samples

Response samples

添加新域名

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

Responses

Request samples

Response samples

错误代码列表

query Parameters

Responses

Response samples

警告代码列表

query Parameters

Responses

Response samples

Advanced

检索支持的实体列表

query Parameters

Responses

Response samples

通过IBAN验证银行账户所有权

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

Responses

Request samples

Response samples

注册新用户

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

Responses

Response samples

检查用户注册状态

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

Responses

Response samples

撤销之前注册的用户

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

Responses

Response samples

批量连接加载

Request Body schema: application/jsonrequired

Responses

Callbacks

Request samples

Response samples

Callback payload samples

获取批量连接的一般统计信息

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

获取批次中特定连接的单独结果

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