Download OpenAPI specification:
Op PSD2 gebaseerde regulatorische APIs bieden toegang tot bepaalde financiële informatie zoals banksaldos en transacties. Er zijn echter andere bronnen van vermogensinformatie die niet toegankelijk zijn via deze APIs. De Wealth Reader API breidt de door regulatorische APIs aangeboden informatie uit door realtime toegang te bieden tot extra vermogensbronnen in elke entiteit wereldwijd. Er zijn twee andere gerelateerde documenten die u zullen helpen bij het integreren van de Wealth Reader API. Eén is de Javascript widget integratiegids: https://docs-en.wealthreader.com/ en de ander is een Postman collectie gebaseerd op deze documentatie. Zeer belangrijk: Deze API-definitie is aangepast voor klanten die via Widget integreren, dus sommige parameters die niet nodig zijn voor dit type integratie zijn weggelaten, zoals bankauthenticatieparameters, aangezien een token zal worden gebruikt.
Haalt financiële activa en details van hun samenstelling op, inclusief beleggingsportefeuilles samengesteld uit aandelen of fondsen, creditcards, verzekeringen en leningen. Bevat eigendomsinformatie voor elk actief en unieke identificatoren die gegevensverwerking vergemakkelijken. Het is mogelijk om Mock-gegevens te verkrijgen. Controleer bij het technische team hoe dit te doen.
| api_key | string Identificeert de klant in de dienst |
| code | string Naam van de entiteit. De volledige lijst is beschikbaar met GET Voorbeeld: |
| token | string Identificeert de bewaarde inloggegevens. De flow waarmee het token is verkregen staat beschreven in het document 'Widget Integratiegids'. De volgende Mock-gebruikers zijn beschikbaar: MOCKDATA, OK-antwoord; MOCKOTP, antwoord met OTP-uitdaging; MOCKLOGINKO, antwoord met login-fout Voorbeeld: |
| product_types | string Enum: "accounts" "portfolios" "cards" "receipts" "loans" "factoring" "confirming" "properties" "invoices" "files" "deposits" "leases" "insurances" Lijst van producttypen waarvan informatie moet worden opgehaald. Accepteert meerdere waarden gescheiden door komma's. Voorbeeld: |
| only_balances | boolean Default: false Geeft aan of alleen de saldi van de producten moeten worden opgehaald in plaats van alle beschikbare informatie. Standaardwaarde: false. Voorbeeld: |
| fetch_transaction_details | boolean Default: false Geeft aan of uitgebreide transactiegegevens moeten worden opgehaald wanneer de connector van de entiteit dit ondersteunt. BELANGRIJK: Het inschakelen ervan houdt in dat er een of meer extra navigaties per transactie worden uitgevoerd om de geretourneerde informatie te verrijken. Dit zal de uitvoeringstijd onvermijdelijk en aanzienlijk verhogen. Het aantal extra navigaties groeit met het volume aan transacties. Het wordt aanbevolen dit alleen in te schakelen wanneer u zeker weet dat een hoger detailniveau dan standaard wordt geretourneerd vereist is. De opgehaalde gegevens worden ingevoegd in de sleutel Voorbeeld: |
| date_from | string <date> Datum vanaf wanneer transacties worden opgevraagd, in JJJJ-MM-DD formaat. Moet een datum voor vandaag zijn. Voorbeeld: |
| date_to | string <date> Dit geldt alleen voor beperking op toekomstige datums voor producten loan en confirming, in JJJJ-MM-DD formaat. De datum moet later zijn dan vandaag Voorbeeld: |
| required_products_schema | string Schema van vereiste producten. Geeft de rekeningen of kaarten aan waarvan gegevens gewenst zijn, met aanvullende configuraties. Voorbeeld:
|
| add_pdf_from_uuids | string Accepteert transactie-uuid's gescheiden door komma's. Parameter die alleen in aanmerking wordt genomen als product_types ALL is of accounts bevat. Voegt het PDF-document toe dat bij elk van de gevraagde banktransacties hoort. Voorbeeld:
|
| otp_method | string Selecteert welk tweefactorleveringskanaal te gebruiken wanneer de API foutcode 2017 of 20171 retourneerde (meerdere OTP-methoden). Roep opnieuw aan met dezelfde sessie-ID als die reactie en zet otp_method op de exacte string in het otp_method-veld van een object in statistics.otpMethods — niet de array-index. Weglaten bij eerste credential-verzoek; meesturen na keuze van de gebruiker. Het voorbeeld hieronder is ter illustratie; kopieer altijd de string uit statistics.otpMethods voor uw entiteit. Voorbeeld: |
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"
}
}
]Gebruik deze methode om de tokens op te vragen die gekoppeld zijn aan een specifieke api_key. De resultaten zijn gepagineerd: limit bepaalt het aantal tokens per pagina (maximaal 500) en page kiest de pagina die wordt geretourneerd. api_key, method en limit zijn verplicht; als een ervan ontbreekt of ongeldig is, antwoordt de API met HTTP 400 en foutcode 2.
| api_key required | string^[a-z0-9]{8}$ api_key om de klant in de dienst te identificeren |
| method required | string Value: "get" Uit te voeren bewerking. De enige ondersteunde waarde is Voorbeeld: |
| limit required | integer [ 1 .. 500 ] Aantal tokens per pagina. Minimaal Voorbeeld: |
| page | integer >= 1 Default: 1 Specificeer het paginanummer dat u wilt ophalen. Elke pagina bevat maximaal Voorbeeld: |
| code | string Entiteitscode om de tokens op te filteren. Indien weggelaten, worden de tokens van alle entiteiten geretourneerd. Voorbeeld: |
| sort_by | string Default: "created_at" Enum: "created_at" "accesed_at" Veld waarop de resultaten worden gesorteerd: Voorbeeld: |
| sort_order | string Default: "DESC" Enum: "ASC" "DESC" Sorteervolgorde: Voorbeeld: |
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
}
}Met deze methode kunt u een bestaand token intrekken om toekomstige API-toegangsverzoeken te deautoriseren.
| api_key | string Identificeert de klant in de dienst |
| token | string Token dat moet worden ingetrokken. |
{- "success": true,
- "message": "Token successfully revoked."
}Met deze methode kunt u een token van de ene api_key naar een andere toewijzen. Beide api_keys moeten actief zijn en bij hetzelfde bedrijf horen, en het token moet bij api_key_source horen.
| api_key_source | string api_key waarvan het token opnieuw moet worden toegewezen. |
| api_key_target | string api_key waaraan het token opnieuw moet worden toegewezen. |
| token | string Token dat opnieuw moet worden toegewezen. Voorbeeld: |
api_key_source=a1b2c3d4e5f6g7h8i9j0&api_key_target=b2c3d4e5f6g7h8i9j0k1&token=FRJ0mHlaqZwLzu
{- "success": true,
- "message": "Token successfully reassigned."
}Voegt de associatie toe tussen het domein dat de widget zal hosten en de bestemmings-webhook. Om uw domeinen te bewerken of te testen, gebruikt u https://www.wealthreader.com/clients/
| method required | string Method to execute. Voorbeeld: |
| api_key required | string User's API key. |
| domain required | string Domain to add. Voorbeeld: |
| url_callback required | string URL for callback. Voorbeeld: |
| tokenize required | string Enum: "1" "0" Bepaalt of de widget een tokenisatiestroom start:
Voorbeeld: |
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"
}Lijst van foutcodes. Let er speciaal op dat niet alle foutcodes dezelfde behandeling van uw applicatie moeten krijgen. Bij een onjuist wachtwoordfout moet u de oproep niet opnieuw proberen met dezelfde parameters, maar bij een fout die aangeeft dat de entiteit in onderhoud is, kunt u het opnieuw proberen. Vraag een technische sessie aan met ons team om vragen over foutbeheer op te lossen.
| 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\"."
}
]
]Lijst van waarschuwingscodes.
| 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\"."
}
]
]Optionele eindpunten niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader.
Haalt de lijst van ondersteunde entiteiten op en de informatie die nodig is om het inlogformulier van de entiteit te tekenen.
| 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"
}
}
]Dit endpoint is optioneel en niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader. Dit endpoint maakt het mogelijk een gebruiker te registreren op het portfolio-overdrachtsplatform Easytransfer of op de rapportagetool Acumulas, gebaseerd op een unieke identificatie.
| api_key required | string Authentication key (8 alphanumeric characters) |
| user_id required | string User identification document. Voorbeeld: |
| service required | string Enum: "integra" "easy-transfer" Service associated with the user. Determines the data flow. Voorbeeld: |
| email required | string <email> User email, used according to service type. Voorbeeld: |
{- "success": true,
- "message": "User registered successfully"
}Dit endpoint is optioneel en niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader. Controleert of een gebruiker is geregistreerd in het Easytransfer- of Acumulas-systeem en retourneert de unieke toegangslink voor de gebruiker.
| api_key required | string Authentication key |
| user_id required | string User identification document. Voorbeeld: |
{- "success": true,
- "registered": true,
- "user_id": "12345",
- "links": {
}
}Dit endpoint is optioneel en niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader. Dit endpoint maakt het mogelijk een gebruiker uit te schrijven van de Easytransfer- of Acumulas-platformservice.
| api_key required | string Authentication key (8 alphanumeric characters) |
| user_id required | string User identification document. Voorbeeld: |
| service required | string Enum: "integra" "easy-transfer" "all" Service from which to unregister the user. 'all' for all services. Voorbeeld: |
{- "success": true,
- "message": "User unregistered successfully"
}Dit endpoint is optioneel en niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader.
Belangrijk: Om batchprocesbeheer aan de Wealthreader-kant te gebruiken, is een dedicated omgeving vereist. Dit endpoint is niet beschikbaar op api.wealthreader.com.
De endpoints gegroepeerd onder de "batch" tag maken het mogelijk meerdere bankverbindingen asynchroon te verwerken, in tegenstelling tot de synchrone /entities/ methode. Ideaal voor grote volumes verbindingen en het vermijden van timeouts.
| 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. Voorbeeld: |
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"
}Dit endpoint is optioneel. Haalt algemene statistieken op over het verwerkingsresultaat van alle verbindingen in een batch.
| 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
}
}Dit endpoint is optioneel. Haalt het resultaat van een specifieke verbinding uit de batch op.
| 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"
}
}Verificatie van rekeninghouderschap: controleer of een IBAN toebehoort aan een rekeninghouder via de SEPA-Verificatie van de Begunstigde (VoP) van de bank die aan uw licentie is gekoppeld. Stapsgewijze handleiding: MyBankMatch.
Controleert of een IBAN toebehoort aan de opgegeven rekeninghouder via de SEPA-Verificatie van de Begunstigde (VoP) van uw eigen bank, gekoppeld aan uw WealthReader-licentie. Retourneert het oordeel van de bank: dit wordt niet vervangen door een lokale berekening van naamsovereenkomst, en er wordt geen betaalopdracht aangemaakt, geautoriseerd of uitgevoerd.
Vóór de eerste aanroep
MY_BANK_MATCH en beschikbaar quotum.api_key gekoppeld; het banktoken wordt niet aan de browser doorgegeven en is geen parameter van de aanvraag.Aanvraag: body gecodeerd als formulier (application/x-www-form-urlencoded) met api_key, iban en name, net als bij /entities/. Er wordt geen JSON verzonden en de header X-API-Key wordt niet gebruikt. Bewaar de api_key in uw backend.
Antwoord: HTTP 200 geeft aan dat er een resultaat van het product is verkregen, niet dat de naam overeenkomt. Controleer success en vervolgens payload.result:
payload.result |
Betekenis | Aanvullende velden | Factureerbaar |
|---|---|---|---|
MATCH |
De bank beschouwt de naam als overeenkomend met de rekeninghouder. | Geen. | Ja, 0,10 EUR. |
PARTIAL_MATCH |
De bank retourneert een gedeeltelijke overeenkomst (CLOSE_MATCH). |
suggested_name. |
Ja, 0,10 EUR. |
NO_MATCH |
De bank geeft aan dat de naam niet overeenkomt. | Geen. | Ja, 0,10 EUR. |
NOT_CONFIGURED |
Aan de licentie is nog geen bank gekoppeld. | setup_url. |
Nee. |
REAUTH_REQUIRED |
De koppeling met de bank vereist een nieuwe authenticatie. | setup_url, reason_code. |
Nee. |
NOT_POSSIBLE |
Er kon geen bruikbaar oordeel worden verkregen. Dit staat niet gelijk aan NO_MATCH. |
reason. |
Nee. |
Alleen MATCH, PARTIAL_MATCH en NO_MATCH verbruiken quotum. Invoerfouten en niet-conclusieve resultaten worden niet gefactureerd.
Er is geen idempotentiesleutel en geen gratis nieuwe poging. Als u het antwoord verliest (time-out, netwerk of een niet-interpreteerbare body), kunnen het resultaat en het bijbehorende quotumverbruik onbekend zijn voor uw applicatie. Verzend dezelfde aanvraag niet automatisch opnieuw: bekijk de geschiedenis in Klanten en neem contact op met support onder vermelding van statistics.SESSION.
Volledige handleiding: MyBankMatch.
| api_key required | string Sleutel van 8 hexadecimale tekens van een actieve licentie met het product MY_BANK_MATCH en beschikbaar quotum. Bewaar deze in uw backend. |
| iban required | string IBAN van een SEPA-land. Spaties worden verwijderd, de waarde wordt omgezet naar hoofdletters en de lengte voor het land en de controlecijfers mod-97 worden gevalideerd. Voorbeeld: |
| name required | string <= 140 characters Naam van de rekeninghouder. Niet leeg, geldige UTF-8, zonder controletekens en maximaal 140 tekens. Wordt bijgesneden en interne spaties worden samengevoegd. Voorbeeld: |
api_key=a1b2c3d4&iban=ES9321005707250200257112&name=Wealthreader%20S.L.
{- "success": true,
- "payload": {
- "result": "MATCH"
}, - "statistics": {
- "SESSION": "0123456789abcdef",
- "execution_time": 0.42,
- "warnings": [ ]
}
}SEPA-betalingen van rekening naar rekening, geïnitieerd vanuit de bank van de betaler. Er zijn twee manieren om ze te integreren:
POST /payments/?action=fast-track retourneert de betalings-URL en Wealth Reader informeert uw notification_url met OK of KO. Zie Fast Track-betalingen.POST /payments/?action=create een onveranderlijke betalingsintentie aan, opent de widget met het geretourneerde token en bevestigt het resultaat met POST /payments/?action=status. Zie Inleiding tot betalingen en Statussen, polling en reconciliatie.Gemeenschappelijke regels voor alle aanroepen van /payments/?action=...
POST met de header Content-Type: application/json en een JSON-object als body (maximaal 32768 bytes).X-API-Key (wr_live_ gevolgd door 72 letters of cijfers) van een actieve licentie met het product PAYMENTS. Deze wordt nooit in de body verzonden. Elke geauthenticeerde aanroep telt mee voor de aanroeplimiet van de licentie.422 invalid_request.payment_status: settled. Een widgetgebeurtenis, een SCA-terugkeer of interaction_status: completed betekent nooit dat de betaling is afgewikkeld.Foutformaat: application/json (geen problem+json) met een stabiele error.code; error.message is informatief en kan wijzigen.
{"success": false, "error": {"code": "invalid_request", "message": "The request body has an invalid schema."}}
| HTTP | error.code |
Reden |
|---|---|---|
| 400 | invalid_json |
Lege of ongeldige body, of geen JSON-object. |
| 401 | invalid_api_key |
X-API-Key ontbreekt, is onjuist opgemaakt, onbekend of inactief. |
| 403 | payments_not_allowed |
De licentie heeft het product PAYMENTS niet. |
| 404 | action_not_found |
Onbekende action. |
| 405 | method_not_allowed |
Andere methode dan POST. |
| 413 | request_too_large |
Body groter dan 32768 bytes. |
| 415 | json_required |
Andere Content-Type dan application/json. |
| 422 | invalid_request |
Ontbrekende of onverwachte velden. |
| 429 | api_limit_reached |
De aanroeplimiet van de licentie is bereikt. |
| 500 | internal_error |
Onverwachte fout. |
| 503 | payments_disabled, payments_accept_new_disabled, payment_storage_unavailable, payment_state_unavailable |
Dienst tijdelijk niet beschikbaar of nieuwe betalingen gepauzeerd. |
Wealth Reader verzendt deze POST naar de notification_url van een Fast Track-betaling wanneer het de status van de betaling controleert en vaststelt dat deze een eindstatus heeft. reconciliation_required is geen eindstatus en wordt niet gemeld: bevestig deze met status.
outcome is alleen ok als de bank de betaling heeft afgewikkeld (settled); rejected, cancelled, expired en failed worden gemeld als ko.status aanroept. Er is geen afzonderlijke geplande verzending: als de betaler vertrekt voordat de bank tot een conclusie komt, of uw server niet met 2xx antwoordt, wordt de melding bij de volgende controle verzonden. Als deze enkele minuten na het doorsturen van de betaler nog niet is binnengekomen, roep dan status aan met de payment_intent_id; die aanroep activeert ook de openstaande melding.2xx om de melding als afgeleverd te beschouwen. Wealth Reader volgt geen omleidingen en wacht maximaal 3 seconden.customer_reference plus outcome als idempotent.status met uw X-API-Key en de payment_intent_id uit de melding voordat u een waardevol goed levert.| User-Agent required | string Value: "WealthReader-Payments" |
| outcome required | string Enum: "ok" "ko"
|
| payment_status required | string Enum: "settled" "rejected" "cancelled" "expired" "failed" Definitief financieel resultaat. |
| customer_reference required | string De |
| payment_intent_id required | string <uuid> Identificatie die |
{- "outcome": "ok",
- "payment_status": "settled",
- "customer_reference": "11111111-1111-4111-8111-111111111111",
- "payment_intent_id": "3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f"
}Eén enkele aanroep die de betalings-URL retourneert. De betaler opent deze en autoriseert de betaling bij zijn bank; wanneer de betaling een eindstatus bereikt, informeert Wealth Reader uw notification_url met OK of KO (zie de webhook notification_url). Op de achtergrond wordt dezelfde onveranderlijke intentie aangemaakt als met create: bedrag, begunstigde en omschrijving liggen vast voordat ze de browser bereiken.
De header Idempotency-Key is tevens uw handelaarsreferentie (customer_reference in de melding): deze wordt niet in de body verzonden. Als u dezelfde sleutel herhaalt met dezelfde body, ontvangt u dezelfde URL; als u deze hergebruikt met andere gegevens (ook met een ander logo), is het antwoord 409 idempotency_conflict.
Voor een instantoverboeking geldt in deze API geen eigen limiet: de bank weigert een overboeking die zij niet kan accepteren, ook op basis van het bedrag, en die weigering komt binnen als KO.
| X-API-Key required | string API-sleutel van een licentie met het product PAYMENTS. Bewaar deze in uw backend. |
| Idempotency-Key required | string [ 16 .. 128 ] characters Van 16 tot 128 tekens; moet beginnen met een letter of cijfer en mag alleen letters, cijfers en |
| amount required | string Bedrag in hoofdeenheden, als JSON-string. Voorbeeld: |
| currency required | string Value: "EUR" ISO 4217-valuta. In deze versie alleen Voorbeeld: |
required | object (payments-beneficiary) Ontvanger van de overboeking. Kan niet worden gewijzigd nadat de betaling is aangemaakt. |
| reference required | string [ 1 .. 140 ] characters Omschrijving op het rekeningafschrift, maximaal 140 tekens. Voorbeeld: |
| priority required | string Enum: "normal" "instant"
Voorbeeld: |
| notification_url required | string <= 2000 characters Openbare Voorbeeld: |
| logo | string <= 2048 characters Optioneel. Openbare Voorbeeld: |
{- "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"
}Maakt een onveranderlijke betalingsintentie aan en retourneert een kortlevend token om de widget in de browser van de betaler te openen. Bedrag, begunstigde en omschrijving worden in de backend vastgelegd en kunnen niet vanuit de browser worden gewijzigd. Bevestig na het sluiten van de widget het resultaat vanuit uw backend met status.
Er zijn twee varianten van de body:
amount_minor, currency, beneficiary, reference, customer_reference en allowed_origin vast.cruz_roja_demo): Wealth Reader legt begunstigde, omschrijving en limieten vast; u verzendt profile, institution_code, amount_minor, customer_reference en allowed_origin. Haal de banken op met profile-institutions.Als u dezelfde Idempotency-Key herhaalt met dezelfde body, ontvangt u dezelfde intentie (200, idempotent_replay: true); als u deze hergebruikt met andere gegevens, is het antwoord 409 idempotency_conflict. De sleutel is specifiek voor uw onderneming.
Handleiding: Intenties en idempotentie en Integratie met de widget.
| X-API-Key required | string API-sleutel van een licentie met het product PAYMENTS. Bewaar deze in uw backend. |
| Idempotency-Key required | string [ 16 .. 128 ] characters Van 16 tot 128 zichtbare ASCII-tekens. Genereer er één per betaling (een UUID v4 is geldig) en hergebruik deze als u de aanroep opnieuw probeert. |
| amount_minor required | integer >= 1 Bedrag in kleinere eenheden (centen) als JSON-geheel getal. Voorbeeld: |
| currency required | string Value: "EUR" |
required | object (payments-beneficiary) Ontvanger van de overboeking. Kan niet worden gewijzigd nadat de betaling is aangemaakt. |
| reference required | string [ 1 .. 140 ] characters Omschrijving op het rekeningafschrift, maximaal 140 tekens. Voorbeeld: |
| customer_reference required | string <= 128 characters Uw interne referentie voor de betaling. Van 1 tot 128 tekens; begint met een letter of cijfer en bevat alleen letters, cijfers en Voorbeeld: |
| allowed_origin required | string Origin ( Voorbeeld: |
| locale | string Value: "es" Optioneel. Taal van de widget; in deze versie alleen |
| expected_mode | string Enum: "mock" "live" Optioneel. Als deze niet overeenkomt met de omgeving, geeft de aanroep |
| allowed_institution_codes | Array of strings <= 2500 items Optioneel. Niet-lege lijst van unieke bankcodes (zie Voorbeeld:
|
| logo | string or null Optioneel. Openbare |
{- "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"
}
}
}Server-naar-server-opvraging van de status van een betaling, totdat er een bancaire conclusie is. Een callback, een SCA-terugkeer of het sluiten van de widget is geen financiële bevestiging: alleen payment_status: settled is dat.
Wealth Reader beperkt de externe opvragingen per intentie; pas ook in uw backend backoff toe en maak geen nieuwe intentie aan zolang het resultaat dubbelzinnig is.
Dubbelzinnig resultaat: een netwerkstoring, time-out of onherkenbaar antwoord na het verzenden van de initiatie zet de intentie op reconciliation_required met payment_status: unknown, en het antwoord bevat reconciliation. De initiatie wordt nooit automatisch herhaald. Bewaar de identificatie en de idempotentiesleutel, maak geen nieuwe intentie aan en autoriseer niet opnieuw, en stop met pollen wanneer automatic_recovery false is en escaleer naar support met reconciliation.reference.
Bij Fast Track-betalingen verzendt deze opvraging ook de openstaande OK/KO-melding naar notification_url wanneer de betaling een eindstatus heeft bereikt.
Handleiding: Statussen, polling en reconciliatie.
| X-API-Key required | string API-sleutel van de licentie die de betaling heeft aangemaakt. |
| payment_intent_id required | string <uuid>
Voorbeeld: |
| refresh | boolean Default: true Optioneel. |
{- "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"
}
}Retourneert de voorwaarden van een voor uw onderneming ingeschakeld beheerd profiel (begunstigde, omschrijving, bedraglimieten) en de banken waaruit de betaler kan kiezen. Gebruik de gekozen code als institution_code in create.
| X-API-Key required | string API-sleutel van een licentie met het product PAYMENTS. |
| profile required | string Code van het beheerde profiel. Voorbeeld: |
{- "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,
}
]
}
}Catalogus van banken die betalingen kunnen initiëren, met hun logo en de betaalmethoden die ze ondersteunen. X-API-Key is optioneel; als u deze meestuurt, wordt deze gevalideerd en telt deze als aanroep. Ondersteunt ook POST met dezelfde filters in een JSON-body, en POST /payments/?action=entities met verplichte X-API-Key.
Onbekende filters worden genegeerd en leiden nooit tot een validatiefout.
| country | string Example: country=ES ISO 3166-1 alpha-2-landcode. Voorbeeld: |
| search | string Tekst die voorkomt in de naam of de code, niet hoofdlettergevoelig (alias |
| code | string Example: code=santander-es Exacte code van de bank, niet hoofdlettergevoelig. Voorbeeld: |
| payment_method | string Enum: "sepa_credit_transfer" "instant_sepa_credit_transfer" Alleen de banken die deze betaalmethode ondersteunen. |
| limit | integer [ 1 .. 2000 ] Paginagrootte (van 1 tot 2000). |
| offset | integer >= 0 Aantal resultaten dat wordt overgeslagen. |
| X-API-Key | string Optioneel. Indien meegestuurd, wordt deze gevalideerd en telt deze als aanroep. |
{- "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. Voorbeeld: |
| 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. Voorbeeld: |
| 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. Voorbeeld: |
| enrollment_id required | string Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c Identifier returned by POST /cards/enrollments/. Voorbeeld: |
{- "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. Voorbeeld: |
| date_from | string <date> Example: date_from=2026-07-01 YYYY-MM-DD, on the operation date. Default: today minus 3 days. Voorbeeld: |
| date_to | string <date> Example: date_to=2026-07-11 YYYY-MM-DD, on the operation date. Default: today. Voorbeeld: |
string <email> Example: email=empleado@cliente.com Filters by the email of the employee. Voorbeeld: | |
| since_id | integer Example: since_id=216 Exclusive cursor on the transaction id, for pagination. Voorbeeld: |
| limit | integer <= 1000 Default: 500 Example: limit=500 Maximum number of transactions to return (500 by default, 1000 max). Voorbeeld: |
{- "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
}
}