API docs by Redocly

Wealth Reader (8.1.9)

Download OpenAPI specification:

E-mail: info@wealthreader.com

PSD2-pohjaiset sääntely-API:t tarjoavat pääsyn tiettyihin taloudellisiin tietoihin, kuten pankkitilisaldoihin ja tapahtumiin. On kuitenkin olemassa muita varallisuustietojen lähteitä, jotka eivät ole saatavilla näiden API:iden kautta. Wealth Reader API laajentaa sääntely-API:iden tarjoamia tietoja tarjoamalla reaaliaikaisen pääsyn lisävarallisuuslähteisiin missä tahansa maailmanlaajuisessa yksikössä. On olemassa kaksi muuta liittyvää asiakirjaa, jotka auttavat sinua integroimaan Wealth Reader API:n. Toinen on Javascript-widgetin integraatio-opas: https://docs-en.wealthreader.com/ ja toinen on Postman-kokoelma, joka perustuu tähän dokumentaatioon. Erittäin tärkeää: Tämä API-määrittely on mukautettu asiakkaille, jotka integroivat Widgetin kautta, joten jotkin parametrit, joita ei tarvita tällaisessa integraatiossa, on jätetty pois, kuten pankkitunnistautumisen parametrit, koska tokenia käytetään.

Core

Ydin-API vaaditaan vakiointegraatioihin

Hakee taloudelliset varat ja niiden koostumustiedot

Hakee taloudelliset varat ja niiden koostumustiedot mukaan lukien sijoitussalkut koostuen osakkeista tai rahastoista, luottokortit, vakuutukset ja lainat. Sisältää omistustiedot jokaiselle varalle sekä yksilölliset tunnisteet, jotka helpottavat tietojen käsittelyä. On mahdollista saada Mock-tietoja. Tarkista tekniseltä tiimiltä miten tämä tehdään.

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

Tunnistaa asiakkaan palvelussa

code
string

Yksikön nimi. Täydellinen luettelo on saatavilla GET-pyynnöllä

Esimerkki: caixabank

token
string

Tunnistaa säilytetyt tunnistetiedot. Kulku, jolla token on saatu, on kuvattu dokumentissa 'Widgetin integraatio-opas'. Seuraavat Mock-käyttäjät ovat saatavilla: MOCKDATA, OK-vastaus; MOCKOTP, vastaus OTP-haasteella; MOCKLOGINKO, vastaus kirjautumisvirheellä

Esimerkki: MOCKDATA

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

Luettelo tuotetyypeistä, joista tiedot haetaan. Hyväksyy useita pilkuilla erotettuja arvoja.

Esimerkki: accounts,portfolios

only_balances
boolean
Default: false

Ilmoittaa, haetaanko vain tuotteiden saldot kaiken saatavilla olevan tiedon sijaan. Oletusarvo: false.

Esimerkki: false

fetch_transaction_details
boolean
Default: false

Ilmoittaa, haetaanko laajennetut tapahtumatiedot, kun entiteetin liitin tukee sitä. TÄRKEÄÄ: Sen käyttöönotto tarkoittaa yhden tai useamman lisänavigoinnin suorittamista tapahtumaa kohden palautettujen tietojen rikastamiseksi. Tämä lisää väistämättä ja merkittävästi suoritusaikaa. Lisänavigointien määrä kasvaa tapahtumien määrän mukana. On suositeltavaa ottaa se käyttöön vain, kun on varmaa, että tarvitaan oletuksena palautettua suurempaa yksityiskohtaisuutta. Haetut tiedot lisätään additional_info-avaimeen kunkin tapahtuman tasolla. Tämän parametrin käyttö edellyttää erillistä ympäristöä.

Esimerkki: false

date_from
string <date>

Päivämäärä, josta lähtien tapahtumia pyydetään, muodossa VVVV-KK-PP. Täytyy olla päivämäärä ennen tätä päivää.

Esimerkki: 2024-01-01

date_to
string <date>

Tämä koskee vain tulevien päivämäärien rajoittamista tuotteille loan ja confirming, muodossa VVVV-KK-PP. Päivämäärän on oltava tämän päivän jälkeen

Esimerkki: 2025-12-31

required_products_schema
string

Vaadittu tuoteskeema. Ilmoittaa tilit tai kortit, joista tietoja halutaan, lisäkonfiguraatioiden kanssa.

Esimerkki: 

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

Hyväksyy tapahtuma-uuid:t pilkuilla erotettuna. Parametri, joka otetaan huomioon vain jos product_types on ALL tai sisältää accounts. Lisää kunkin pyydetyn pankkitapahtuman liittyvän PDF-dokumentin.

Esimerkki: 

20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295
otp_method
string

Valitsee kaksivaiheisen toimituskanavan, kun API palautti virhekoodin 2017 tai 20171 (useita OTP-tapoja). Kutsu uudelleen samalla istuntotunnisteella kuin tuossa vastauksessa ja aseta otp_method tarkaksi otp_method-kentän merkkijonoksi yhdestä statistics.otpMethods-objektista — ei taulukon indeksiä. Jätä pois ensimmäisestä tunnistepyynnöstä; lähetä käyttäjän valinnan jälkeen. Alla oleva esimerkki on ohjeellinen; kopioi aina merkkijono statistics.otpMethods-kentästä.

Esimerkki: 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
[
  • {
    }
]

Tapahtumatyyppien luettelo

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Kysy api_key-tunnisteeseen liittyviä tokeneita

Käytä tätä menetelmää tiettyyn api_key-tunnisteeseen liittyvien tokenien kyselyyn. Tulokset sivutetaan: limit määrittää tokenien määrän sivua kohden (enintään 500) ja page valitsee palautettavan sivun. api_key, method ja limit ovat pakollisia; jos jokin niistä puuttuu tai on virheellinen, API vastaa HTTP 400 -tilalla ja virhekoodilla 2.

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

api_key asiakkaan tunnistamiseksi palvelussa

method
required
string
Value: "get"

Suoritettava toiminto. Ainoa tuettu arvo on get.

Esimerkki: get

limit
required
integer [ 1 .. 500 ]

Tokenien määrä sivua kohden. Vähintään 1, enintään 500.

Esimerkki: 100

page
integer >= 1
Default: 1

Määritä sivunumero, jonka haluat hakea. Jokainen sivu sisältää enintään limit tokenia. Jos ei ole annettu, oletusarvo on 1.

Esimerkki: 1

code
string

Yksikkökoodi, jolla tokenit suodatetaan. Jos se jätetään pois, palautetaan kaikkien yksiköiden tokenit.

Esimerkki: bbva

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

Kenttä, jonka mukaan tulokset lajitellaan: created_at (luomispäivämäärä) tai accesed_at (viimeinen käyttöpäivämäärä). Oletus created_at.

Esimerkki: created_at

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

Lajittelujärjestys: ASC (nouseva) tai DESC (laskeva). Oletus DESC.

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

Peruuta token

Tämä menetelmä mahdollistaa olemassa olevan tokenin peruuttamisen tulevien API-käyttöpyyntöjen estämiseksi.

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

Tunnistaa asiakkaan palvelussa

token
string

Token, joka peruutetaan.

Responses

Response samples

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

Määritä token uudelleen eri api_key-tunnisteelle

Tämä menetelmä mahdollistaa tokenin uudelleenmäärityksen yhdestä api_key-tunnisteesta toiseen.

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

api_key, josta token määritetään uudelleen.

api_key_target
string

api_key, johon token määritetään uudelleen.

token
string

Token, joka määritetään uudelleen.

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

Lisää uusi verkkotunnus

Lisää yhteyden widgetin isännöivän verkkotunnuksen ja kohde-webhookin välille. Verkkotunnusten muokkaamiseen tai testaamiseen käytä https://www.wealthreader.com/clients/

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

Method to execute.

Esimerkki: add

api_key
required
string

User's API key.

domain
required
string

Domain to add.

Esimerkki: http://desarrollo.cliente.es

url_callback
required
string

URL for callback.

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

tokenize
required
string
Enum: "1" "0"

Määrittää aloittaako widget tokenisointiprosessin:

  • 1 - Käyttäjä tunnistautuu rahoituslaitokseen (kirjautuminen, suostumus, 2FA tarvittaessa) ja uudelleenkäytettävä token palautetaan
  • 0 - Tokenisointia ei suoriteta. Aiemmin saadun tokenin arvo on sisällytettävä pyyntöön

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

Virhekoodiluettelo

Virhekoodiluettelo. Kiinnitä erityistä huomiota siihen, että kaikkia virhekoodeja ei pitäisi käsitellä samalla tavalla sovelluksessasi. Väärän salasanan virheen kohdalla sinun ei pitäisi yrittää kutsua uudelleen samoilla parametreilla, mutta virheen kohdalla, joka osoittaa että entiteetti on huollossa, voit yrittää uudelleen. Pyydä teknistä istuntoa tiimimme kanssa ratkaistaksesi kaikki kysymykset virheenhallinnasta.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Varoituskoodiluettelo

Varoituskoodiluettelo.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Valinnaiset päätepisteet, joita ei vaadita vakiointegraatioihin. Käytä vain, jos Wealth Reader nimenomaisesti ohjeistaa.

Hakee tuettujen yksiköiden luettelon

Hakee tuettujen yksiköiden luettelon ja tiedot, jotka tarvitaan yksikön kirjautumislomakkeen piirtämiseen.

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
[
  • {
    }
]

Vahvista pankkitilin omistajuus IBAN:in kautta

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Mahdollistaa sen tarkistamisen, onko luonnollinen tai oikeushenkilö tietyn pankkitilin haltija käyttäen IBAN:ia ja väitetyn haltijan tunnistetietoja. Edellyttää api_key:tä, jolla on IBAN_OWNERSHIP-tuote sallittuna. Ensimmäinen pyyntö lähetetään parametreilla api_key, iban, document_type, document_number ja holder_name. Jos tulos palauttaa tilan PENDING, vahvistus voidaan kysyä uudelleen lähettämällä vain api_key ja session. NO_RESPONSE on lopullinen virhetulos: uudelleenyritystä varten on aloitettava uusi vahvistus ilman session-parametria.

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

Identifies the client in the service. It must have the IBAN_OWNERSHIP product authorized.

iban
required
string

IBAN code of the bank account to verify (without spaces)

Esimerkki: ES4914651234561234567890

document_type
required
string
Enum: "NIF" "NIE" "Pasaporte" "CIF"

Type of identification document

Esimerkki: NIF

document_number
required
string

Identification document number

Esimerkki: 12345678Z

holder_name
required
string

Full name of the natural person or company name

Esimerkki: LUIS GARCIA BAQUERO

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
api_key=a1b2c3d4e5f6g7h8i9j0&iban=ES4914651234561234567890&document_type=NIF&document_number=12345678Z&holder_name=LUIS%20GARCIA%20BAQUERO

Response samples

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

Rekisteröi uusi käyttäjä

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tämä päätepiste mahdollistaa käyttäjän rekisteröinnin joko portfolion siirtoalustalle Easytransfer tai raportointityökalulle Acumulas, perustuen yksilölliseen tunnisteeseen.

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.

Esimerkki: 12345678A

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

Service associated with the user. Determines the data flow.

Esimerkki: easy-transfer

email
required
string <email>

User email, used according to service type.

Esimerkki: sai_banker@singularbank.com

Responses

Response samples

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

Tarkista käyttäjän rekisteröintitila

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tarkistaa, onko käyttäjä rekisteröity Easytransfer- tai Acumulas-järjestelmään ja palauttaa käyttäjän yksilöllisen pääsylinkin.

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

Authentication key

user_id
required
string

User identification document.

Esimerkki: 12345678A

Responses

Response samples

Content type
application/json
{}

Peruuta aiemmin rekisteröity käyttäjä

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tämä päätepiste mahdollistaa käyttäjän poistamisen Easytransfer- tai Acumulas-alustapalvelusta.

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.

Esimerkki: 12345678A

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

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

Esimerkki: easy-transfer

Responses

Response samples

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

Batch-yhteyksien lataus

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tärkeää: Wealthreader-puolen eräprosessien hallinnan käyttämiseen vaaditaan omistettu ympäristö. Tämä päätepiste ei ole käytettävissä osoitteessa api.wealthreader.com. "batch"-tagin alla ryhmitellyt päätepisteet mahdollistavat useiden pankkiyhteyksien asynkronisen käsittelyn, toisin kuin synkroninen /entities/-menetelmä. Ihanteellinen suurten yhteysvolyymien käsittelyyn ja aikakatkaisujen välttämiseen.

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.

Esimerkki: 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",
  • "notification_url": "https://example.com/webhook/batch-complete",
  • "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"
}

Hae yleisiä tilastoja batch-yhteyksistä

Tämä päätepiste on valinnainen. Hakee yleisiä tilastoja kaikkien batch-yhteyksien käsittelytuloksesta.

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

Hae tietyn yhteyden yksittäinen tulos batchin sisällä

Tämä päätepiste on valinnainen. Hakee tietyn yhteyden tuloksen batchista.

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

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.

Esimerkki: 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.

Esimerkki: 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.

Esimerkki: a1b2c3d4

enrollment_id
required
string
Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Identifier returned by POST /cards/enrollments/.

Esimerkki: 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.

Esimerkki: a1b2c3d4

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

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

Esimerkki: 2026-07-01

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

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

Esimerkki: 2026-07-11

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

Filters by the email of the employee.

Esimerkki: empleado@cliente.com

since_id
integer
Example: since_id=216

Exclusive cursor on the transaction id, for pagination.

Esimerkki: 216

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

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

Esimerkki: 500

Responses

Response samples

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