API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

Soláthraíonn APIanna rialaitheacha atá bunaithe ar PSD2 rochtain ar fhaisnéis airgeadais áirithe amhail iarmhéid cuntas bainc agus idirbhearta. Mar sin féin, tá foinsí eile faisnéise saibhris ann nach bhfuil inrochtana trí na APIanna seo. Leathnaíonn API Wealth Reader an fhaisnéis a thairgeann APIanna rialaitheacha trí rochtain fíor-ama a sholáthar ar fhoinsí saibhris breise in aon eintiteas ar fud an domhain. Tá dhá dhoiciméad eile gaolmhara ann a chabhróidh leat API Wealth Reader a chomhtháthú. Is é ceann acu an treoir chomhtháthaithe widget Javascript: https://docs-en.wealthreader.com/ agus is é an ceann eile bailiúchán Postman atá bunaithe ar an doiciméadú seo. An-tábhachtach: Tá an sainmhíniú API seo oiriúnaithe do chliaint a dhéanann comhtháthú trí Widget, mar sin fágadh amach roinnt paraiméadar nach bhfuil riachtanach don chineál seo comhtháthaithe, amhail paraiméadair fíordheimhnithe bainc, mar go n-úsáidfear token.

Core

API lárnach a theastaítear le haghaidh comhtháthaithe caighdeánacha

Faigheann sé sócmhainní airgeadais agus sonraí a gcomhdhéana

Faigheann sé sócmhainní airgeadais agus sonraí a gcomhdhéana lena n-áirítear punanna infheistíochta comhdhéanta de stoic nó cistí, cártaí creidmheasa, árachais agus iasachtaí. Áiríonn sé faisnéis úinéireachta do gach sócmhainn chomh maith le haitheantóirí uathúla a éascaíonn próiseáil sonraí. Is féidir sonraí Mock a fháil. Seiceáil leis an bhfoireann theicniúil conas é seo a dhéanamh.

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

Liosta de chineálacha idirbheart

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Iarr ar chomharthaí a bhaineann le api_key

Úsáid an modh seo chun na comharthaí go léir a bhaineann le api_key ar leith a cheistiú. Cuirtear torthaí ar ais i mbloic de 500 comhartha in aghaidh an leathanaigh.

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

Cealaigh comhartha

Ceadaíonn an modh seo comhartha atá ann cheana a chealú chun iarratais rochtana API amach anseo a dhícheadú.

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

Athshannadh comhartha go api_key difriúil

Ceadaíonn an modh seo comhartha a athshannadh ó api_key amháin go ceann eile.

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

Cuir fearann nua leis

Cuireann sé an nasc idir an fearann a óstálfaidh an widget agus an webhook ceann scríbe. Ar chúiseanna slándála, ní féidir oibríochtaí eagarthóireachta agus scriosadh a dhéanamh ach amháin trína n-iarraidh ón tacaíocht

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

Liosta de chóid earráide

Liosta de chóid earráide. Tabhair aird speisialta ar an bhfíric nach bhfuil gach cód earráide le cóir mar an gcéanna ó do fheidhmchlár. I gcás earráid pasfhocail mhícheart, níor cheart duit an glao a aththriail leis na paraiméadair chéanna, ach i gcás earráid a léiríonn go bhfuil an t-aonán faoi chothabháil, is féidir leat aththriail a dhéanamh. Iarr seisiún teicniúil lenár bhfoireann chun aon cheisteanna faoi bhainistíocht earráidí a réiteach.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Liosta de chóid rabhaidh

Liosta de chóid rabhaidh.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Críochphointí roghnacha nach dteastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid astu ach amháin má thugann Wealth Reader treoir shoiléir.

Faigheann sé liosta na n-eintiteas tacaithe

Faigheann sé liosta na n-eintiteas tacaithe agus an fhaisnéis a theastaíonn chun foirm logáil isteach na heintite a tharraingt.

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

Fíoraigh úinéireacht cuntas bainc trí IBAN

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Ceadaíonn sé fíorú an bhfuil duine nádúrtha nó dlíthiúil ina shealbhóir ar chuntas bainc sonrach ag úsáid an IBAN agus sonraí aitheantais an tsealbhóra líomhnaithe.

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

Cláraigh úsáideoir nua

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Ceadaíonn an críochphointe seo úsáideoir a chlárú ar ardán aistrithe punainne Easytransfer nó ar uirlis tuairiscithe Acumulas, bunaithe ar aitheantóir uathúil.

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

Seiceáil stádas cláraithe úsáideora

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Seiceálann sé an bhfuil úsáideoir cláraithe sa chóras Easytransfer nó Acumulas agus tugann sé ar ais an nasc rochtana uathúil don úsáideoir.

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

Cealaigh úsáideoir a cláraíodh roimhe seo

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Ceadaíonn an críochphointe seo úsáideoir a dhíchlárú ó sheirbhís ardán Easytransfer nó 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"
}

Luchtú nasc baisc

Tá an críochphointe seo roghnach agus ní theastaítear le haghaidh comhtháthaithe caighdeánacha. Bain úsáid as ach amháin má thugann Wealth Reader treoir shoiléir. Ceadaíonn na críochphointí atá grúpáilte faoin gclib "batch" naisc bainc iolracha a phróiseáil go hasincronach, murab ionann agus an modh sincronach /entities/. Idéalach chun méideanna móra nasc a phróiseáil agus teorainneacha ama a sheachaint.

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

Faigh staitisticí ginearálta faoi naisc bhaisc

Tá an críochphointe seo roghnach. Faigheann sé staitisticí ginearálta faoi thoradh próiseála na nasc go léir i mbaisc.

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

Faigh toradh aonair de nasc sonrach laistigh de bhaisc

Tá an críochphointe seo roghnach. Faigheann sé toradh naisc shonrach ón mbaisc.

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