API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

基于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

Identifies the client in the service

code
string

Name of the entity. The complete list is available with GET

token
string

Identifies the custodied credential. The flow by which the token has been obtained is described in the 'Widget Integration Guide' document. The following Mock users are available: MOCKDATA, OK response; MOCKOTP, response with OTP challenge; MOCKLOGINKO, response with login error

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

List of product types from which information is to be retrieved. Accepts multiple values separated by commas.

only_balances
boolean
Default: false

Indicates whether to obtain only the balances of the products instead of all available information. Default value: false.

date_from
string <date>

Date from which transactions are requested, in YYYY-MM-DD format. Must be a date before today.

date_to
string <date>

This only applies to restricting by future dates for products loan and confirming, in YYYY-MM-DD format. The date must be later than today

required_products_schema
string

Required products schema. Indicates the accounts or cards from which data is desired, with additional configurations.

add_pdf_from_uuids
string

Accepts transaction uuids separated by commas. Parameter that is only taken into account if product_types is ALL or includes accounts. Adds the PDF document associated with each of the requested bank transactions.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

交易类型列表

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

查询与api_key关联的令牌

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

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

api_key to identify the client in the service

page
number

Specify the page number you want to retrieve. Each page contains up to 500 tokens. If not provided, the default value is 1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

撤销令牌

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

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

Identifies the client in the service

token
string

Token to be revoked.

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 from which to reassign the token.

api_key_target
string

api_key to which to reassign the token.

token
string

Token to be reassigned.

Responses

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.

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

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
[
  • [
    ]
]

警告代码列表

警告代码列表。

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

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
[
  • {
    }
]

通过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)

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

Response samples

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

注册新用户

此端点是可选的，不需要用于标准集成。仅在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.

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

检查用户注册状态

此端点是可选的，不需要用于标准集成。仅在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.

Responses

Response samples

Content type
application/json
{}

撤销之前注册的用户

此端点是可选的，不需要用于标准集成。仅在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.

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

批量连接加载

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

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

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

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

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

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

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

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