Wealth Reader (8.1.12)

Download OpenAPI specification:

Regulatoriske API-er basert på PSD2 gir tilgang til viss finansiell informasjon som banksaldoer og transaksjoner. Det finnes imidlertid andre kilder til formuesinformasjon som ikke er tilgjengelige gjennom disse API-ene. Wealth Reader API utvider informasjonen som tilbys av regulatoriske API-er ved å gi sanntids tilgang til tilleggsformueskilder i enhver enhet verden over. Det finnes to andre relaterte dokumenter som vil hjelpe deg med å integrere Wealth Reader API. En er Javascript widget integrasjonsguiden: https://docs-en.wealthreader.com/ og den andre er en Postman samling basert på denne dokumentasjonen. Svært viktig: Denne API-definisjonen er tilpasset kunder som integrerer via Widget, så noen parametere som ikke er nødvendige for denne typen integrasjon er utelatt, som bankautentiseringsparametere, da et token vil bli brukt.

Core

Kjerne-API nødvendig for standardintegrasjoner

Henter finansielle eiendeler og detaljer om deres sammensetning

Henter finansielle eiendeler og detaljer om deres sammensetning inkludert investeringsporteføljer sammensatt av aksjer eller fond, kredittkort, forsikringer og lån. Inkluderer eierskapsinformasjon for hver eiendel samt unike identifikatorer som letter databehandling. Det er mulig å få Mock-data. Sjekk med det tekniske teamet hvordan dette gjøres.

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

Identifiserer klienten i tjenesten

code
string

Navn på enheten. Den komplette listen er tilgjengelig med GET

Eksempel: caixabank

token
string

Identifiserer de forvaltede legitimasjonene. Flyten som tokenet ble oppnådd gjennom er beskrevet i dokumentet 'Widget integrasjonsguide'. Følgende Mock-brukere er tilgjengelige: MOCKDATA, OK-respons; MOCKOTP, respons med OTP-utfordring; MOCKLOGINKO, respons med innloggingsfeil

Eksempel: MOCKDATA

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

Liste over produkttyper som informasjon skal hentes fra. Aksepterer flere verdier atskilt med komma.

Eksempel: accounts,portfolios

only_balances
boolean
Default: false

Angir om det skal hentes bare saldoene til produktene i stedet for all tilgjengelig informasjon. Standardverdi: false.

Eksempel: false

fetch_transaction_details
boolean
Default: false

Angir om utvidede transaksjonsdetaljer skal hentes når enhetens kobling støtter det. VIKTIG: Å aktivere det innebærer å utføre en eller flere ekstra navigasjoner per transaksjon for å berike den returnerte informasjonen. Dette vil uunngåelig og betydelig øke utførelsestiden. Antallet ekstra navigasjoner øker med transaksjonsvolumet. Det anbefales å aktivere det kun når du er sikker på at det kreves et detaljnivå utover det som returneres som standard. De hentede detaljene settes inn i nøkkelen additional_info på nivået for hver transaksjon. Bruk av denne parameteren krever et dedikert miljø.

Eksempel: false

date_from
string <date>

Dato fra hvilken transaksjoner forespørres, i ÅÅÅÅ-MM-DD format. Må være en dato før i dag.

Eksempel: 2024-01-01

date_to
string <date>

Dette gjelder kun for begrensning etter fremtidige datoer for produktene loan og confirming, i ÅÅÅÅ-MM-DD format. Datoen må være senere enn i dag

Eksempel: 2025-12-31

required_products_schema
string

Nødvendig produktskjema. Angir kontoer eller kort som data ønskes fra, med tilleggskonfigurasjoner.

Eksempel:

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

Aksepterer transaksjons-uuid-er atskilt med komma. Parameter som bare tas i betraktning hvis product_types er ALL eller inkluderer accounts. Legger til PDF-dokumentet knyttet til hver av de forespurte banktransaksjonene.

Eksempel:

20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295
otp_method
string

Velger hvilken tofaktorleveringskanal som skal brukes når API-et returnerte feilkode 2017 eller 20171 (flere OTP-metoder). Kall på nytt med samme økt-ID som i det svaret og sett otp_method til den eksakte strengen i otp_method-feltet til ett objekt i statistics.otpMethods — ikke matriseindeksen. Utelat ved første legitimasjonsforespørsel; send etter brukerens valg. Eksemplet under er illustrativt; kopier alltid 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 transaksjonstyper

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Spør etter tokens knyttet til en api_key

Bruk denne metoden for å hente tokens knyttet til en spesifikk api_key. Resultatene er paginert: limit angir antall tokens per side (maks 500), og page velger hvilken side som returneres. api_key, method og limit er obligatoriske; hvis en av dem mangler eller er ugyldig, svarer API-et med HTTP 400 og feilkode 2.

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

api_key for å identifisere klienten i tjenesten

method
required
string
Value: "get"

Operasjonen som skal utføres. Den eneste støttede verdien er get.

Eksempel: get

limit
required
integer [ 1 .. 500 ]

Antall tokens per side. Minimum 1, maksimum 500.

Eksempel: 100

page
integer >= 1
Default: 1

Angi sidenummeret du vil hente. Hver side inneholder opptil limit tokens. Hvis ikke angitt, er standardverdien 1.

Eksempel: 1

code
string

Enhetskode som brukes til å filtrere tokens. Hvis den utelates, returneres tokens for alle enheter.

Eksempel: bbva

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

Felt som resultatene sorteres etter: created_at (opprettelsesdato) eller accesed_at (siste tilgangsdato). Standard created_at.

Eksempel: created_at

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

Sorteringsrekkefølge: ASC (stigende) eller DESC (synkende). 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": {
    }
}

Tilbakekall et token

Denne metoden tillater tilbakekalling av et eksisterende token for å deautorisere fremtidige API-tilgangsforespørsler.

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

Identifiserer klienten i tjenesten

token
string

Token som skal tilbakekalles.

Responses

Response samples

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

Tilordne et token til en annen api_key

Denne metoden tillater tilordning av et token fra én api_key til en annen. Begge api_keys må være aktive og tilhøre samme selskap, og tokenet må tilhøre api_key_source.

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

api_key som tokenet skal omtilordnes fra.

api_key_target
string

api_key som tokenet skal omtilordnes til.

token
string

Token som skal omtilordnes.

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

Legg til et nytt domene

Legger til tilknytningen mellom domenet som vil være vert for widgeten og mål-webhooken. For å redigere eller teste domenene dine, bruk 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"

Kontrollerer om widgeten starter en tokeniseringsprosess:

  • 1 - Brukeren autentiserer seg hos finansinstitusjonen (innlogging, samtykke, 2FA om nødvendig) og et gjenbrukbart token returneres
  • 0 - Ingen tokenisering utføres. Den tidligere innhentede tokenverdien må inkluderes i forespørselen

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 feilkoder

Liste over feilkoder. Vær spesielt oppmerksom på at ikke alle feilkoder skal behandles likt av applikasjonen din. For en feil med feil passord, bør du ikke prøve kallet på nytt med de samme parameterne, men for en feil som indikerer at enheten er under vedlikehold, kan du prøve igjen. Be om en teknisk sesjon med teamet vårt for å løse eventuelle spørsmål om feilhå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 endepunkter som ikke er nødvendige for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader.

Henter listen over støttede enheter

Henter listen over støttede enheter og informasjonen som trengs for å tegne påloggingskjemaet for enheten.

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 bruker

Dette endepunktet er valgfritt og ikke nødvendig for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader. Dette endepunktet tillater registrering av en bruker enten på porteføljeoverføringsplattformen Easytransfer eller på rapporteringsverktøyet Acumulas, basert 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"
}

Sjekk brukerregistreringsstatus

Dette endepunktet er valgfritt og ikke nødvendig for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader. Sjekker om en bruker er registrert i Easytransfer- eller Acumulas-systemet og returnerer den unike tilgangslinken for brukeren.

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

Tilbakekall en tidligere registrert bruker

Dette endepunktet er valgfritt og ikke nødvendig for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader. Dette endepunktet tillater avregistrering av en bruker fra Easytransfer- eller Acumulas-plattformtjenesten.

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-tilkoblingslasting

Dette endepunktet er valgfritt og ikke nødvendig for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader. Viktig: For å bruke batchprosesshåndtering på Wealthreader-siden, kreves et dedikert miljø. Dette endepunktet er ikke tilgjengelig på api.wealthreader.com. Endpoint-ene gruppert under "batch"-taggen tillater asynkron behandling av flere bankforbindelser, i motsetning til den synkrone /entities/-metoden. Ideell for behandling av store volumer av forbindelser og unngå 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-tilkoblinger

Dette endepunktet er valgfritt. Henter generelle statistikker om behandlingsresultatet for alle tilkoblinger 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 av en spesifikk tilkobling innenfor en batch

Dette endepunktet er valgfritt. Henter resultatet av en spesifikk tilkobling 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

Verifisering av kontohaver: kontroller om et IBAN tilhører en kontohaver, via SEPA-verifisering av betalingsmottaker (VoP) hos banken som er knyttet til lisensen din. Trinnvis veiledning: MyBankMatch.

Verifiserer at et IBAN tilhører en kontohaver (MyBankMatch)

Kontrollerer om et IBAN tilhører den oppgitte kontohaveren, via SEPA-verifisering av betalingsmottaker (VoP) hos din egen bank, som er knyttet til WealthReader-lisensen din. Returnerer bankens avgjørelse: den erstattes ikke av en lokal beregning av navnelikhet, og det opprettes, autoriseres eller utføres ingen betalingsordre.

Før det første kallet

  1. Ha en aktiv lisens med produktet MY_BANK_MATCH og ledig kvote.
  2. Åpne Kunder · MyBankMatch, klikk på Koble til bank, og fullfør autentiseringen i WealthReaders hostede vindu. Den tokeniserte tilkoblingen knyttes til din api_key; banktokenet utleveres ikke til nettleseren og er ikke en parameter i forespørselen.

Forespørsel: body kodet som skjema (application/x-www-form-urlencoded) med api_key, iban og name, på samme måte som for /entities/. Det sendes ikke JSON, og headeren X-API-Key brukes ikke. Oppbevar api_key i backenden din.

Svar: HTTP 200 angir at det er hentet et resultat fra produktet, ikke at navnet samsvarer. Kontroller success og deretter payload.result:

payload.result Betydning Tilleggsfelter Fakturerbar
MATCH Banken anser at navnet samsvarer med kontohaveren. Ingen. Ja, 0,10 EUR.
PARTIAL_MATCH Banken returnerer et delvis samsvar (CLOSE_MATCH). suggested_name. Ja, 0,10 EUR.
NO_MATCH Banken angir at navnet ikke samsvarer. Ingen. Ja, 0,10 EUR.
NOT_CONFIGURED Lisensen har ennå ingen tilknyttet bank. setup_url. Nei.
REAUTH_REQUIRED Tilkoblingen til banken krever ny autentisering. setup_url, reason_code. Nei.
NOT_POSSIBLE Det var ikke mulig å få en brukbar avgjørelse. Tilsvarer ikke NO_MATCH. reason. Nei.

Bare MATCH, PARTIAL_MATCH og NO_MATCH forbruker kvote. Inndatafeil og ikke-entydige resultater faktureres ikke.

Det finnes ingen idempotensnøkkel og ikke noe gratis nytt forsøk. Hvis du mister svaret (tidsavbrudd, nettverk eller en body som ikke kan tolkes), kan resultatet og det tilhørende kvoteforbruket være ukjent for applikasjonen din. Ikke send den samme forespørselen automatisk på nytt: gå gjennom historikken under Kunder, og kontakt support med angivelse av statistics.SESSION.

Fullstendig veiledning: MyBankMatch.

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

Nøkkel på 8 heksadesimale tegn fra en aktiv lisens med produktet MY_BANK_MATCH og ledig kvote. Oppbevar den i backenden din.

iban
required
string

IBAN fra et SEPA-land. Mellomrom fjernes, verdien konverteres til store bokstaver, og lengden for landet samt kontrollsifrene mod-97 valideres.

Eksempel: ES9321005707250200257112

name
required
string <= 140 characters

Kontohaverens navn. Ikke tomt, gyldig UTF-8, uten kontrolltegn og opptil 140 tegn. Trimmes, og interne mellomrom slås sammen.

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, igangsatt fra betalerens bank. Det finnes to måter å integrere dem på:

  • Fast Track: ett enkelt POST /payments/?action=fast-track returnerer betalings-URL-en, og Wealth Reader varsler din notification_url med OK eller KO. Se Fast Track-betalinger.
  • Widget: backenden din oppretter en uforanderlig betalingsintensjon med POST /payments/?action=create, åpner widgeten med det returnerte tokenet og bekrefter resultatet med POST /payments/?action=status. Se Introduksjon til betalinger og Statuser, polling og avstemming.

Felles regler for alle kall til /payments/?action=...

  • Metoden POST med headeren Content-Type: application/json og et JSON-objekt som body (maks. 32768 byte).
  • Autentisering kun med headeren X-API-Key (wr_live_ etterfulgt av 72 bokstaver eller sifre) fra en aktiv lisens med produktet PAYMENTS. Den sendes aldri i body. Hvert autentiserte kall teller mot lisensens kallgrense.
  • Body er en hviteliste: et manglende obligatorisk felt eller et uventet felt gir 422 invalid_request.
  • Den eneste positive finansielle bekreftelsen er payment_status: settled. En widgethendelse, en SCA-retur eller interaction_status: completed betyr aldri at betalingen er gjort opp.

Feilformat: application/json (ikke problem+json) med en stabil error.code; error.message er veiledende og kan endres.

{"success": false, "error": {"code": "invalid_request", "message": "The request body has an invalid schema."}}
HTTP error.code Årsak
400 invalid_json Tom eller ugyldig body, eller ikke et JSON-objekt.
401 invalid_api_key X-API-Key mangler, er feil formatert, ukjent eller inaktiv.
403 payments_not_allowed Lisensen har ikke produktet PAYMENTS.
404 action_not_found Ukjent action.
405 method_not_allowed Annen metode enn POST.
413 request_too_large Body på mer enn 32768 byte.
415 json_required Annen Content-Type enn application/json.
422 invalid_request Manglende eller uventede felter.
429 api_limit_reached Lisensens kallgrense er nådd.
500 internal_error Uventet feil.
503 payments_disabled, payments_accept_new_disabled, payment_storage_unavailable, payment_state_unavailable Tjenesten er midlertidig utilgjengelig, eller nye betalinger er satt på pause.

Varsel 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 finner den i en endelig status. reconciliation_required er ikke endelig og varsles ikke: bekreft den med status.

  • outcome er bare ok hvis banken har gjort opp betalingen (settled); rejected, cancelled, expired og failed varsles som ko.
  • Statusen kontrolleres mens betaleren fortsatt er på betalingssiden (som spør etter den til det endelige resultatet foreligger eller til betalingsøkten utløper), og hver gang du kaller status. Det finnes ingen separat planlagt sending: hvis betaleren forlater siden før banken har kommet til en konklusjon, eller serveren din ikke svarer 2xx, sendes varselet ved neste kontroll. Hvis det ikke har kommet noen minutter etter at du omdirigerte betaleren, kaller du status med payment_intent_id; det kallet utløser også det ventende varselet.
  • Svar med en hvilken som helst 2xx for å regne det som levert. Wealth Reader følger ikke omdirigeringer og venter maksimalt 3 sekunder.
  • Det samme varselet kan komme mer enn én gang: behandle customer_reference pluss outcome som idempotente.
  • Forespørselen er ikke signert. Før du leverer en verdifull vare, bekrefter du resultatet med status ved hjelp av din X-API-Key og payment_intent_id fra varselet.
header Parameters
User-Agent
required
string
Value: "WealthReader-Payments"
Request Body schema: application/json
required
outcome
required
string
Enum: "ok" "ko"

ok bare for settled.

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

Endelig finansielt resultat.

customer_reference
required
string

Idempotency-Key som du sendte da du opprettet betalingen.

payment_intent_id
required
string <uuid>

Identifikator som fast-track returnerte. Bruk den til å bekrefte 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"
}

Oppretter en betaling og henter URL-en (Fast Track)

Ett enkelt kall som returnerer betalings-URL-en. Betaleren åpner den og autoriserer betalingen i banken sin; når betalingen når en endelig status, varsler Wealth Reader din notification_url med OK eller KO (se webhooken notification_url). I bakgrunnen opprettes den samme uforanderlige intensjonen som med create: beløp, mottaker og tekst er fastsatt før de når nettleseren.

Headeren Idempotency-Key er også din forretningsreferanse (customer_reference i varselet): den sendes ikke i body. Hvis du gjentar den samme nøkkelen med den samme body, mottar du den samme URL-en; hvis du gjenbruker den med andre data (også med en annen logo), er svaret 409 idempotency_conflict.

En straksoverføring har ingen egen grense i dette API-et: banken avviser overføringen den ikke kan godta, også på grunn av beløpet, og avvisningen kommer som KO.

header Parameters
X-API-Key
required
string

API-nøkkel fra en lisens med produktet PAYMENTS. Oppbevar den i backenden din.

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

Fra 16 til 128 tegn; må begynne med en bokstav eller et siffer og kan bare inneholde bokstaver, sifre og . _ : -. En UUID v4 er gyldig. Dette er også forretningsreferansen som returneres i varselet.

Request Body schema: application/json
required
amount
required
string

Beløp i hovedenheter som JSON-streng. "15.50" er 15,50 EUR; et heltall uten desimaler ("15") godtas også. Maksimalt to desimaler, så "15.5" og "15.50" er det samme beløpet. Minimum 0.01. Maksimum er begrenset av grensen som hver kunde har konfigurert i banken sin.

Eksempel: 15.50

currency
required
string
Value: "EUR"

ISO 4217-valuta. I denne versjonen bare EUR.

Eksempel: EUR

required
object (payments-beneficiary)

Mottaker av overføringen. Kan ikke endres etter at betalingen er opprettet.

reference
required
string [ 1 .. 140 ] characters

Tekst på kontoutskriften, opptil 140 tegn.

Eksempel: Pedido 78901

priority
required
string
Enum: "normal" "instant"

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

Eksempel: normal

notification_url
required
string <= 2000 characters

Offentlig https-URL som mottar varselet om OK eller KO. Uten påloggingsopplysninger, port 443 hvis den oppgis, og uten private, lokale eller metadata-adresser.

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

logo
string <= 2048 characters

Valgfri. Offentlig https-URL til logoen til virksomheten din i SVG (stien må slutte på .svg; spørreparametere er tillatt), uten påloggingsopplysninger, fragment eller private adresser, opptil 2048 ASCII-tegn. Betalingssiden viser den over sammendraget; Wealth Reader laster den ikke ned, den lastes av betalerens nettleser. Enhver annen verdi gir 422 invalid_logo.

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

Responses

Request samples

Content type
application/json
{}

Response samples

Oppretter en betalingsintensjon (widget)

Oppretter en uforanderlig betalingsintensjon og returnerer et kortlivet token for å åpne widgeten i betalerens nettleser. Beløp, mottaker og tekst fastsettes i backenden og kan ikke endres fra nettleseren. Når widgeten er lukket, bekrefter du resultatet fra backenden din med status.

Det finnes to varianter av body:

  • Standard: du fastsetter amount_minor, currency, beneficiary, reference, customer_reference og allowed_origin.
  • Administrert profil (for eksempel cruz_roja_demo): Wealth Reader fastsetter mottaker, tekst og grenser; du sender profile, institution_code, amount_minor, customer_reference og allowed_origin. Hent bankene med profile-institutions.

Hvis du gjentar den samme Idempotency-Key med den samme body, mottar du den samme intensjonen (200, idempotent_replay: true); hvis du gjenbruker den med andre data, er svaret 409 idempotency_conflict. Nøkkelen er spesifikk for virksomheten din.

Veiledning: Intensjoner og idempotens og Integrasjon med widgeten.

header Parameters
X-API-Key
required
string

API-nøkkel fra en lisens med produktet PAYMENTS. Oppbevar den i backenden din.

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

Fra 16 til 128 synlige ASCII-tegn. Generer én per betaling (en UUID v4 er gyldig), og gjenbruk den hvis du prøver kallet på nytt.

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

Beløp i mindre enheter (cent) som JSON-heltall. 1500 er 15,00 EUR. Maksimum er begrenset av grensen som hver kunde har konfigurert i banken sin.

Eksempel: 1500

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

Mottaker av overføringen. Kan ikke endres etter at betalingen er opprettet.

reference
required
string [ 1 .. 140 ] characters

Tekst på kontoutskriften, opptil 140 tegn.

Eksempel: Pedido 78901

customer_reference
required
string <= 128 characters

Din interne referanse for betalingen. Fra 1 til 128 tegn; begynner med en bokstav eller et siffer og inneholder bare bokstaver, sifre og . _ : -.

Eksempel: order-78901

allowed_origin
required
string

Opprinnelse (https://host[:puerto], uten sti, spørring eller fragment) for siden som åpner widgeten. Widgeten fungerer bare fra den opprinnelsen.

Eksempel: https://tienda.example.com

locale
string
Value: "es"

Valgfri. Widgetens språk; i denne versjonen bare es.

expected_mode
string
Enum: "mock" "live"

Valgfri. Hvis den ikke samsvarer med miljøet, svarer kallet 409 payment_mode_mismatch i stedet for å opprette betalingen.

allowed_institution_codes
Array of strings <= 2500 items

Valgfri. Ikke-tom liste over unike bankkoder (se /payments/entities/) som betaleren kan velge mellom.

Eksempel:

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

Valgfri. Offentlig https-URL til logoen din i SVG (sti som slutter på .svg), uten påloggingsopplysninger, fragment eller private adresser, opptil 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": {
    }
}

Spør etter statusen til en betaling

Server-til-server-forespørsel om statusen til en betaling, inntil det foreligger en bankmessig konklusjon. Et callback, en SCA-retur eller lukking av widgeten er ikke en finansiell bekreftelse: det er bare payment_status: settled.

Wealth Reader begrenser de eksterne forespørslene per intensjon; bruk også backoff i backenden din, og ikke opprett en ny intensjon så lenge resultatet er tvetydig.

Tvetydig resultat: et nettverksbrudd, et tidsavbrudd eller et ukjent svar etter at igangsettingen er sendt, endrer intensjonen til reconciliation_required med payment_status: unknown, og svaret inneholder reconciliation. Igangsettingen gjentas aldri automatisk. Behold identifikatoren og idempotensnøkkelen, ikke opprett en ny intensjon og ikke autoriser på nytt, og når automatic_recovery er false, skal du slutte å polle og eskalere til support med reconciliation.reference.

For Fast Track-betalinger sender denne forespørselen også det ventende OK/KO-varselet til notification_url når betalingen har nådd en endelig status.

Veiledning: Statuser, polling og avstemming.

header Parameters
X-API-Key
required
string

API-nøkkel fra lisensen som opprettet betalingen.

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

payment.id returnert av create (for Fast Track den payment_intent_id som fast-track returnerer).

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

refresh
boolean
Default: true

Valgfri. true spør banken om siste status når det er relevant; false returnerer den lagrede statusen.

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 bankene og betingelsene for en administrert profil

Returnerer betingelsene for en administrert profil som er aktivert for virksomheten din (mottaker, tekst, beløpsgrenser), og bankene som betaleren kan velge. Bruk den valgte code som institution_code i create.

header Parameters
X-API-Key
required
string

API-nøkkel fra en lisens med produktet PAYMENTS.

Request Body schema: application/json
required
profile
required
string

Kode for den administrerte profilen.

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 bankene som er tilgjengelige for betalinger

Katalog over banker som kan igangsette betalinger, med logo og betalingsmetodene de støtter. X-API-Key er valgfri; hvis du sender den, valideres den og teller som et kall. Støtter også POST med de samme filtrene i en JSON-body, og POST /payments/?action=entities med obligatorisk X-API-Key.

Ukjente filtre ignoreres og gir aldri en valideringsfeil.

query Parameters
country
string
Example: country=ES

Landkode etter ISO 3166-1 alfa-2. ALL eller tom betyr ingen filtrering.

Eksempel: ES

search
string

Tekst som finnes i navnet eller koden, uten skille mellom store og små bokstaver (alias q).

code
string
Example: code=santander-es

Bankens nøyaktige kode, uten skille mellom store og små bokstaver.

Eksempel: santander-es

payment_method
string
Enum: "sepa_credit_transfer" "instant_sepa_credit_transfer"

Bare bankene som støtter denne betalingsmetoden.

limit
integer [ 1 .. 2000 ]

Sidestørrelse (fra 1 til 2000).

offset
integer >= 0

Antall resultater som hoppes over.

header Parameters
X-API-Key
string

Valgfri. Hvis den sendes, valideres den og teller som et kall.

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