Download OpenAPI specification:
Regulatoriske API'er baseret på PSD2 giver adgang til visse finansielle oplysninger såsom banksaldi og transaktioner. Der findes dog andre kilder til formueoplysninger, der ikke er tilgængelige gennem disse API'er. Wealth Reader API udvider de oplysninger, der tilbydes af regulatoriske API'er, ved at give realtidstilgang til yderligere formuekilder i enhver enhed verden over. Der findes to andre relaterede dokumenter, der vil hjælpe dig med at integrere Wealth Reader API. Den ene er Javascript widget integrationsguiden: https://docs-en.wealthreader.com/ og den anden er en Postman samling baseret på denne dokumentation. Meget vigtigt: Denne API-definition er tilpasset kunder, der integrerer via Widget, så nogle parametre, der ikke er nødvendige for denne type integration, er udeladt, såsom bankgodkendelsesparametre, da et token vil blive brugt.
Henter finansielle aktiver og detaljer om deres sammensætning inklusive investeringsporteføljer sammensat af aktier eller fonde, kreditkort, forsikringer og lån. Inkluderer ejerskabsoplysninger for hver aktiv samt unikke identifikatorer, der letter databehandling. Det er muligt at få Mock-data. Tjek med det tekniske team hvordan dette gøres.
| api_key | string Identificerer klienten i tjenesten |
| code | string Navn på enheden. Den komplette liste er tilgængelig med GET Eksempel: |
| token | string Identificerer de opbevarede legitimationsoplysninger. Flowet, hvormed tokenet blev opnået, er beskrevet i dokumentet 'Widget integrationsvejledning'. Følgende Mock-brugere er tilgængelige: MOCKDATA, OK-svar; MOCKOTP, svar med OTP-udfordring; MOCKLOGINKO, svar med login-fejl Eksempel: |
| product_types | string Enum: "accounts" "portfolios" "cards" "receipts" "loans" "factoring" "confirming" "properties" "invoices" "files" "deposits" "leases" "insurances" Liste over produkttyper, hvorfra information skal hentes. Accepterer flere værdier adskilt med kommaer. Eksempel: |
| only_balances | boolean Default: false Angiver, om der kun skal hentes saldi for produkterne i stedet for al tilgængelig information. Standardværdi: false. Eksempel: |
| fetch_transaction_details | boolean Default: false Angiver, om der skal hentes udvidede transaktionsdetaljer, når enhedens connector understøtter det. VIGTIGT: Aktivering indebærer udførelse af en eller flere yderligere navigationer pr. transaktion for at berige de returnerede oplysninger. Dette vil uundgåeligt og betydeligt øge udførelsestiden. Antallet af yderligere navigationer vokser med transaktionsvolumenet. Det anbefales kun at aktivere det, når du er sikker på, at der kræves et detaljeniveau ud over det, der returneres som standard. De hentede detaljer indsættes i nøglen Eksempel: |
| date_from | string <date> Dato fra hvilken transaktioner anmodes om, i ÅÅÅÅ-MM-DD format. Skal være en dato før i dag. Eksempel: |
| date_to | string <date> Dette gælder kun for begrænsning efter fremtidige datoer for produkterne loan og confirming, i ÅÅÅÅ-MM-DD format. Datoen skal være senere end i dag Eksempel: |
| required_products_schema | string Påkrævet produktskema. Angiver de konti eller kort, hvorfra data ønskes, med yderligere konfigurationer. Eksempel:
|
| add_pdf_from_uuids | string Accepterer transaktions-uuid'er adskilt med kommaer. Parameter, der kun tages i betragtning, hvis product_types er ALL eller inkluderer accounts. Tilføjer PDF-dokumentet tilknyttet hver af de anmodede banktransaktioner. Eksempel:
|
| otp_method | string Vælger hvilken tofaktor-leveringskanal der skal bruges, når API'et returnerede fejlkode 2017 eller 20171 (flere OTP-metoder). Kald igen med samme sessions-ID som i det svar og sæt otp_method til den præcise streng i otp_method-feltet for et objekt i statistics.otpMethods — ikke array-indeks. Udelad ved første credential-forespørgsel; send efter brugerens valg. Eksemplet nedenfor er illustrativt; kopier altid strengen fra statistics.otpMethods. Eksempel: |
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"
}
}
]Brug denne metode til at hente tokens knyttet til en specifik api_key. Resultaterne er pagineret: limit angiver antallet af tokens pr. side (højst 500), og page vælger den side, der returneres. api_key, method og limit er obligatoriske; hvis en af dem mangler eller er ugyldig, svarer API'et med HTTP 400 og fejlkode 2.
| api_key required | string^[a-z0-9]{8}$ api_key til at identificere klienten i tjenesten |
| method required | string Value: "get" Handling, der skal udføres. Den eneste understøttede værdi er Eksempel: |
| limit required | integer [ 1 .. 500 ] Antal tokens pr. side. Minimum Eksempel: |
| page | integer >= 1 Default: 1 Angiv sidenummeret du vil hente. Hver side indeholder op til Eksempel: |
| code | string Enhedskode, der bruges til at filtrere tokens. Hvis den udelades, returneres tokens for alle enheder. Eksempel: |
| sort_by | string Default: "created_at" Enum: "created_at" "accesed_at" Felt, som resultaterne sorteres efter: Eksempel: |
| sort_order | string Default: "DESC" Enum: "ASC" "DESC" Sorteringsretning: Eksempel: |
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
}
}Denne metode tillader tilbagekaldelse af et eksisterende token for at deautorisere fremtidige API-adgangsanmodninger.
| api_key | string Identificerer klienten i tjenesten |
| token | string Token der skal tilbagekaldes. |
{- "success": true,
- "message": "Token successfully revoked."
}Denne metode tillader gentildeling af et token fra én api_key til en anden. Begge api_keys skal være aktive og tilhøre samme virksomhed, og tokenet skal tilhøre api_key_source.
| api_key_source | string api_key hvorfra tokenet skal gentildeles. |
| api_key_target | string api_key som tokenet skal gentildeles til. |
| token | string Token der skal gentildeles. Eksempel: |
api_key_source=a1b2c3d4e5f6g7h8i9j0&api_key_target=b2c3d4e5f6g7h8i9j0k1&token=FRJ0mHlaqZwLzu
{- "success": true,
- "message": "Token successfully reassigned."
}Tilføjer forbindelsen mellem domænet, der skal hoste widgetten, og destinations-webhook. For at redigere eller teste dine domæner, brug https://www.wealthreader.com/clients/
| method required | string Method to execute. Eksempel: |
| api_key required | string User's API key. |
| domain required | string Domain to add. Eksempel: |
| url_callback required | string URL for callback. Eksempel: |
| tokenize required | string Enum: "1" "0" Styrer om widgeten starter et tokeniseringsforløb:
Eksempel: |
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"
}Liste over fejlkoder. Vær særligt opmærksom på, at ikke alle fejlkoder skal modtage den samme behandling fra din applikation. For en forkert adgangskode-fejl skal du ikke prøve kaldet igen med de samme parametre, men for en fejl, der indikerer, at enheden er under vedligeholdelse, kan du prøve igen. Anmod om en teknisk session med vores team for at løse eventuelle spørgsmål om fejlhåndtering.
| 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\"."
}
]
]Liste over advarselskoder.
| 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\"."
}
]
]Valgfrie endpoints, der ikke kræves til standardintegrationer. Brug kun, hvis eksplicit instrueret af Wealth Reader.
Henter listen over understøttede enheder og oplysningerne, der er nødvendige for at tegne enhedens login-formular.
| 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"
}
}
]Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Dette endpoint tillader registrering af en bruger enten på porteføljeoverførselsplatformen Easytransfer eller på rapporteringsværktøjet Acumulas, baseret på en unik identifikator.
| api_key required | string Authentication key (8 alphanumeric characters) |
| user_id required | string User identification document. Eksempel: |
| service required | string Enum: "integra" "easy-transfer" Service associated with the user. Determines the data flow. Eksempel: |
| email required | string <email> User email, used according to service type. Eksempel: |
{- "success": true,
- "message": "User registered successfully"
}Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Tjekker om en bruger er registreret i Easytransfer- eller Acumulas-systemet og returnerer det unikke adgangslink for brugeren.
| api_key required | string Authentication key |
| user_id required | string User identification document. Eksempel: |
{- "success": true,
- "registered": true,
- "user_id": "12345",
- "links": {
}
}Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Dette endpoint tillader afregistrering af en bruger fra Easytransfer- eller Acumulas-platformtjenesten.
| api_key required | string Authentication key (8 alphanumeric characters) |
| user_id required | string User identification document. Eksempel: |
| service required | string Enum: "integra" "easy-transfer" "all" Service from which to unregister the user. 'all' for all services. Eksempel: |
{- "success": true,
- "message": "User unregistered successfully"
}Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader.
Vigtigt: For at bruge batchproceshåndtering på Wealthreader-siden kræves et dedikeret miljø. Dette endpoint er ikke tilgængeligt på api.wealthreader.com.
Endpoints grupperet under "batch"-tagget tillader asynkron behandling af flere bankforbindelser, i modsætning til den synkrone /entities/ metode. Ideel til behandling af store mængder forbindelser og undgåelse af 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. Eksempel: |
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"
}Dette endpoint er valgfrit. Henter generelle statistikker om behandlingsresultatet for alle forbindelser i en 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
}
}Dette endpoint er valgfrit. Henter resultatet af en specifik forbindelse fra batchen.
| 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"
}
}Verifikation af kontohaver: kontrollér, om et IBAN tilhører en kontohaver, via SEPA-verifikation af betalingsmodtager (VoP) hos den bank, der er tilknyttet din licens. Trin-for-trin-vejledning: MyBankMatch.
Kontrollerer, om et IBAN tilhører den angivne kontohaver, via SEPA-verifikation af betalingsmodtager (VoP) hos din egen bank, der er tilknyttet din WealthReader-licens. Returnerer bankens afgørelse: den erstattes ikke af en lokal beregning af navnelighed, og der oprettes, godkendes eller udføres ingen betalingsordre.
Før det første kald
MY_BANK_MATCH og ledig kvote.api_key; banktokenet udleveres ikke til browseren og er ikke en parameter i forespørgslen.Forespørgsel: body kodet som formular (application/x-www-form-urlencoded) med api_key, iban og name, ligesom ved /entities/. Der sendes ikke JSON, og headeren X-API-Key bruges ikke. Opbevar api_key i din backend.
Svar: HTTP 200 angiver, at der er opnået et resultat fra produktet, ikke at navnet stemmer overens. Kontrollér success og derefter payload.result:
payload.result |
Betydning | Yderligere felter | Fakturerbar |
|---|---|---|---|
MATCH |
Banken vurderer, at navnet stemmer overens med kontohaveren. | Ingen. | Ja, 0,10 EUR. |
PARTIAL_MATCH |
Banken returnerer et delvist match (CLOSE_MATCH). |
suggested_name. |
Ja, 0,10 EUR. |
NO_MATCH |
Banken angiver, at navnet ikke stemmer overens. | Ingen. | Ja, 0,10 EUR. |
NOT_CONFIGURED |
Licensen har endnu ikke en tilknyttet bank. | setup_url. |
Nej. |
REAUTH_REQUIRED |
Forbindelsen til banken kræver en ny godkendelse. | setup_url, reason_code. |
Nej. |
NOT_POSSIBLE |
Det var ikke muligt at opnå en brugbar afgørelse. Svarer ikke til NO_MATCH. |
reason. |
Nej. |
Kun MATCH, PARTIAL_MATCH og NO_MATCH forbruger kvote. Inputfejl og ikke-entydige resultater faktureres ikke.
Der er ingen idempotensnøgle og intet gratis genforsøg. Hvis du mister svaret (timeout, netværk eller en body, der ikke kan fortolkes), kan resultatet og det tilhørende kvoteforbrug være ukendt for din applikation. Send ikke automatisk den samme forespørgsel igen: gennemgå historikken under Kunder, og kontakt support med angivelse af statistics.SESSION.
Komplet vejledning: MyBankMatch.
| api_key required | string Nøgle på 8 hexadecimale tegn fra en aktiv licens med produktet MY_BANK_MATCH og ledig kvote. Opbevar den i din backend. |
| iban required | string IBAN fra et SEPA-land. Mellemrum fjernes, værdien konverteres til store bogstaver, og længden for landet samt kontrolcifrene mod-97 valideres. Eksempel: |
| name required | string <= 140 characters Kontohaverens navn. Ikke tomt, gyldig UTF-8, uden kontroltegn og op til 140 tegn. Beskæres, og interne mellemrum sammentrækkes. Eksempel: |
api_key=a1b2c3d4&iban=ES9321005707250200257112&name=Wealthreader%20S.L.
{- "success": true,
- "payload": {
- "result": "MATCH"
}, - "statistics": {
- "SESSION": "0123456789abcdef",
- "execution_time": 0.42,
- "warnings": [ ]
}
}SEPA-betalinger fra konto til konto, igangsat fra betalerens bank. Der er to måder at integrere dem på:
POST /payments/?action=fast-track returnerer betalings-URL'en, og Wealth Reader underretter din notification_url med OK eller KO. Se Fast Track-betalinger.POST /payments/?action=create, åbner widgetten med det returnerede token og bekræfter resultatet med POST /payments/?action=status. Se Introduktion til betalinger og Statusser, polling og afstemning.Fælles regler for alle kald til /payments/?action=...
POST med headeren Content-Type: application/json og et JSON-objekt som body (maks. 32768 bytes).X-API-Key (wr_live_ efterfulgt af 72 bogstaver eller cifre) fra en aktiv licens med produktet PAYMENTS. Den sendes aldrig i body. Hvert godkendt kald tæller med i licensens kaldgrænse.422 invalid_request.payment_status: settled. En widgethændelse, en SCA-returnering eller interaction_status: completed betyder aldrig, at betalingen er afviklet.Fejlformat: application/json (ikke problem+json) med en stabil error.code; error.message er vejledende og kan ændres.
{"success": false, "error": {"code": "invalid_request", "message": "The request body has an invalid schema."}}
| HTTP | error.code |
Årsag |
|---|---|---|
| 400 | invalid_json |
Tom eller ugyldig body, eller ikke et JSON-objekt. |
| 401 | invalid_api_key |
X-API-Key mangler, er forkert formateret, ukendt eller inaktiv. |
| 403 | payments_not_allowed |
Licensen har ikke produktet PAYMENTS. |
| 404 | action_not_found |
Ukendt action. |
| 405 | method_not_allowed |
Anden metode end POST. |
| 413 | request_too_large |
Body på mere end 32768 bytes. |
| 415 | json_required |
Anden Content-Type end application/json. |
| 422 | invalid_request |
Manglende eller uventede felter. |
| 429 | api_limit_reached |
Licensens kaldgrænse er nået. |
| 500 | internal_error |
Uventet fejl. |
| 503 | payments_disabled, payments_accept_new_disabled, payment_storage_unavailable, payment_state_unavailable |
Tjenesten er midlertidigt utilgængelig, eller nye betalinger er sat på pause. |
Wealth Reader sender dette POST til notification_url for en Fast Track-betaling, når den kontrollerer betalingens status og finder den i en endelig status. reconciliation_required er ikke endelig og underrettes ikke: bekræft den med status.
outcome er kun ok, hvis banken har afviklet betalingen (settled); rejected, cancelled, expired og failed underrettes som ko.status. Der er ingen separat planlagt afsendelse: hvis betaleren forlader siden, før banken når en konklusion, eller din server ikke svarer 2xx, sendes underretningen ved næste kontrol. Hvis den ikke er kommet nogle minutter efter, at du har omdirigeret betaleren, skal du kalde status med payment_intent_id; det kald udløser også den ventende underretning.2xx for at betragte den som leveret. Wealth Reader følger ikke omdirigeringer og venter højst 3 sekunder.customer_reference plus outcome som idempotente.status ved hjælp af din X-API-Key og payment_intent_id fra underretningen.| User-Agent required | string Value: "WealthReader-Payments" |
| outcome required | string Enum: "ok" "ko"
|
| payment_status required | string Enum: "settled" "rejected" "cancelled" "expired" "failed" Endeligt finansielt resultat. |
| customer_reference required | string Den |
| payment_intent_id required | string <uuid> Identifikator, som |
{- "outcome": "ok",
- "payment_status": "settled",
- "customer_reference": "11111111-1111-4111-8111-111111111111",
- "payment_intent_id": "3f2b8c1e-5d4a-4b6f-9e21-7c0d4a1b2e3f"
}Et enkelt kald, der returnerer betalings-URL'en. Betaleren åbner den og godkender betalingen i sin bank; når betalingen når en endelig status, underretter Wealth Reader din notification_url med OK eller KO (se webhooken notification_url). Bagved oprettes den samme uforanderlige intention som med create: beløb, modtager og tekst er fastlagt, før de når browseren.
Headeren Idempotency-Key er også din forretningsreference (customer_reference i underretningen): den sendes ikke i body. Hvis du gentager den samme nøgle med den samme body, modtager du den samme URL; hvis du genbruger den med andre data (også med et andet logo), er svaret 409 idempotency_conflict.
En straksoverførsel har ikke sin egen grænse i denne API: banken afviser den overførsel, den ikke kan acceptere, også på grund af beløbet, og afvisningen kommer som KO.
| X-API-Key required | string API-nøgle fra en licens med produktet PAYMENTS. Opbevar den i din backend. |
| Idempotency-Key required | string [ 16 .. 128 ] characters Fra 16 til 128 tegn; skal begynde med et bogstav eller ciffer og må kun indeholde bogstaver, cifre og |
| amount required | string Beløb i hovedenheder som JSON-streng. Eksempel: |
| currency required | string Value: "EUR" ISO 4217-valuta. I denne version kun Eksempel: |
required | object (payments-beneficiary) Modtager af overførslen. Kan ikke ændres, når betalingen er oprettet. |
| reference required | string [ 1 .. 140 ] characters Tekst på kontoudtoget, op til 140 tegn. Eksempel: |
| priority required | string Enum: "normal" "instant"
Eksempel: |
| notification_url required | string <= 2000 characters Offentlig Eksempel: |
| logo | string <= 2048 characters Valgfri. Offentlig Eksempel: |
{- "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"
}Opretter en uforanderlig betalingsintention og returnerer et kortlivet token til at åbne widgetten i betalerens browser. Beløb, modtager og tekst fastlægges i backend og kan ikke ændres fra browseren. Når widgetten er lukket, skal du bekræfte resultatet fra din backend med status.
Der er to varianter af body:
amount_minor, currency, beneficiary, reference, customer_reference og allowed_origin.cruz_roja_demo): Wealth Reader fastlægger modtager, tekst og grænser; du sender profile, institution_code, amount_minor, customer_reference og allowed_origin. Hent bankerne med profile-institutions.Hvis du gentager den samme Idempotency-Key med den samme body, modtager du den samme intention (200, idempotent_replay: true); hvis du genbruger den med andre data, er svaret 409 idempotency_conflict. Nøglen er specifik for din virksomhed.
Vejledning: Intentioner og idempotens og Integration med widgetten.
| X-API-Key required | string API-nøgle fra en licens med produktet PAYMENTS. Opbevar den i din backend. |
| Idempotency-Key required | string [ 16 .. 128 ] characters Fra 16 til 128 synlige ASCII-tegn. Generér én pr. betaling (et UUID v4 er gyldigt), og genbrug den, hvis du forsøger kaldet igen. |
| amount_minor required | integer >= 1 Beløb i mindre enheder (cent) som JSON-heltal. Eksempel: |
| currency required | string Value: "EUR" |
required | object (payments-beneficiary) Modtager af overførslen. Kan ikke ændres, når betalingen er oprettet. |
| reference required | string [ 1 .. 140 ] characters Tekst på kontoudtoget, op til 140 tegn. Eksempel: |
| customer_reference required | string <= 128 characters Din interne reference for betalingen. Fra 1 til 128 tegn; begynder med et bogstav eller ciffer og indeholder kun bogstaver, cifre og Eksempel: |
| allowed_origin required | string Oprindelse ( Eksempel: |
| locale | string Value: "es" Valgfri. Widgettens sprog; i denne version kun |
| expected_mode | string Enum: "mock" "live" Valgfri. Hvis den ikke stemmer overens med miljøet, svarer kaldet |
| allowed_institution_codes | Array of strings <= 2500 items Valgfri. Ikke-tom liste over unikke bankkoder (se Eksempel:
|
| logo | string or null Valgfri. Offentlig |
{- "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-til-server-forespørgsel om en betalings status, indtil der foreligger en bankmæssig konklusion. Et callback, en SCA-returnering eller lukning af widgetten er ikke en finansiel bekræftelse: det er kun payment_status: settled.
Wealth Reader begrænser de eksterne forespørgsler pr. intention; anvend også backoff i din backend, og opret ikke en ny intention, så længe resultatet er tvetydigt.
Tvetydigt resultat: et netværksnedbrud, en timeout eller et ukendt svar efter afsendelse af igangsættelsen ændrer intentionen til reconciliation_required med payment_status: unknown, og svaret indeholder reconciliation. Igangsættelsen gentages aldrig automatisk. Behold identifikatoren og idempotensnøglen, opret ikke en ny intention, og godkend ikke igen, og når automatic_recovery er false, skal du stoppe pollingen og eskalere til support med reconciliation.reference.
Ved Fast Track-betalinger sender denne forespørgsel også den ventende OK/KO-underretning til notification_url, når betalingen har nået en endelig status.
Vejledning: Statusser, polling og afstemning.
| X-API-Key required | string API-nøgle fra den licens, der oprettede betalingen. |
| payment_intent_id required | string <uuid>
Eksempel: |
| refresh | boolean Default: true Valgfri. |
{- "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"
}
}Returnerer betingelserne for en administreret profil, der er aktiveret for din virksomhed (modtager, tekst, beløbsgrænser), og de banker, som betaleren kan vælge. Brug den valgte code som institution_code i create.
| X-API-Key required | string API-nøgle fra en licens med produktet PAYMENTS. |
| profile required | string Kode for den administrerede profil. Eksempel: |
{- "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,
}
]
}
}Katalog over banker, der kan igangsætte betalinger, med deres logo og de betalingsmetoder, de understøtter. X-API-Key er valgfri; hvis du sender den, valideres den og tæller som et kald. Understøtter også POST med de samme filtre i en JSON-body samt POST /payments/?action=entities med obligatorisk X-API-Key.
Ukendte filtre ignoreres og giver aldrig en valideringsfejl.
| country | string Example: country=ES Landekode efter ISO 3166-1 alpha-2. Eksempel: |
| search | string Tekst indeholdt i navnet eller koden, uden forskel på store og små bogstaver (alias |
| code | string Example: code=santander-es Bankens nøjagtige kode, uden forskel på store og små bogstaver. Eksempel: |
| payment_method | string Enum: "sepa_credit_transfer" "instant_sepa_credit_transfer" Kun de banker, der understøtter denne betalingsmetode. |
| limit | integer [ 1 .. 2000 ] Sidestørrelse (fra 1 til 2000). |
| offset | integer >= 0 Antal resultater, der springes over. |
| X-API-Key | string Valgfri. Hvis den sendes, valideres den og tæller som et kald. |
{- "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. Eksempel: |
| 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. Eksempel: |
| 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. Eksempel: |
| enrollment_id required | string Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c Identifier returned by POST /cards/enrollments/. Eksempel: |
{- "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. Eksempel: |
| date_from | string <date> Example: date_from=2026-07-01 YYYY-MM-DD, on the operation date. Default: today minus 3 days. Eksempel: |
| date_to | string <date> Example: date_to=2026-07-11 YYYY-MM-DD, on the operation date. Default: today. Eksempel: |
string <email> Example: email=empleado@cliente.com Filters by the email of the employee. Eksempel: | |
| since_id | integer Example: since_id=216 Exclusive cursor on the transaction id, for pagination. Eksempel: |
| limit | integer <= 1000 Default: 500 Example: limit=500 Maximum number of transactions to return (500 by default, 1000 max). Eksempel: |
{- "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
}
}