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.
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.
| 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: |
| 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: |
| 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: |
| 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: |
| 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 Sampla: |
| 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: |
| 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: |
| 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:
|
| 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:
|
| 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: |
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
[- {
- "success": true,
- "payload": {
- "user_information": {
- "ID": "12345678Z",
- "name": "LUIS GARCIA BAQUERO",
- "gender": "male",
- "birth_date": "1980-09-26",
- "birth_place": "Ibiza",
- "email": "lgarcia@gmail.com",
- "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,
- "additional_info": [
- {
- "key": "string",
- "value": "string"
}
]
}
]
}
], - "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": [
- {
- "uuid": "0ae4d722b1c82feeafb4b36b2893230444071335",
- "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": [
- {
- "uuid": "8772d6c978d37d7af83094abf380b8b703e94105",
- "date": "2022-12-01",
- "amortized": 515.43,
- "interest": 524.87,
- "total": 1040.3,
- "pending_capital": 166639.77,
- "operation_type": "receipt_paid"
}
], - "amortization_pending": [
- {
- "uuid": "e59296b79e7f80cec26679d2c65883025fd59295",
- "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
}
]
}
]
}
}
], - "insurances": [
- {
- "uuid": "0ae4d722b1c82feeafb4b36b2893230444071335",
- "code": "969032717626333",
- "coverage_category": "property",
- "name": "MyBox Hogar",
- "currency": "EUR",
- "insured_value": {
- "name": "PISO / Residencia secundaria 46023 VALENCIA",
- "value": 250000
}, - "insured_concepts": [
- {
- "description": "Fire",
- "value": 25000
}
], - "constitution_date": "2020-01-01",
- "expiration_date": "2021-01-01",
- "next_payment_date": "2020-02-01",
- "next_installment": 800,
- "frequency": "monthly",
- "status": "active",
- "linked_account": "ES4914651234561234567890",
- "owner": {
- "ID": "07133834N",
- "name": "LUIS GARCIA BAQUERO"
}, - "claims": [
- {
- "uuid": "8772d6c978d37d7af83094abf380b8b703e94105",
- "claim_code": "0122074354T2",
- "incident_date": "2023-05-13",
- "claimed_date": "2023-05-15",
- "description": "Rotura de lunas por impacto de objetos",
- "status": "in_process"
}
]
}
], - "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,
- "deferrals": [
- {
- "status": "paid",
- "overdue": true,
- "start_date": "2019-08-24",
- "due_date": "2019-08-24",
- "total_value": 0,
- "deferred_value": 0,
- "interest_value": 0,
- "interest_rate": 0,
- "late_fees": 0
}
], - "deferrals_summary": {
- "count": 0,
- "total_value": 0,
- "deferred_value": 0,
- "interest_value": 0,
- "late_fees": 0
}, - "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"
}
]
}
], - "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
}
], - "pdf_file": "string"
}, - "tax_returns": [
- {
- "uuid": "5f2b9c1e8a7d3046b1c9e2f4a6d8b0c3e5f7a9b1",
- "issuer": "AEAT",
- "model": "100",
- "fiscal_year": 2025,
- "period": "0A",
- "receipt_number": "2025100000123456",
- "secure_verification_code": "A1B2C3D4E5F6G7H8",
- "filing_date": "2026-05-20",
- "filing_type": "individual",
- "holder_id": "99999999R",
- "holder_name": "APELLIDO1 APELLIDO2, NOMBRE",
- "spouse_id": "11111111H",
- "spouse_name": "APELLIDO3 APELLIDO4, NOMBRE",
- "currency": "EUR",
- "general_taxable_base": 32450.18,
- "savings_taxable_base": 1250.4,
- "general_liquid_base": 30120.18,
- "savings_liquid_base": 1250.4,
- "state_gross_tax": 3655.27,
- "regional_gross_tax": 3540.12,
- "state_net_tax": 3480.15,
- "regional_net_tax": 3398.6,
- "resulting_tax": 6878.75,
- "withholdings_and_payments": 7378.45,
- "differential_tax": -499.7,
- "result_amount": -499.7,
- "result_type": "refundable",
- "xml_file": "string",
- "pdf_file": "string"
}
], - "credit_reports": [
- {
- "uuid": "3c1f0e7a9b2d4c6e8f0a1b3c5d7e9f1a2b4c6d8e",
- "issuer": "BDE",
- "report_type": "summary",
- "report_name": "Informe Global",
- "reference": "I2026100100000000",
- "period": "2026-08",
- "request_date": "2026-10-01",
- "issue_date": "2026-10-01",
- "available_until": "2026-10-21",
- "file_name": "Informe Agregado.pdf",
- "pdf_file": "string"
}
]
}, - "statistics": {
- "SESSION": "3463754e3540884",
- "execution_time": 0.958119869232178,
- "warnings": [
- {
- "code": 1000,
- "message": "No contracted funds",
- "product_type": "portfolios"
}
], - "operation_id": "1827C79229",
- "token": "FRJ0mHlaqZwLzu"
}
}
]Ú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.
| 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 é Sampla: |
| limit required | integer [ 1 .. 500 ] Líon na gcomharthaí in aghaidh an leathanaigh. Íosmhéid Sampla: |
| page | integer >= 1 Default: 1 Sonraigh an uimhir leathanaigh a theastaíonn uait a fháil. Tá suas le Sampla: |
| 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: |
| sort_by | string Default: "created_at" Enum: "created_at" "accesed_at" An réimse a úsáidtear chun na torthaí a shórtáil: Sampla: |
| sort_order | string Default: "DESC" Enum: "ASC" "DESC" Treo an tsórtála: Sampla: |
api_key=a1b2c3d4&method=get&limit=100&page=1
{- "success": true,
- "payload": {
- "tokens": [
- {
- "created_at": "2026-09-18 10:26:00",
- "accessed_at": "2026-09-20 08:15:42",
- "times_accesed": 12,
- "token": "FRJ0mHlaqZwLzu",
- "code": "bbva",
- "contract_name": "",
- "latest_code": 0,
- "latest_session": "3463754E3540884"
}
]
}, - "pagination": {
- "total_results": 1,
- "total_pages": 1,
- "current_page": 1
}, - "statistics": {
- "SESSION": "3463754e3540884",
- "execution_time": 0.0215
}
}Ceadaíonn an modh seo comhartha atá ann cheana a chealú chun iarratais rochtana API amach anseo a dhícheadú.
| api_key | string Aithníonn sé an cliant sa tseirbhís |
| token | string Comhartha le cealú. |
{- "success": true,
- "message": "Token successfully revoked."
}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.
| 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: |
api_key_source=a1b2c3d4e5f6g7h8i9j0&api_key_target=b2c3d4e5f6g7h8i9j0k1&token=FRJ0mHlaqZwLzu
{- "success": true,
- "message": "Token successfully reassigned."
}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/
| method required | string Method to execute. Sampla: |
| api_key required | string User's API key. |
| domain required | string Domain to add. Sampla: |
| url_callback required | string URL for callback. Sampla: |
| tokenize required | string Enum: "1" "0" Rialaíonn sé an gcuireann an widget sreabhadh comharthaithe ar siúl:
Sampla: |
method=add&api_key=a1b2c3d4e5f6g7h8i9j0&domain=https%3A%2F%2Fwww.cliente.com&url_callback=https%3A%2F%2Fwww.cliente.com%2Fwebhooks%2Fwealthreader&tokenize=1
{- "success": true,
- "message": "string"
}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.
| lang | string Default: "es" Enum: "es" "en" Response language |
[- [
- {
- "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\"."
}
]
]Liosta de chóid rabhaidh.
| lang | string Default: "es" Enum: "es" "en" Response language |
[- [
- {
- "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\"."
}
]
]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 agus an fhaisnéis a theastaíonn chun foirm logáil isteach na heintite a tharraingt.
| 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. |
[- {
- "code": "bancamarch",
- "name": "Bancamarch",
- "color": "#e23e4d",
- "inputs": {
- "document_type": {
- "required": false,
- "name": "DNI;Pasaporte"
}, - "user": {
- "required": true,
- "name": "Username"
}, - "password": {
- "required": true,
- "name": "Access key"
}
}, - "statistics": {
- "SESSION": "3463754e3540884",
- "execution_time": 0.958119869232178,
- "warnings": [
- {
- "code": 1000,
- "message": "No contracted funds",
- "product_type": "portfolios"
}
], - "operation_id": "1827C79229",
- "token": "FRJ0mHlaqZwLzu"
}
}
]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.
| api_key required | string Authentication key (8 alphanumeric characters) |
| user_id required | string User identification document. Sampla: |
| service required | string Enum: "integra" "easy-transfer" Service associated with the user. Determines the data flow. Sampla: |
| email required | string <email> User email, used according to service type. Sampla: |
{- "success": true,
- "message": "User registered successfully"
}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.
| api_key required | string Authentication key |
| user_id required | string User identification document. Sampla: |
{- "success": true,
- "registered": true,
- "user_id": "12345",
- "links": {
}
}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.
| api_key required | string Authentication key (8 alphanumeric characters) |
| user_id required | string User identification document. Sampla: |
| service required | string Enum: "integra" "easy-transfer" "all" Service from which to unregister the user. 'all' for all services. Sampla: |
{- "success": true,
- "message": "User unregistered successfully"
}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.
| 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: |
required | Array of objects (batch-connection) non-empty List of connections to process |
{- "api_key": "a1b2c3d4e5f6g7h8i9j0",
- "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"
}
]
}{- "success": true,
- "batch_id": "batch_20250120_a1b2c3d4",
- "total_connections": 5,
- "estimated_completion_time": "2025-01-20T10:45:00Z"
}{- "batch_id": 10863151,
- "credential_id": "cred_demo_002",
- "status": "completed",
- "timestamp": "2026-05-13T08:02:47+00:00"
}Tá an críochphointe seo roghnach. Faigheann sé staitisticí ginearálta faoi thoradh próiseála na nasc go léir i mbaisc.
| api_key required | string Identifies the client in the service |
| batch_id required | string Batch ID |
{- "api_key": "string",
- "batch_id": "string"
}{- "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
}
}Tá an críochphointe seo roghnach. Faigheann sé toradh naisc shonrach ón mbaisc.
| 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 |
{- "api_key": "string",
- "batch_id": "string",
- "credential_id": "string"
}{- "success": true,
- "payload": {
- "user_information": {
- "ID": "12345678Z",
- "name": "LUIS GARCIA BAQUERO",
- "gender": "male",
- "birth_date": "1980-09-26",
- "birth_place": "Ibiza",
- "email": "lgarcia@gmail.com",
- "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,
- "additional_info": [
- {
- "key": "string",
- "value": "string"
}
]
}
]
}
], - "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": [
- {
- "uuid": "0ae4d722b1c82feeafb4b36b2893230444071335",
- "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": [
- {
- "uuid": "8772d6c978d37d7af83094abf380b8b703e94105",
- "date": "2022-12-01",
- "amortized": 515.43,
- "interest": 524.87,
- "total": 1040.3,
- "pending_capital": 166639.77,
- "operation_type": "receipt_paid"
}
], - "amortization_pending": [
- {
- "uuid": "e59296b79e7f80cec26679d2c65883025fd59295",
- "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"
}
]
}
]
}
}
], - "insurances": [
- {
- "uuid": "0ae4d722b1c82feeafb4b36b2893230444071335",
- "code": "969032717626333",
- "coverage_category": "property",
- "name": "MyBox Hogar",
- "currency": "EUR",
- "insured_value": {
- "name": "PISO / Residencia secundaria 46023 VALENCIA",
- "value": 250000
}, - "insured_concepts": [
- {
- "description": "Fire",
- "value": 25000
}
], - "constitution_date": "2020-01-01",
- "expiration_date": "2021-01-01",
- "next_payment_date": "2020-02-01",
- "next_installment": 800,
- "frequency": "monthly",
- "status": "active",
- "linked_account": "ES4914651234561234567890",
- "owner": {
- "ID": "07133834N",
- "name": "LUIS GARCIA BAQUERO"
}, - "claims": [
- {
- "uuid": "8772d6c978d37d7af83094abf380b8b703e94105",
- "claim_code": "0122074354T2",
- "incident_date": "2023-05-13",
- "claimed_date": "2023-05-15",
- "description": "Rotura de lunas por impacto de objetos",
- "status": "in_process"
}
]
}
], - "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,
- "deferrals": [
- {
- "status": "paid",
- "overdue": true,
- "start_date": "2019-08-24",
- "due_date": "2019-08-24",
- "total_value": 0,
- "deferred_value": 0,
- "interest_value": 0,
- "interest_rate": 0,
- "late_fees": 0
}
], - "deferrals_summary": {
- "count": 0,
- "total_value": 0,
- "deferred_value": 0,
- "interest_value": 0,
- "late_fees": 0
}, - "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"
}
]
}
], - "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
}
], - "pdf_file": "string"
}, - "tax_returns": [
- {
- "uuid": "5f2b9c1e8a7d3046b1c9e2f4a6d8b0c3e5f7a9b1",
- "issuer": "AEAT",
- "model": "100",
- "fiscal_year": 2025,
- "period": "0A",
- "receipt_number": "2025100000123456",
- "secure_verification_code": "A1B2C3D4E5F6G7H8",
- "filing_date": "2026-05-20",
- "filing_type": "individual",
- "holder_id": "99999999R",
- "holder_name": "APELLIDO1 APELLIDO2, NOMBRE",
- "spouse_id": "11111111H",
- "spouse_name": "APELLIDO3 APELLIDO4, NOMBRE",
- "currency": "EUR",
- "general_taxable_base": 32450.18,
- "savings_taxable_base": 1250.4,
- "general_liquid_base": 30120.18,
- "savings_liquid_base": 1250.4,
- "state_gross_tax": 3655.27,
- "regional_gross_tax": 3540.12,
- "state_net_tax": 3480.15,
- "regional_net_tax": 3398.6,
- "resulting_tax": 6878.75,
- "withholdings_and_payments": 7378.45,
- "differential_tax": -499.7,
- "result_amount": -499.7,
- "result_type": "refundable",
- "xml_file": "string",
- "pdf_file": "string"
}
], - "credit_reports": [
- {
- "uuid": "3c1f0e7a9b2d4c6e8f0a1b3c5d7e9f1a2b4c6d8e",
- "issuer": "BDE",
- "report_type": "summary",
- "report_name": "Informe Global",
- "reference": "I2026100100000000",
- "period": "2026-08",
- "request_date": "2026-10-01",
- "issue_date": "2026-10-01",
- "available_until": "2026-10-21",
- "file_name": "Informe Agregado.pdf",
- "pdf_file": "string"
}
]
}, - "statistics": {
- "SESSION": "3463754e3540884",
- "execution_time": 0.958119869232178,
- "warnings": [
- {
- "code": 1000,
- "message": "No contracted funds",
- "product_type": "portfolios"
}
], - "operation_id": "1827C79229",
- "token": "FRJ0mHlaqZwLzu"
}
}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.
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
MY_BANK_MATCH aige agus cuóta ar fáil.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.
| 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: |
| 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: |
api_key=a1b2c3d4&iban=ES9321005707250200257112&name=Wealthreader%20S.L.
{- "success": true,
- "payload": {
- "result": "MATCH"
}, - "statistics": {
- "SESSION": "0123456789abcdef",
- "execution_time": 0.42,
- "warnings": [ ]
}
}Íocaíochtaí SEPA ó chuntas go cuntas a thionscnaítear ó bhanc an íocóra. Is féidir iad a chomhtháthú ar dhá bhealach:
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.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=...
POST leis an gceanntásc Content-Type: application/json agus réad JSON mar chorp (32768 beart ar a mhéad).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.422 invalid_request an freagra.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. |
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.
ok é outcome ach amháin má tá an íocaíocht socraithe ag an mbanc (settled); seoltar ko do rejected, cancelled, expired agus failed.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.2xx chun é a mheas mar sheachadta. Ní leanann Wealth Reader atreoruithe agus fanann sé 3 soicind ar a mhéad.customer_reference móide outcome mar idempotach.status ag úsáid do X-API-Key agus payment_intent_id an fhógra.| User-Agent required | string Value: "WealthReader-Payments" |
| outcome required | string Enum: "ok" "ko"
|
| payment_status required | string Enum: "settled" "rejected" "cancelled" "expired" "failed" Toradh airgeadais deiridh. |
| customer_reference required | string An |
| payment_intent_id required | string <uuid> An t-aitheantóir a thug |
{- "outcome": "ok",
- "payment_status": "settled",
- "customer_reference": "11111111-1111-4111-8111-111111111111",
- "payment_intent_id": "3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f"
}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.
| 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 |
| amount required | string Méid in aonaid mhóra, mar theaghrán JSON. Is ionann Sampla: |
| currency required | string Value: "EUR" Airgeadra ISO 4217. Sa leagan seo, Sampla: |
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: |
| priority required | string Enum: "normal" "instant"
Sampla: |
| notification_url required | string <= 2000 characters URL Sampla: |
| logo | string <= 2048 characters Roghnach. URL Sampla: |
{- "amount": "15.50",
- "currency": "EUR",
- "beneficiary": {
- "name": "Comercio Online S.L.",
- "iban": "ES9121000418450200051332"
}, - "reference": "Pedido 78901",
- "priority": "normal",
}{- "payment_intent_id": "3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f"
}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:
amount_minor, currency, beneficiary, reference, customer_reference agus allowed_origin.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.
| 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. |
| amount_minor required | integer >= 1 Méid in aonaid bheaga (ceintí) mar shlánuimhir JSON. Is ionann Sampla: |
| 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: |
| 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: |
| allowed_origin required | string Bunús ( Sampla: |
| locale | string Value: "es" Roghnach. Teanga na giuirléide; sa leagan seo, |
| expected_mode | string Enum: "mock" "live" Roghnach. Mura meaitseálann sé leis an timpeallacht, is é |
| allowed_institution_codes | Array of strings <= 2500 items Roghnach. Liosta nach bhfuil folamh de chóid bhainc uathúla (féach Sampla:
|
| logo | string or null Roghnach. URL |
{- "amount_minor": 1500,
- "currency": "EUR",
- "beneficiary": {
- "name": "Comercio Online S.L.",
- "iban": "ES9121000418450200051332"
}, - "reference": "Pedido 78901",
- "customer_reference": "order-78901",
}{- "success": true,
- "payment": {
- "id": "3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f",
- "state": "ready",
- "payment_status": "not_initiated",
- "idempotent_replay": true,
- "widget": {
- "token": "wrp_w_…",
- "expires_at": "2026-11-08T10:15:00+00:00"
}
}
}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.
| X-API-Key required | string Eochair API an cheadúnais a chruthaigh an íocaíocht. |
| payment_intent_id required | string <uuid> An Sampla: |
| refresh | boolean Default: true Roghnach. Fiafraíonn |
{- "payment_intent_id": "3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f",
- "refresh": true
}{- "success": true,
- "payment": {
- "id": "3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f",
- "amount_minor": 1500,
- "currency": "EUR",
- "beneficiary": {
- "name": "Comercio Online S.L.",
- "iban_masked": "ES91••••••••••••••••1332"
}, - "reference": "Pedido 78901",
- "payment_attestation": {
- "mode": "live",
- "provider_binding": "…",
- "allowed_institution_codes": null,
- "profile": null,
- "profile_version": null
}, - "state": "settled",
- "interaction_status": "finished",
- "payment_status": "settled",
- "reconciliation_required": false,
- "expires_at": "2026-11-08T10:30:00+00:00",
- "updated_at": "2026-11-08T10:04:12+00:00"
}
}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.
| X-API-Key required | string Eochair API ó cheadúnas a bhfuil an táirge PAYMENTS aige. |
| profile required | string Cód na próifíle bainistithe. Sampla: |
{- "profile": "cruz_roja_demo"
}{- "success": true,
- "profile": {
- "code": "cruz_roja_demo",
- "version": "2026-09-04",
- "currency": "EUR",
- "min_amount_minor": 1,
- "max_amount_minor": 100,
- "reference": "Donativo desde la demo de Wealthreader.com",
- "beneficiary_name": "Cruz Roja Española",
- "payment_attestation": {
- "mode": "live",
- "provider_binding": "…"
}, - "institutions": [
- {
- "code": "santander-es",
- "name": "Banco Santander",
- "country": "ES",
- "requires_debtor_iban": false,
}
]
}
}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.
| country | string Example: country=ES Cód tíre ISO 3166-1 alfa-2. Ciallaíonn Sampla: |
| search | string Téacs atá san ainm nó sa chód, gan aird ar chás na litreacha (ailias |
| code | string Example: code=santander-es Cód cruinn an bhainc, gan aird ar chás na litreacha. Sampla: |
| 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. |
| X-API-Key | string Roghnach. Má sheoltar í, bailíochtaítear í agus áirítear mar ghlao í. |
{- "success": true,
- "total": 1,
- "entities": [
- {
- "code": "santander-es",
- "name": "Banco Santander",
- "country": "ES",
- "logo_fallback": null,
- "logo_source": "wealthreader",
- "payment_methods": [
- "sepa_credit_transfer",
- "instant_sepa_credit_transfer"
], - "requires_debtor_iban": false
}
]
}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.
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.
| 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: |
| rotate_secret | boolean Default: false When true, generates and returns a new webhook_secret. |
{- "api_key": "a1b2c3d4",
- "rotate_secret": false
}{- "success": true,
- "payload": {
- "webhook_secret": "9f1c2b3a4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8",
- "active": true
}
}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.
| api_key required | string API key of the customer. |
| email required | string <email> Email of the employee to pre-register. Sampla: |
| ttl_minutes | integer [ 1 .. 60 ] Default: 20 Minutes the request stays valid before expiring. |
{- "api_key": "a1b2c3d4",
- "email": "empleado@cliente.com",
- "ttl_minutes": 20
}{- "success": true,
- "payload": {
- "enrollment_id": "0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c",
- "status": "pending",
- "email": "empleado@cliente.com",
- "expires_at": "2026-07-11T14:22:11+02:00",
- "confirmed_at": null,
- "user_id": null
}
}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.
| 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: |
| enrollment_id required | string Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c Identifier returned by POST /cards/enrollments/. Sampla: |
{- "success": true,
- "payload": {
- "enrollment_id": "0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c",
- "status": "active",
- "email": "empleado@cliente.com",
- "expires_at": "2026-07-11T14:22:11+02:00",
- "confirmed_at": "2026-07-11T14:10:03+02:00",
- "user_id": "e9f4c2a1b3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7"
}
}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.
| 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: |
| date_from | string <date> Example: date_from=2026-07-01 YYYY-MM-DD, on the operation date. Default: today minus 3 days. Sampla: |
| date_to | string <date> Example: date_to=2026-07-11 YYYY-MM-DD, on the operation date. Default: today. Sampla: |
string <email> Example: email=empleado@cliente.com Filters by the email of the employee. Sampla: | |
| since_id | integer Example: since_id=216 Exclusive cursor on the transaction id, for pagination. Sampla: |
| limit | integer <= 1000 Default: 500 Example: limit=500 Maximum number of transactions to return (500 by default, 1000 max). Sampla: |
{- "success": true,
- "payload": {
- "transactions": [
- {
- "id": 217,
- "payment_id": "550e8400-e29b-41d4-a716-446655440000",
- "user_id": "e9f4c2a1b3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7",
- "email": "empleado@cliente.com",
- "card_last4": "1234",
- "entity_code": "bbva",
- "operation_date": "2026-07-11",
- "value_date": "2026-07-11",
- "amount": -57.6,
- "currency": null,
- "description": "SAKE RESTAURANTE",
- "merchant": "SAKE RESTAURANTE",
- "category": "Other",
- "gps": {
- "lat": 39.4661559,
- "lon": -0.3679207
}, - "received_at": "2026-07-11T14:02:11+02:00"
}
], - "next_since_id": null
}
}