Wealth Reader (8.1.12)

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.

Core

Kærne-API påkrævet til standardintegrationer

Henter finansielle aktiver og detaljer om deres sammensætning

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.

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

Identificerer klienten i tjenesten

code
string

Navn på enheden. Den komplette liste er tilgængelig med GET

Eksempel: caixabank

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: MOCKDATA

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: accounts,portfolios

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: false

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 additional_info på niveau for hver transaktion. Brugen af denne parameter kræver et dedikeret miljø.

Eksempel: false

date_from
string <date>

Dato fra hvilken transaktioner anmodes om, i ÅÅÅÅ-MM-DD format. Skal være en dato før i dag.

Eksempel: 2024-01-01

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: 2025-12-31

required_products_schema
string

Påkrævet produktskema. Angiver de konti eller kort, hvorfra data ønskes, med yderligere konfigurationer.

Eksempel:

{
  "ACCOUNTS": {
    "0ae4d722b1c82feeafb4b36b2893230444071335": {
      "only_balances": false,
      "add_pdf_from_uuids": [
        "90763109952d4f2ebece8dceca8254078c5384a0"
      ],
      "date_from": "2024-04-03"
    }
  },
  "CARDS": {
    "957e6f63546f3fecacce80192b6f7436496dc057": {}
  }
}
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:

20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295
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: OTP_SMS ****1234

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=a1b2c3d4e5f6g7h8i9j0&code=caixabank&token=1234Asdf&product_types=accounts%2Cportfolios&only_balances=false&date_from=2024-01-01&date_to=2025-12-31&required_products_schema=%7B%22ACCOUNTS%22%3A%7B%220ae4d722b1c82feeafb4b36b2893230444071335%22%3A%7B%22only_balances%22%3Afalse%2C%22add_pdf_from_uuids%22%3A%5B%2290763109952d4f2ebece8dceca8254078c5384a0%22%5D%2C%22date_from%22%3A%222024-04-03%22%7D%7D%2C%22CARDS%22%3A%7B%22957e6f63546f3fecacce80192b6f7436496dc057%22%3A%7B%7D%7D%7D&add_pdf_from_uuids=20966426721d0885ef9d4b95535e1d3198936f16%2C8772d6c978d37d7af83094abf380b8b703e94105

Response samples

Content type
application/json
[
  • {
    }
]

Liste over transaktionstyper

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Forespørg tokens tilknyttet en api_key

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.

Request Body schema: application/x-www-form-urlencoded
required
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 get.

Eksempel: get

limit
required
integer [ 1 .. 500 ]

Antal tokens pr. side. Minimum 1, maksimum 500.

Eksempel: 100

page
integer >= 1
Default: 1

Angiv sidenummeret du vil hente. Hver side indeholder op til limit tokens. Hvis ikke angivet, er standardværdien 1.

Eksempel: 1

code
string

Enhedskode, der bruges til at filtrere tokens. Hvis den udelades, returneres tokens for alle enheder.

Eksempel: bbva

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

Felt, som resultaterne sorteres efter: created_at (oprettelsesdato) eller accesed_at (sidste adgangsdato). Standard created_at.

Eksempel: created_at

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

Sorteringsretning: ASC (stigende) eller DESC (faldende). Standard DESC.

Eksempel: DESC

Responses

Request samples

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

Response samples

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

Tilbagekald et token

Denne metode tillader tilbagekaldelse af et eksisterende token for at deautorisere fremtidige API-adgangsanmodninger.

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

Identificerer klienten i tjenesten

token
string

Token der skal tilbagekaldes.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Token successfully revoked."
}

Gentildel et token til en anden api_key

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.

Request Body schema: application/x-www-form-urlencoded
required
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: FRJ0mHlaqZwLzu

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key_source=a1b2c3d4e5f6g7h8i9j0&api_key_target=b2c3d4e5f6g7h8i9j0k1&token=FRJ0mHlaqZwLzu

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Token successfully reassigned."
}

Tilføj et nyt domæne

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/

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

Method to execute.

Eksempel: add

api_key
required
string

User's API key.

domain
required
string

Domain to add.

Eksempel: http://desarrollo.cliente.es

url_callback
required
string

URL for callback.

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

tokenize
required
string
Enum: "1" "0"

Styrer om widgeten starter et tokeniseringsforløb:

  • 1 - Brugeren autentificerer sig hos den finansielle institution (login, samtykke, 2FA hvis påkrævet) og et genanvendeligt token returneres
  • 0 - Der udføres ingen tokenisering. Den tidligere indhentede tokenværdi skal inkluderes i anmodningen

Eksempel: 1

Responses

Request samples

Content type
application/x-www-form-urlencoded
method=add&api_key=a1b2c3d4e5f6g7h8i9j0&domain=https%3A%2F%2Fwww.cliente.com&url_callback=https%3A%2F%2Fwww.cliente.com%2Fwebhooks%2Fwealthreader&tokenize=1

Response samples

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

Liste over fejlkoder

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.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Liste over advarselskoder

Liste over advarselskoder.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Valgfrie endpoints, der ikke kræves til standardintegrationer. Brug kun, hvis eksplicit instrueret af Wealth Reader.

Henter listen over understøttede enheder

Henter listen over understøttede enheder og oplysningerne, der er nødvendige for at tegne enhedens login-formular.

query Parameters
show_only_tested
integer
Default: 0
Enum: 0 1

Indicates whether to show only tested entities. Default value is 0. In production environments, always use 1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registrer en ny bruger

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.

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

Authentication key (8 alphanumeric characters)

user_id
required
string

User identification document.

Eksempel: 12345678A

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

Service associated with the user. Determines the data flow.

Eksempel: easy-transfer

email
required
string <email>

User email, used according to service type.

Eksempel: sai_banker@singularbank.com

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "User registered successfully"
}

Tjek brugerregistreringsstatus

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.

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

Authentication key

user_id
required
string

User identification document.

Eksempel: 12345678A

Responses

Response samples

Content type
application/json
{}

Tilbagekald en tidligere registreret bruger

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.

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

Authentication key (8 alphanumeric characters)

user_id
required
string

User identification document.

Eksempel: 12345678A

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

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

Eksempel: easy-transfer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "User unregistered successfully"
}

Batch-forbindelsesindlæsning

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.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

notification_url
required
string <uri>

Webhook URL. A notification is sent to this URL for each individual credential as soon as it completes processing, not only once all connections in the batch are done.

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

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

List of connections to process

Responses

Callbacks

Request samples

Content type
application/json
{
  • "api_key": "a1b2c3d4e5f6g7h8i9j0",
  • "connections": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "batch_id": "batch_20250120_a1b2c3d4",
  • "total_connections": 5,
  • "estimated_completion_time": "2025-01-20T10:45:00Z"
}

Callback payload samples

Callback
POST: Webhook fired when a credential finishes processing
Content type
application/json
{
  • "batch_id": 10863151,
  • "credential_id": "cred_demo_002",
  • "status": "completed",
  • "timestamp": "2026-05-13T08:02:47+00:00"
}

Hent generelle statistikker om batch-forbindelser

Dette endpoint er valgfrit. Henter generelle statistikker om behandlingsresultatet for alle forbindelser i en batch.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

batch_id
required
string

Batch ID

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "batch_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "batch_id": "batch_20250120_a1b2c3d4",
  • "status": "completed",
  • "statistics": {
    }
}

Hent individuelt resultat af en specifik forbindelse inden for en batch

Dette endpoint er valgfrit. Henter resultatet af en specifik forbindelse fra batchen.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

batch_id
required
string

Batch ID

credential_id
required
string

Filter by specific credential_id

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "batch_id": "string",
  • "credential_id": "string"
}

Response samples

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

MyBankMatch

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.

Verificerer, at et IBAN tilhører en kontohaver (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

  1. Hav en aktiv licens med produktet MY_BANK_MATCH og ledig kvote.
  2. Åbn Kunder · MyBankMatch, klik på Forbind bank, og gennemfør godkendelsen i WealthReaders hostede vindue. Den tokeniserede forbindelse knyttes til din 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.

Request Body schema: application/x-www-form-urlencoded
required
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: ES9321005707250200257112

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: Wealthreader S.L.

Responses

Request samples

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

Response samples

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

Payments

SEPA-betalinger fra konto til konto, igangsat fra betalerens bank. Der er to måder at integrere dem på:

  • Fast Track: et enkelt POST /payments/?action=fast-track returnerer betalings-URL'en, og Wealth Reader underretter din notification_url med OK eller KO. Se Fast Track-betalinger.
  • Widget: din backend opretter en uforanderlig betalingsintention med 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=...

  • Metoden POST med headeren Content-Type: application/json og et JSON-objekt som body (maks. 32768 bytes).
  • Godkendelse udelukkende med headeren 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.
  • Body er en hvidliste: et manglende obligatorisk felt eller et uventet felt giver 422 invalid_request.
  • Den eneste positive finansielle bekræftelse er 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.

Underretning om OK eller KO for en Fast Track-betaling Webhook

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 kontrolleres, mens betaleren stadig er på betalingssiden (som forespørger, indtil det endelige resultat foreligger, eller indtil betalingssessionen udløber), og hver gang du kalder 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.
  • Svar med en hvilken som helst 2xx for at betragte den som leveret. Wealth Reader følger ikke omdirigeringer og venter højst 3 sekunder.
  • Den samme underretning kan komme mere end én gang: behandl customer_reference plus outcome som idempotente.
  • Forespørgslen er ikke signeret. Før du leverer en værdifuld vare, skal du bekræfte resultatet med status ved hjælp af din X-API-Key og payment_intent_id fra underretningen.
header Parameters
User-Agent
required
string
Value: "WealthReader-Payments"
Request Body schema: application/json
required
outcome
required
string
Enum: "ok" "ko"

ok kun for settled.

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

Endeligt finansielt resultat.

customer_reference
required
string

Den Idempotency-Key, du sendte, da du oprettede betalingen.

payment_intent_id
required
string <uuid>

Identifikator, som fast-track returnerede. Brug den til at bekræfte resultatet med status.

Responses

Request samples

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

Opretter en betaling og henter dens URL (Fast Track)

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.

header Parameters
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 . _ : -. Et UUID v4 er gyldigt. Det er også den forretningsreference, der returneres i underretningen.

Request Body schema: application/json
required
amount
required
string

Beløb i hovedenheder som JSON-streng. "15.50" er 15,50 EUR; et heltal uden decimaler ("15") accepteres også. Højst to decimaler, så "15.5" og "15.50" er det samme beløb. Minimum 0.01. Maksimum er begrænset af den grænse, som hver kunde har konfigureret i sin bank.

Eksempel: 15.50

currency
required
string
Value: "EUR"

ISO 4217-valuta. I denne version kun EUR.

Eksempel: 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: Pedido 78901

priority
required
string
Enum: "normal" "instant"

normal (SEPA-overførsel) eller instant (SEPA-straksoverførsel).

Eksempel: normal

notification_url
required
string <= 2000 characters

Offentlig https-URL, der modtager underretningen om OK eller KO. Uden loginoplysninger, port 443, hvis den angives, og uden private, lokale eller metadata-adresser.

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

logo
string <= 2048 characters

Valgfri. Offentlig https-URL til din virksomheds logo i SVG (stien skal ende på .svg; forespørgselsparametre er tilladt), uden loginoplysninger, fragment eller private adresser, op til 2048 ASCII-tegn. Betalingssiden viser det over oversigten; Wealth Reader downloader det ikke, det indlæses af betalerens browser. Enhver anden værdi giver 422 invalid_logo.

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

Responses

Request samples

Content type
application/json
{}

Response samples

Opretter en betalingsintention (widget)

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:

  • Standard: du fastlægger amount_minor, currency, beneficiary, reference, customer_reference og allowed_origin.
  • Administreret profil (for eksempel 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.

header Parameters
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.

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

Beløb i mindre enheder (cent) som JSON-heltal. 1500 er 15,00 EUR. Maksimum er begrænset af den grænse, som hver kunde har konfigureret i sin bank.

Eksempel: 1500

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: Pedido 78901

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: order-78901

allowed_origin
required
string

Oprindelse (https://host[:puerto], uden sti, forespørgsel eller fragment) for den side, der åbner widgetten. Widgetten fungerer kun fra den oprindelse.

Eksempel: https://tienda.example.com

locale
string
Value: "es"

Valgfri. Widgettens sprog; i denne version kun es.

expected_mode
string
Enum: "mock" "live"

Valgfri. Hvis den ikke stemmer overens med miljøet, svarer kaldet 409 payment_mode_mismatch i stedet for at oprette betalingen.

allowed_institution_codes
Array of strings <= 2500 items

Valgfri. Ikke-tom liste over unikke bankkoder (se /payments/entities/), som betaleren kan vælge imellem.

Eksempel:

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

Valgfri. Offentlig https-URL til dit logo i SVG (sti, der ender på .svg), uden loginoplysninger, fragment eller private adresser, op til 2048 tegn.

Responses

Request samples

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

Response samples

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

Forespørger en betalings status

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.

header Parameters
X-API-Key
required
string

API-nøgle fra den licens, der oprettede betalingen.

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

payment.id returneret af create (ved Fast Track det payment_intent_id, som fast-track returnerer).

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

refresh
boolean
Default: true

Valgfri. true forespørger banken om den seneste status, når det er relevant; false returnerer den gemte status.

Responses

Request samples

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

Response samples

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

Viser bankerne og betingelserne for en administreret profil

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.

header Parameters
X-API-Key
required
string

API-nøgle fra en licens med produktet PAYMENTS.

Request Body schema: application/json
required
profile
required
string

Kode for den administrerede profil.

Eksempel: cruz_roja_demo

Responses

Request samples

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

Response samples

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

Viser de banker, der er tilgængelige for betalinger

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.

query Parameters
country
string
Example: country=ES

Landekode efter ISO 3166-1 alpha-2. ALL eller tom betyder intet filter.

Eksempel: ES

search
string

Tekst indeholdt i navnet eller koden, uden forskel på store og små bogstaver (alias q).

code
string
Example: code=santander-es

Bankens nøjagtige kode, uden forskel på store og små bogstaver.

Eksempel: santander-es

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.

header Parameters
X-API-Key
string

Valgfri. Hvis den sendes, valideres den og tæller som et kald.

Responses

Response samples

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

Cards (real time)

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

Register or rotate the real-time cards webhook

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

Request Body schema: application/json
required
api_key
required
string

API key of the customer.

webhook_url
string or null

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

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

rotate_secret
boolean
Default: false

When true, generates and returns a new webhook_secret.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Pre-register the email of an employee

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

Request Body schema: application/json
required
api_key
required
string

API key of the customer.

email
required
string <email>

Email of the employee to pre-register.

Eksempel: empleado@cliente.com

ttl_minutes
integer [ 1 .. 60 ]
Default: 20

Minutes the request stays valid before expiring.

Responses

Request samples

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

Response samples

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

Check the status of an enrollment

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

query Parameters
api_key
required
string
Example: api_key=a1b2c3d4

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

Eksempel: a1b2c3d4

enrollment_id
required
string
Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Identifier returned by POST /cards/enrollments/.

Eksempel: 0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Responses

Response samples

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

Query / backfill real-time card transactions

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

query Parameters
api_key
required
string
Example: api_key=a1b2c3d4

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

Eksempel: a1b2c3d4

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

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

Eksempel: 2026-07-01

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

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

Eksempel: 2026-07-11

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

Filters by the email of the employee.

Eksempel: empleado@cliente.com

since_id
integer
Example: since_id=216

Exclusive cursor on the transaction id, for pagination.

Eksempel: 216

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

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

Eksempel: 500

Responses

Response samples

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