Wealth Reader (8.1.12)

Download OpenAPI specification:

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

Aithníonn sé an cliant sa tseirbhís

code
string

Ainm na heintiteas. Tá an liosta iomlán ar fáil le GET

Sampla: caixabank

token
string

Aithníonn sé na dintiúir choimeádta. Tá an sreabhadh trína bhfuarthas an token tuairiscithe sa doiciméad 'Treoir chomhtháthaithe Widget'. Tá na húsáideoirí Mock seo a leanas ar fáil: MOCKDATA, freagra OK; MOCKOTP, freagra le dúshlán OTP; MOCKLOGINKO, freagra le earráid logáil isteach

Sampla: MOCKDATA

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

Liosta de chineálacha táirgí óna mbeidh faisnéis le fáil. Glacann sé le luachanna iolracha scartha le camóga.

Sampla: accounts,portfolios

only_balances
boolean
Default: false

Léiríonn sé an bhfaightear iarmhéideanna na dtáirgí amháin in ionad na faisnéise uile atá ar fáil. Luach réamhshocraithe: false.

Sampla: false

fetch_transaction_details
boolean
Default: false

Léiríonn sé ar cheart sonraí leathnaithe na n-idirbheart a fháil nuair a thacaíonn ceangaltóir an aonáin leis. TÁBHACHTACH: Má chumasaítear é, ciallaíonn sé go ndéanfar nascleanúint bhreise amháin nó níos mó in aghaidh gach idirbhirt chun an fhaisnéis a chuirtear ar ais a shaibhriú. Méadóidh sé seo go dosheachanta agus go suntasach an t-am rite. Fásann líon na nascleanúintí breise le líon na n-idirbheart. Moltar é a chumasú ach amháin nuair atá tú cinnte go bhfuil leibhéal mionsonraí níos mó ná an ceann a chuirtear ar ais de réir réamhshocraithe ag teastáil. Cuirtear na sonraí a fhaightear isteach san eochair additional_info ar leibhéal gach idirbhirt. Éilíonn úsáid an pharaiméadair seo timpeallacht thiomnaithe.

Sampla: false

date_from
string <date>

Dáta óna n-iarrtar idirbhearta, i bhformáid BBBB-MM-LL. Caithfidh sé a bheith dáta roimh inniu.

Sampla: 2024-01-01

date_to
string <date>

Níl feidhm leis seo ach chun srian a chur ar dhátaí amach anseo do tháirgí loan agus confirming, i bhformáid BBBB-MM-LL. Caithfidh an dáta a bheith níos déanaí ná inniu

Sampla: 2025-12-31

required_products_schema
string

Scéimre táirgí riachtanach. Léiríonn sé na cuntais nó na cártaí óna dteastaíonn sonraí, le cumraíochtaí breise.

Sampla:

{
  "ACCOUNTS": {
    "0ae4d722b1c82feeafb4b36b2893230444071335": {
      "only_balances": false,
      "add_pdf_from_uuids": [
        "90763109952d4f2ebece8dceca8254078c5384a0"
      ],
      "date_from": "2024-04-03"
    }
  },
  "CARDS": {
    "957e6f63546f3fecacce80192b6f7436496dc057": {}
  }
}
add_pdf_from_uuids
string

Glacann sé le uuid idirbhearta scartha le camóga. Paraiméadar nach dtógtar san áireamh ach amháin má tá product_types ALL nó má chuimsíonn sé accounts. Cuireann sé an doiciméad PDF a bhaineann le gach idirbheart bainc iarrtha.

Sampla:

20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295
otp_method
string

Roghnaíonn sé cén cainéal seachadta dháfhachtóir le húsáid nuair a d'fhill an API ar chód 2017 nó 20171 (il mhodhanna OTP). Glaoigh arís leis an aitheantas seisiúin céanna leis an bhfreagra sin agus socraigh otp_method ar an teaghrán cruinn sa réimse otp_method de oibiacht i statistics.otpMethods — ní innéacs an tairraing. Fág ar lár ar an gcéad iarratas creidmheasanna; seol tar éis rogha an úsáideora. Is léiriú é an sampla thíos; cóipeáil i gcónaí an teaghrán ó statistics.otpMethods.

Sampla: OTP_SMS ****1234

Responses

Request samples

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

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í a bhaineann le api_key ar leith a cheistiú. Tá na torthaí roinnte ina leathanaigh: socraíonn limit líon na gcomharthaí in aghaidh an leathanaigh (500 ar a mhéad) agus roghnaíonn page an leathanach a sheoltar ar ais. Tá api_key, method agus limit riachtanach; má tá ceann acu ar iarraidh nó neamhbhailí, freagraíonn an API le HTTP 400 agus cód earráide 2.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string^[a-z0-9]{8}$

api_key chun an cliant a aithint sa tseirbhís

method
required
string
Value: "get"

An oibríocht atá le déanamh. Is é get an t-aon luach a dtacaítear leis.

Sampla: get

limit
required
integer [ 1 .. 500 ]

Líon na gcomharthaí in aghaidh an leathanaigh. Íosmhéid 1, uasmhéid 500.

Sampla: 100

page
integer >= 1
Default: 1

Sonraigh an uimhir leathanaigh a theastaíonn uait a fháil. Tá suas le limit comhartha ar gach leathanach. Mura soláthraítear, is é 1 an luach réamhshocraithe.

Sampla: 1

code
string

Cód eintitis a úsáidtear chun na comharthaí a scagadh. Má fhágtar ar lár é, seoltar ar ais comharthaí na n-eintiteas go léir.

Sampla: bbva

sort_by
string
Default: "created_at"
Enum: "created_at" "accesed_at"

An réimse a úsáidtear chun na torthaí a shórtáil: created_at (dáta cruthaithe) nó accesed_at (dáta rochtana deireanach). Réamhshocrú created_at.

Sampla: created_at

sort_order
string
Default: "DESC"
Enum: "ASC" "DESC"

Treo an tsórtála: ASC (ag dul suas) nó DESC (ag dul síos). Réamhshocrú DESC.

Sampla: DESC

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=a1b2c3d4&method=get&limit=100&page=1

Response samples

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

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

Aithníonn sé an cliant sa tseirbhís

token
string

Comhartha le cealú.

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. Caithfidh an dá api_key a bheith gníomhach agus baint leis an gcuideachta chéanna, agus caithfidh an comhartha baint le api_key_source.

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

api_key óna ndéanfar athshannadh an chomhartha.

api_key_target
string

api_key chuig a ndéanfar athshannadh an chomhartha.

token
string

Comhartha le athshannadh.

Sampla: FRJ0mHlaqZwLzu

Responses

Request samples

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

Cuir fearann nua leis

Cuireann sé an nasc idir an fearann a óstálfaidh an widget agus an webhook ceann scríbe. Chun d'fhearainn a chur in eagar nó a thástáil, úsáid https://www.wealthreader.com/clients/

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

Method to execute.

Sampla: add

api_key
required
string

User's API key.

domain
required
string

Domain to add.

Sampla: http://desarrollo.cliente.es

url_callback
required
string

URL for callback.

Sampla: https://desarrollo.cliente.es/hooks/wealthreader

tokenize
required
string
Enum: "1" "0"

Rialaíonn sé an gcuireann an widget sreabhadh comharthaithe ar siúl:

  • 1 - Déanann an t-úsáideoir fíordheimhniú leis an institiúid airgeadais (logáil isteach, toiliú, 2FA más gá) agus seoltar comhartha in-athúsáidte ar ais
  • 0 - Ní dhéantar aon chomharthú. Ní mór luach an chomhartha a fuarthas roimhe seo a chur san iarratas

Sampla: 1

Responses

Request samples

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

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

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.

Sampla: 12345678A

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

Service associated with the user. Determines the data flow.

Sampla: easy-transfer

email
required
string <email>

User email, used according to service type.

Sampla: sai_banker@singularbank.com

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.

Sampla: 12345678A

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.

Sampla: 12345678A

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

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

Sampla: easy-transfer

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. Tábhachtach: Chun bainistiú próisis bhaisc a úsáid ar thaobh Wealthreader, tá timpeallacht tiomnaithe ag teastáil. Níl an críochphointe seo ar fáil ar api.wealthreader.com. 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>

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.

Sampla: https://example.com/webhook/batch-complete

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

List of connections to process

Responses

Callbacks

Request samples

Content type
application/json
{
  • "api_key": "a1b2c3d4e5f6g7h8i9j0",
  • "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"
}

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

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

MyBankMatch

Fíorú úinéireachta: seiceáil an le sealbhóir áirithe IBAN, trí Fhíorú an Íocaí (VoP) SEPA an bhainc atá nasctha le do cheadúnas. Treoir chéim ar chéim: MyBankMatch.

Fíoraíonn sé gur le sealbhóir IBAN (MyBankMatch)

Seiceálann sé an leis an sealbhóir a luaitear IBAN, trí Fhíorú an Íocaí (VoP) SEPA de do bhanc féin, atá nasctha le do cheadúnas WealthReader. Tugann sé breithiúnas an bhainc ar ais: ní chuireann sé ríomh áitiúil ar chosúlacht ainmneacha ina áit, agus ní chruthaíonn, ní údaraíonn agus ní fhorghníomhaíonn sé aon ordú íocaíochta.

Roimh an gcéad ghlao

  1. Bíodh ceadúnas gníomhach agat a bhfuil an táirge MY_BANK_MATCH aige agus cuóta ar fáil.
  2. Oscail Cliaint · MyBankMatch, brúigh Ceangail banc agus críochnaigh an fíordheimhniú i bhfuinneog óstáilte WealthReader. Bíonn an ceangal comharthaithe nasctha le do api_key; ní thugtar comhartha an bhainc don bhrabhsálaí agus ní paraiméadar den fhiosrúchán é.

Iarratas: corp ionchódaithe mar fhoirm (application/x-www-form-urlencoded) le api_key, iban agus name, díreach mar atá in /entities/. Ní sheoltar JSON agus ní úsáidtear an ceanntásc X-API-Key. Coinnigh an api_key i do chóras cúil.

Freagra: ciallaíonn HTTP 200 go bhfuarthas toradh ón táirge, ní go meaitseálann an t-ainm. Seiceáil success agus ansin payload.result:

payload.result Brí Réimsí breise Inbhillithe
MATCH Measann an banc go meaitseálann an t-ainm leis an sealbhóir. Dada. Tá, 0.10 EUR.
PARTIAL_MATCH Tugann an banc meaitseáil pháirteach ar ais (CLOSE_MATCH). suggested_name. Tá, 0.10 EUR.
NO_MATCH Léiríonn an banc nach meaitseálann an t-ainm. Dada. Tá, 0.10 EUR.
NOT_CONFIGURED Níl banc nasctha leis an gceadúnas fós. setup_url. Níl.
REAUTH_REQUIRED Teastaíonn fíordheimhniú nua ón gceangal leis an mbanc. setup_url, reason_code. Níl.
NOT_POSSIBLE Níorbh fhéidir breithiúnas inúsáidte a fháil. Ní hionann é agus NO_MATCH. reason. Níl.

Ní ídíonn ach MATCH, PARTIAL_MATCH agus NO_MATCH cuóta. Ní bhilltear earráidí ionchuir ná torthaí neamhchinntitheacha.

Níl eochair idempotachta ná atriail saor in aisce ann. Má chailltear an freagra (teorainn ama, an líonra nó corp nach féidir a léirmhíniú), d'fhéadfadh an toradh agus a ídiú cuóta a bheith anaithnid do d'fheidhmchlár. Ná seol an fiosrúchán céanna arís go huathoibríoch: athbhreithnigh an stair in Cliaint agus téigh i dteagmháil leis an tacaíocht ag lua statistics.SESSION.

Treoir iomlán: MyBankMatch.

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

Eochair 8 gcarachtar heicsidheachúlach ó cheadúnas gníomhach a bhfuil an táirge MY_BANK_MATCH aige agus cuóta ar fáil. Coinnigh i do chóras cúil í.

iban
required
string

IBAN ó thír SEPA. Baintear na spásanna, athraítear go ceannlitreacha é agus bailíochtaítear an fad dá thír agus na digití seiceála mod-97.

Sampla: ES9321005707250200257112

name
required
string <= 140 characters

Ainm an tsealbhóra. Gan a bheith folamh, UTF-8 bailí, gan carachtair rialaithe agus suas le 140 carachtar. Baintear spásanna ón tús agus ón deireadh agus laghdaítear spásanna inmheánacha leantacha go spás amháin.

Sampla: Wealthreader S.L.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=a1b2c3d4&iban=ES9321005707250200257112&name=Wealthreader%20S.L.

Response samples

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

Payments

Íocaíochtaí SEPA ó chuntas go cuntas a thionscnaítear ó bhanc an íocóra. Is féidir iad a chomhtháthú ar dhá bhealach:

  • Fast Track: tugann glao aonair POST /payments/?action=fast-track URL na híocaíochta ar ais agus cuireann Wealth Reader OK nó KO in iúl do do notification_url. Féach Íocaíochtaí Fast Track.
  • Giuirléid: cruthaíonn do chóras cúil intinn íocaíochta dho-athraithe le POST /payments/?action=create, osclaíonn sé an ghiuirléid leis an gcomhartha a tugadh ar ais agus deimhníonn sé an toradh le POST /payments/?action=status. Féach Réamhrá ar íocaíochtaí agus Stádais, ceistiú agus réiteach.

Rialacha atá coiteann do gach glao /payments/?action=...

  • Modh POST leis an gceanntásc Content-Type: application/json agus réad JSON mar chorp (32768 beart ar a mhéad).
  • Fíordheimhniú leis an gceanntásc X-API-Key amháin (wr_live_ agus 72 litir nó digit ina dhiaidh) ó cheadúnas gníomhach a bhfuil an táirge PAYMENTS aige. Ní sheoltar riamh sa chorp é. Áirítear gach glao fíordheimhnithe i dtreo theorainn glaonna an cheadúnais.
  • Is liosta ceadaithe é an corp: má tá réimse éigeantach ar iarraidh nó má tá réimse nach rabhthas ag súil leis ann, is é 422 invalid_request an freagra.
  • Is é payment_status: settled an t-aon deimhniú airgeadais dearfach. Ní chiallaíonn imeacht giuirléide, filleadh SCA ná interaction_status: completed riamh go bhfuil an íocaíocht socraithe.

Formáid earráide: application/json (ní problem+json) le error.code cobhsaí; is chun eolais amháin atá error.message agus d'fhéadfadh sé athrú.

{"success": false, "error": {"code": "invalid_request", "message": "The request body has an invalid schema."}}
HTTP error.code Cúis
400 invalid_json Corp folamh, neamhbhailí nó nach réad JSON é.
401 invalid_api_key X-API-Key ar iarraidh, míchumtha, anaithnid nó neamhghníomhach.
403 payments_not_allowed Níl an táirge PAYMENTS ag an gceadúnas.
404 action_not_found action anaithnid.
405 method_not_allowed Modh seachas POST.
413 request_too_large Corp níos mó ná 32768 beart.
415 json_required Content-Type seachas application/json.
422 invalid_request Réimsí ar iarraidh nó nach rabhthas ag súil leo.
429 api_limit_reached Sroicheadh teorainn glaonna an cheadúnais.
500 internal_error Earráid gan choinne.
503 payments_disabled, payments_accept_new_disabled, payment_storage_unavailable, payment_state_unavailable Seirbhís nach bhfuil ar fáil faoi láthair nó íocaíochtaí nua ar sos.

Fógra OK nó KO d'íocaíocht Fast Track Webhook

Seolann Wealth Reader an POST seo chuig notification_url íocaíochta Fast Track nuair a sheiceálann sé stádas na híocaíochta agus nuair a aimsíonn sé i stádas deiridh í. Ní stádas deiridh é reconciliation_required agus ní sheoltar fógra faoi: deimhnigh é le status.

  • Is ok é outcome ach amháin má tá an íocaíocht socraithe ag an mbanc (settled); seoltar ko do rejected, cancelled, expired agus failed.
  • Seiceáiltear an stádas fad is atá an t-íocóir fós ar an leathanach íocaíochta (ceistíonn sé go dtí an toradh deiridh nó go dtí go dtéann an seisiún íocaíochta in éag) agus gach uair a ghlaonn tú ar status. Níl seoladh sceidealaithe ar leith ann: má imíonn an t-íocóir sula dtagann an banc ar chonclúid, nó mura bhfreagraíonn do fhreastalaí le 2xx, seoltar an fógra sa chéad seiceáil eile. Mura bhfuil sé tagtha cúpla nóiméad tar éis an t-íocóir a atreorú, glaoigh ar status leis an payment_intent_id; spreagann an glao sin an fógra atá ar feitheamh freisin.
  • Freagair le haon 2xx chun é a mheas mar sheachadta. Ní leanann Wealth Reader atreoruithe agus fanann sé 3 soicind ar a mhéad.
  • D'fhéadfadh an fógra céanna teacht níos mó ná uair amháin: láimhseáil customer_reference móide outcome mar idempotach.
  • Níl an t-iarratas sínithe. Sula seachadann tú earra luachmhar, deimhnigh an toradh le status ag úsáid do X-API-Key agus payment_intent_id an fhógra.
header Parameters
User-Agent
required
string
Value: "WealthReader-Payments"
Request Body schema: application/json
required
outcome
required
string
Enum: "ok" "ko"

ok do settled amháin.

payment_status
required
string
Enum: "settled" "rejected" "cancelled" "expired" "failed"

Toradh airgeadais deiridh.

customer_reference
required
string

An Idempotency-Key a sheol tú nuair a chruthaigh tú an íocaíocht.

payment_intent_id
required
string <uuid>

An t-aitheantóir a thug fast-track ar ais. Úsáid é chun an toradh a dheimhniú le status.

Responses

Request samples

Content type
application/json
Example
{
  • "outcome": "ok",
  • "payment_status": "settled",
  • "customer_reference": "11111111-1111-4111-8111-111111111111",
  • "payment_intent_id": "3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f"
}

Cruthaíonn sé íocaíocht agus faigheann sé a URL (Fast Track)

Glao aonair a thugann URL na híocaíochta ar ais. Osclaíonn an t-íocóir é agus údaraíonn sé an íocaíocht ina bhanc; nuair a shroicheann an íocaíocht stádas deiridh, cuireann Wealth Reader OK nó KO in iúl do do notification_url (féach an crúca gréasáin notification_url). Taobh thiar de seo, cruthaítear an intinn dho-athraithe chéanna agus a chruthaítear le create: socraítear an méid, an tairbhí agus an cur síos sula sroicheann siad an brabhsálaí.

Is é an ceanntásc Idempotency-Key do thagairt ceannaí freisin (customer_reference san fhógra): ní sheoltar sa chorp é. Má athúsáideann tú an eochair chéanna leis an gcorp céanna, faigheann tú an URL céanna; má athúsáideann tú í le sonraí eile (lena n-áirítear logo eile), is é 409 idempotency_conflict an freagra.

Níl uasteorainn dá cuid féin ag aistriú láithreach san API seo: diúltaíonn an banc don aistriú nach féidir leis glacadh leis, de bharr an mhéid freisin, agus tagann an diúltú sin mar KO.

header Parameters
X-API-Key
required
string

Eochair API ó cheadúnas a bhfuil an táirge PAYMENTS aige. Coinnigh i do chóras cúil í.

Idempotency-Key
required
string [ 16 .. 128 ] characters

Idir 16 agus 128 carachtar; caithfidh sí tosú le litir nó digit agus gan ach litreacha, digití agus . _ : - a bheith inti. Tá UUID v4 bailí. Is í freisin an tagairt ceannaí a thugtar ar ais san fhógra.

Request Body schema: application/json
required
amount
required
string

Méid in aonaid mhóra, mar theaghrán JSON. Is ionann "15.50" agus 15.50 EUR; glactar freisin le slánuimhir gan deachúlacha ("15"). Dhá ionad deachúlacha ar a mhéad, mar sin is ionann an méid "15.5" agus "15.50". Íosmhéid 0.01. Tá an uasmhéid teoranta don teorainn atá socraithe ag gach cliant ina bhanc.

Sampla: 15.50

currency
required
string
Value: "EUR"

Airgeadra ISO 4217. Sa leagan seo, EUR amháin.

Sampla: EUR

required
object (payments-beneficiary)

Faighteoir an aistrithe. Ní féidir é a athrú nuair atá an íocaíocht cruthaithe.

reference
required
string [ 1 .. 140 ] characters

Cur síos ar an ráiteas, suas le 140 carachtar.

Sampla: Pedido 78901

priority
required
string
Enum: "normal" "instant"

normal (aistriú SEPA) nó instant (aistriú láithreach SEPA).

Sampla: normal

notification_url
required
string <= 2000 characters

URL https poiblí a fhaigheann an fógra OK nó KO. Gan dintiúir, port 443 má shonraítear port, agus gan seoltaí príobháideacha, áitiúla ná meiteashonraí.

Sampla: https://tienda.example.com/pagos/aviso

logo
string <= 2048 characters

Roghnach. URL https poiblí do lógó do cheannaí in SVG (caithfidh an chonair críochnú le .svg; glactar le paraiméadair fiosrúcháin), gan dintiúir, blúire ná seoltaí príobháideacha, suas le 2048 carachtar ASCII. Taispeánann an leathanach íocaíochta é os cionn na hachoimre; ní íoslódálann Wealth Reader é, is é brabhsálaí an íocóra a lódálann é. Is é 422 invalid_logo an freagra ar aon luach eile.

Sampla: https://tienda.example.com/marca/logo.svg

Responses

Request samples

Content type
application/json
{}

Response samples

Cruthaíonn sé intinn íocaíochta (giuirléid)

Cruthaíonn sé intinn íocaíochta dho-athraithe agus tugann sé comhartha gearrshaolach ar ais chun an ghiuirléid a oscailt i mbrabhsálaí an íocóra. Socraítear an méid, an tairbhí agus an cur síos sa chóras cúil agus ní féidir iad a athrú ón mbrabhsálaí. Tar éis don ghiuirléid dúnadh, deimhnigh an toradh ó do chóras cúil le status.

Tá dhá leagan den chorp ann:

  • Caighdeánach: socraíonn tú féin amount_minor, currency, beneficiary, reference, customer_reference agus allowed_origin.
  • Próifíl bhainistithe (mar shampla cruz_roja_demo): socraíonn Wealth Reader an tairbhí, an cur síos agus na teorainneacha; seolann tú profile, institution_code, amount_minor, customer_reference agus allowed_origin. Faigh na bainc le profile-institutions.

Má athúsáideann tú an Idempotency-Key chéanna leis an gcorp céanna, faigheann tú an intinn chéanna (200, idempotent_replay: true); má athúsáideann tú í le sonraí eile, is é 409 idempotency_conflict an freagra. Baineann an eochair le do chuideachta amháin.

Treoir: Intinní agus idempotacht agus Comhtháthú leis an ngiuirléid.

header Parameters
X-API-Key
required
string

Eochair API ó cheadúnas a bhfuil an táirge PAYMENTS aige. Coinnigh i do chóras cúil í.

Idempotency-Key
required
string [ 16 .. 128 ] characters

Idir 16 agus 128 carachtar ASCII infheicthe. Gin ceann amháin in aghaidh na híocaíochta (tá UUID v4 bailí) agus athúsáid é má dhéanann tú an glao a atriail.

Request Body schema: application/json
required
One of
amount_minor
required
integer >= 1

Méid in aonaid bheaga (ceintí) mar shlánuimhir JSON. Is ionann 1500 agus 15.00 EUR. Tá an uasmhéid teoranta don teorainn atá socraithe ag gach cliant ina bhanc.

Sampla: 1500

currency
required
string
Value: "EUR"
required
object (payments-beneficiary)

Faighteoir an aistrithe. Ní féidir é a athrú nuair atá an íocaíocht cruthaithe.

reference
required
string [ 1 .. 140 ] characters

Cur síos ar an ráiteas, suas le 140 carachtar.

Sampla: Pedido 78901

customer_reference
required
string <= 128 characters

Do thagairt inmheánach don íocaíocht. Idir 1 agus 128 carachtar; tosaíonn sí le litir nó digit agus níl inti ach litreacha, digití agus . _ : -.

Sampla: order-78901

allowed_origin
required
string

Bunús (https://host[:puerto], gan chonair, fiosrúchán ná blúire) an leathanaigh a osclaíonn an ghiuirléid. Ní oibríonn an ghiuirléid ach ón mbunús sin.

Sampla: https://tienda.example.com

locale
string
Value: "es"

Roghnach. Teanga na giuirléide; sa leagan seo, es amháin.

expected_mode
string
Enum: "mock" "live"

Roghnach. Mura meaitseálann sé leis an timpeallacht, is é 409 payment_mode_mismatch freagra an ghlao in ionad an íocaíocht a chruthú.

allowed_institution_codes
Array of strings <= 2500 items

Roghnach. Liosta nach bhfuil folamh de chóid bhainc uathúla (féach /payments/entities/) ar féidir leis an íocóir rogha a dhéanamh astu.

Sampla:

[
  "bbva-es",
  "santander-es"
]
logo
string or null

Roghnach. URL https poiblí do do lógó in SVG (conair a chríochnaíonn le .svg), gan dintiúir, blúire ná seoltaí príobháideacha, suas le 2048 carachtar.

Responses

Request samples

Content type
application/json
Example
{
  • "amount_minor": 1500,
  • "currency": "EUR",
  • "beneficiary": {
    },
  • "reference": "Pedido 78901",
  • "customer_reference": "order-78901",
  • "allowed_origin": "https://tienda.example.com"
}

Response samples

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

Ceistíonn sé stádas íocaíochta

Fiosrúchán freastalaí go freastalaí ar stádas íocaíochta, go dtí go bhfaightear conclúid ón mbanc. Ní deimhniú airgeadais é aisghlao, filleadh SCA ná dúnadh na giuirléide: is é payment_status: settled an t-aon deimhniú.

Cuireann Wealth Reader teorainn le fiosrúcháin sheachtracha in aghaidh na hintinne; cuir cúlú (backoff) i bhfeidhm i do chóras cúil freisin agus ná cruthaigh intinn eile fad is atá an toradh débhríoch.

Toradh débhríoch: má tharlaíonn briseadh líonra, teorainn ama nó freagra neamhaitheanta tar éis an tionscnamh a sheoladh, athraítear an intinn go reconciliation_required le payment_status: unknown, agus bíonn reconciliation sa fhreagra. Ní athdhéantar an tionscnamh go huathoibríoch riamh. Coinnigh an t-aitheantóir agus an eochair idempotachta, ná cruthaigh intinn eile agus ná húdaraigh arís, agus nuair is false é automatic_recovery, stop den cheistiú agus ardaigh an cás leis an tacaíocht le reconciliation.reference.

In íocaíochtaí Fast Track, seolann an fiosrúchán seo freisin an fógra OK/KO atá ar feitheamh chuig notification_url nuair a bhíonn stádas deiridh sroichte ag an íocaíocht.

Treoir: Stádais, ceistiú agus réiteach.

header Parameters
X-API-Key
required
string

Eochair API an cheadúnais a chruthaigh an íocaíocht.

Request Body schema: application/json
required
payment_intent_id
required
string <uuid>

An payment.id a thug create ar ais (in íocaíochtaí Fast Track, an payment_intent_id a thugann fast-track ar ais).

Sampla: 3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f

refresh
boolean
Default: true

Roghnach. Fiafraíonn true den bhanc an stádas is déanaí nuair is cuí; tugann false an stádas stóráilte ar ais.

Responses

Request samples

Content type
application/json
{
  • "payment_intent_id": "3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f",
  • "refresh": true
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "payment": {
    }
}

Liostaíonn sé bainc agus coinníollacha próifíle bainistithe

Tugann sé ar ais coinníollacha próifíle bainistithe atá cumasaithe do do chuideachta (tairbhí, cur síos, teorainneacha méide) agus na bainc ar féidir leis an íocóir rogha a dhéanamh astu. Úsáid an code roghnaithe mar institution_code in create.

header Parameters
X-API-Key
required
string

Eochair API ó cheadúnas a bhfuil an táirge PAYMENTS aige.

Request Body schema: application/json
required
profile
required
string

Cód na próifíle bainistithe.

Sampla: cruz_roja_demo

Responses

Request samples

Content type
application/json
{
  • "profile": "cruz_roja_demo"
}

Response samples

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

Liostaíonn sé na bainc atá ar fáil le haghaidh íocaíochtaí

Catalóg na mbanc ar féidir leo íocaíochtaí a thionscnamh, lena lógó agus na modhanna íocaíochta a dtacaíonn siad leo. Tá X-API-Key roghnach; má sheolann tú í, bailíochtaítear í agus áirítear mar ghlao í. Glacann sé freisin le POST leis na scagairí céanna i gcorp JSON, agus le POST /payments/?action=entities a bhfuil X-API-Key éigeantach leis.

Déantar neamhaird de scagairí anaithnide agus ní tharlaíonn earráid bhailíochtaithe riamh dá mbarr.

query Parameters
country
string
Example: country=ES

Cód tíre ISO 3166-1 alfa-2. Ciallaíonn ALL nó luach folamh nach bhfuil scagaire ann.

Sampla: ES

search
string

Téacs atá san ainm nó sa chód, gan aird ar chás na litreacha (ailias q).

code
string
Example: code=santander-es

Cód cruinn an bhainc, gan aird ar chás na litreacha.

Sampla: santander-es

payment_method
string
Enum: "sepa_credit_transfer" "instant_sepa_credit_transfer"

Na bainc a thacaíonn leis an modh íocaíochta seo amháin.

limit
integer [ 1 .. 2000 ]

Méid an leathanaigh (ó 1 go 2000).

offset
integer >= 0

Líon na dtorthaí a fhágtar ar lár.

header Parameters
X-API-Key
string

Roghnach. Má sheoltar í, bailíochtaítear í agus áirítear mar ghlao í.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "total": 1,
  • "entities": [
    ]
}

Cards (real time)

Real-time card expense synchronization from the Open Sync mobile app: per-customer employee pre-registration, signed webhooks (card_transaction.created / card_enrollment.confirmed), and REST query / backfill.

Register or rotate the real-time cards webhook

Creates or updates the webhook URL of the customer for the card_transaction.created and card_enrollment.confirmed events (see the cards-webhook-delivery schema for the delivery format and signature). On first setup, or when rotate_secret is true, a new webhook_secret (64 hex characters) is generated and returned once; in any other case webhook_secret comes back as null in the response and cannot be retrieved again. webhook_url must always be https:// and must resolve to a publicly routable host: localhost, private, loopback, link-local (including the cloud metadata address), CGNAT, multicast and reserved addresses are rejected, in any notation (hexadecimal, decimal, octal, short dotted or IPv4-mapped IPv6), and so is a hostname that does not resolve at all. The same check runs again right before every delivery, not only at registration: if the host is repointed at an internal address afterwards (DNS rebinding) the delivery is closed as failed with response_excerpt "blocked_host". Sending null in webhook_url disables webhooks for that customer; omitting the field leaves the stored URL untouched, which is how the secret is rotated without changing the URL.

Request Body schema: application/json
required
api_key
required
string

API key of the customer.

webhook_url
string or null

https:// URL that will receive the events, on a publicly routable host that resolves in DNS. null disables webhooks; omitting the field leaves the stored URL unchanged.

Sampla: https://cliente.example.com/webhooks/wealthreader-cards

rotate_secret
boolean
Default: false

When true, generates and returns a new webhook_secret.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Pre-register the email of an employee

Creates an enrollment request in pending status with a short expiry (ttl_minutes, 20 by default, between 1 and 60) for the employee to confirm by opening the mobile app and entering that email (POST /user-sync-validation/, no contract change for the app). It is idempotent: repeating the call for the same (api_key, email) while it is still pending and not expired returns the same request. If the email is already linked to the calling customer, it returns status "active" directly. If it is already linked to a different customer, it returns 409. Rate limit: at most 60 calls to this endpoint per api_key every 60 seconds, counting every attempt and not only the ones that create a row, checked before anything else so the answers that create nothing (200 already active, 409 linked to another customer, 400) cannot be walked as an enumeration oracle. Exceeding it returns 429 with code rate_limited.

Request Body schema: application/json
required
api_key
required
string

API key of the customer.

email
required
string <email>

Email of the employee to pre-register.

Sampla: empleado@cliente.com

ttl_minutes
integer [ 1 .. 60 ]
Default: 20

Minutes the request stays valid before expiring.

Responses

Request samples

Content type
application/json
{
  • "api_key": "a1b2c3d4",
  • "email": "empleado@cliente.com",
  • "ttl_minutes": 20
}

Response samples

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

Check the status of an enrollment

Read-only status of an enrollment request. It has no side effects on card users, unlike POST /user-sync-validation/, which does confirm. The only write allowed is lazily marking a pending enrollment whose expiry date has already passed as expired.

query Parameters
api_key
required
string
Example: api_key=a1b2c3d4

API key of the customer. Note it travels in the query string, so it ends up in access logs and intermediary proxies.

Sampla: a1b2c3d4

enrollment_id
required
string
Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Identifier returned by POST /cards/enrollments/.

Sampla: 0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Responses

Response samples

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

Query / backfill real-time card transactions

Returns the real-time card transactions received for the employees linked to this api_key, ordered by ascending id. Meant both for periodic backfill (poll with date_from/date_to and paginate with since_id) and for one-off queries. This is the same transaction object carried by the card_transaction.created webhook.

query Parameters
api_key
required
string
Example: api_key=a1b2c3d4

API key of the customer. Note it travels in the query string, so it ends up in access logs and intermediary proxies.

Sampla: a1b2c3d4

date_from
string <date>
Example: date_from=2026-07-01

YYYY-MM-DD, on the operation date. Default: today minus 3 days.

Sampla: 2026-07-01

date_to
string <date>
Example: date_to=2026-07-11

YYYY-MM-DD, on the operation date. Default: today.

Sampla: 2026-07-11

email
string <email>
Example: email=empleado@cliente.com

Filters by the email of the employee.

Sampla: empleado@cliente.com

since_id
integer
Example: since_id=216

Exclusive cursor on the transaction id, for pagination.

Sampla: 216

limit
integer <= 1000
Default: 500
Example: limit=500

Maximum number of transactions to return (500 by default, 1000 max).

Sampla: 500

Responses

Response samples

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